help needed with WebSocketClient coding in a QA

[JcBorgs 52]

Anyone that can give some assistance with coding WebSockets in a QA??

 

Trying to build a really simple QA to collect data from my “Tibber Pulse”. The intention is to capture live energy consumption and put the code in a Energy Meter QA. In the Tibber iPhone app I get updated values every 10’s second from my Tibber Pulse and to get similar in a Fibaro HC3 QA would be ideal.

 

Have never worked with WebSockets in the past so have no clue to how to do this…. But as a general concept it looks doable, but my attempt so far have only failed.

 

General simple idea is to create a QA (Energy Meter type) with WebSocket code that listens to data from my “Tibber Pulse” and simply store the data received to the QA with self:updateProperty("value", TibberDataRecieved).

 

There are some information in regards to WebSockets on the Tibber development pages:

Please login or register to see this link.

Please login or register to see this link.

 

Subscriptions

GraphQL Subscriptions is the mechanism that is used for streaming data. It is basically a layer built on top of standard web sockets. A client starts a subscription by issuing a subscription query:

Please login or register to see this code.

The server will then push results conforming to this query over the socket that is kept open between client and server.

GraphQL Subscriptions Endpoint

Please login or register to see this code.

Subscribing to data

While queries and mutations are typically handled over HTTP some data are better suited to handled as streams over a persistent connection (web socket). Subscriptions follows the same semantics as queries and mutations - the shape of what is returned/sent from the server is determined by the client when invoking the api:

Please login or register to see this code.

Since subscriptions are handled over web sockets they can be a bit more challenging to handle from the client’s perspective. Many GraphQL client libraries provide good abstractions for this though. Note that the maximum number of open websockets is limited to two.

Streaming live data from Tibber Pulse

Python example to get live streaming data from your Tibber Pulse over GraphQl. This also works for any other type of smart energy meter supported by Tibber, such as Watty. Requires ‘Python GraphQL Client’ package: pip install python-graphql-client

Please login or register to see this code.

 

Tibber GraphiQL example from (

Please login or register to see this link.

)

Please login or register to see this code.

 

Edited April 23, 2022 by JcBorgs
Added more information

[jgab 2,051]

My advice would be to code it in Lua off-line on a PC/Mac so that you can debug, step through, the code and get an understanding what's going on.

(I'm myself amazed at people that can develop QAs on the HC3 with more than 50 lines of code ... it must be extremely frustrating...)

 

You could make your own emulated fibaro functions to make it similar to how it's coded on the HC3.

The trick is of course to get a web socket library that mimics the way it looks on the HC3.

My own HC3 emulator TQAE, has a websocket implementation that I believe is very similar to HC3 (I coded a web socket client for my Samsung TV and it worked when I moved it to the HC3)

You could try that if you want

 

 

[JcBorgs 52]

@jgab

 

We all have different challenges  and opinions, personally I think the HC3 environment works rather well to write code in, and also doing the majority of coding on a iPad..

 

With WebSocket I am facing a big hurdle as I never written/used anything like that previously. Have no plan to make it big or complicated QA and would think that a simple code with:

- WebSocket connect

- WebSocket initiate the data subscription

- WebSocket data received handle

Would be enough for this to just establish a connection and start receive data. Would perhaps even be less than 50 lines of code?

 

Could you perhaps share the Samsung TV websocket implementation you did so that I get view on how to actually work and implement a websocket function in the HC3_

 

[jgab 2,051]

Please login or register to see this code.

 

This is 100 lines of code. It's not the exact number of lines but being able to step through the code, set break-points, inspect return values on the fly. It's just the speed/productivity that gains an exponent...

[JcBorgs 52]

@jgab

 

Fully understand what you are pointing to with easier development process on a platform that are a bit more “developer” friendly compared to the HC3, it makes full sense to do larger development with the ability to do what you describe. Will most likely eventually move to a computer as both this Tibber Pulse QA and the Charge Amps QA I am working on are growing and becomes more complex. But for now a iPad Pro with physical keyboard works just fine.

 

Thank you very much for sharing the Samsung WebSocket QA code, gives at least an insight how to start with working with WebSocket!

[SmartHomeEddy 878]

Tried it before, didn't worked yet. There are too many issues to solve. How to handle the requestBody, headers and token. 

 

Please login or register to see this code.

 

 

[JcBorgs 52]

@SmartHomeEddy

 

Thank you very much, will try to pitch in and help or at least provide additional test data. But for sure it will be challenging and difficult to solve this.

[JcBorgs 52]

@SmartHomeEddy

 

Have looken into your code and as you said, it doesnt work. Have tried a couple of things but nothing really helps, it issues the connect command, the handleConnected is triggered so it seems to get some sort of connection initiated, but the imidiately triggers the handleDisconnect. For me it feels like the reason is that the Token isn’t included in the connect phase, but regardless of all the options I have tried nothing helps.

 

Agree that the challenging part is to handle requestBody, Header and token. The documentation when it comes to webSocketClient commands on Fibaro’s web page are not providing much help there….

 

@m.roszak You have insight on this? Trying to setup a WebSocketClient that requires “token” in the request but the documentation that you provide on the Fibaro page doesn’t show anything about how to implement this.

Edited April 27, 2022 by JcBorgs

[m.roszak 535]

We have prepared an option to add headers to websockets but it is not available yet, It will be from next version.
Thats why it is not in docs.

[JcBorgs 52]

1 hour ago, m.roszak said:

We have prepared an option to add headers to websockets but it is not available yet, It will be from next version.
Thats why it is not in docs.

@m.roszakSounds good! and when  will that be released?

[m.roszak 535]

Next beta version for HC3/HC3L/YH, no exact date yet

[JcBorgs 52]

45 minutes ago, m.roszak said:

Next beta version for HC3/HC3L/YH, no exact date yet

@SmartHomeEddy

This sound promising, right?

Sounds at least to me that it is this that is missing today to be able to get WebSocketClient working with the Tibber Pulse? Or do you see additional issues?

[SmartHomeEddy 878]

In the header the token can be included. There is also a requestBody where the query is handled. Hope the requestBody also gets a place in the WebSocket?

 

 

[JcBorgs 52]

2 minutes ago, SmartHomeEddy said:

In the header the token can be included. There is also a requestBody where the query is handled. Hope the requestBody also gets a place in the WebSocket?

 

 

@m.roszak You have any input on this? Will it also be included in the updates in the new beta?

[m.roszak 535]

I do not fully understood the question and I did consult this with developer, he is also not sure how to respond.

 

The headary is set up when creating a connection:
connect (url, headers)
on such a created connection you can send a message:
send (data)

while handling incoming messages we can do by registering a handler:
addEventListener ("dataReceived", function (data) ... end)

as in 

Please login or register to see this link.

Regards,
Michał 

[SmartHomeEddy 878]

These are the variables for Tibber live:

Please login or register to see this code.

 

So in the (future) connect (url,headers) the above "url" and "headers" are handled. Then probably the above "data" variable can be handled with sent(data). 

[JcBorgs 52]

On 4/28/2022 at 12:25 PM, m.roszak said:

Next beta version for HC3/HC3L/YH, no exact date yet

@m.roszakAny update on dates for the next Beta with the updated WebSocketClient features?

 

[JcBorgs 52]

@m.roszak So new beta is now out with Header support in the WebSocketClient …

 

Any documentation around how it is implemented and intended to be used?