Websocket device

[glassTransition]

I'm attempting to implement a DIY thermocouple device (that I will document and share) with a raspberry pi zero W and would appreciate it if someone can share more details about the Websockets device interface. Specifically, captured messages would be very useful. The documentation outlines the general form but it would help to see actual traffic.

[glassTransition]

I just installed the latest version (2.4.6) and Websockets are gone as a device type?

[MAKOMO]

WebSocket support has not been touched in v2.4.6 and is still there. Documentation is here: https://artisan-scope.org/devices/websockets/ and the details of messages can be configured under menu Config >> Ports, last tab "Web Sockets".

[glassTransition]

I was looking for the Websocket setup under the device rather than the port. Thank you for the clarification.

I have configured like the Documentation shows with the beanTemp and ambientTemp on inputs 1 and 2. How are those bound to BT and ET?

If I click the "on" button in Artisan, it connects to my server, but I don't see any requests for temperatures. Are those supposed to be pushed to Artisan?

[MAKOMO]

Why not attach your configuration, best as Artisan settings .aset file (renamed to extension .txt)? Hard to help at this level. The WebSocket support in Artisan follows a request-response pattern and was introduced to support the Probat Series III machines. Maybe it is worse to look at the corresponding setup.

[glassTransition]

Thank you for your help with this.

Based on your comments I selected the Probat sample roaster as the machine type. I am actually planning to add my websocket temperature sensors to a Behmor 1600 which is of course not a choice in the machines list.

The aset file in the machines folder did not update though. Is that the file useful to see then? Is there another file with my settings?

I am temporarily replacing my server with a node-red flow so I can see all details of the traffic.

[MAKOMO]

Thank you for your help with this.

Based on your comments I selected the Probat sample roaster as the machine type. I am actually planning to add my websocket temperature sensors to a Behmor 1600 which is of course not a choice in the machines list.

The aset file in the machines folder did not update though. Is that the file useful to see then? Is there another file with my settings?

I am temporarily replacing my server with a node-red flow so I can see all details of the traffic.

You can save your setting into an artisan-settings.aset file via menu Help >> Save Settings. To attach it here you need to rename the file such that it has a .txt extension.

[glassTransition]

Thank you.

Here is my settings file:
artisan-settings.txt

[MAKOMO]

Looks good to me. Does it work?

[glassTransition]

I'm making progress. This is a new area for me so I am learning as I debug. So far I'm getting:

[WS] Connection was opened.
[WS] Incoming message: {"command": "getCurrentRoastingStep", "id": 40922, "roasterID": 0}
[WS] Incoming message: {"command": "keepAlive", "id": 8371, "roasterID": 0}
[WS] Incoming message: {"command": "getCurrentRoastingStep", "id": 35474, "roasterID": 0}
[WS] Incoming message: {"command": "getCurrentRoastingStep", "id": 96767, "roasterID": 0}

Can I create a "custom machine" that only reports BT and ET so that I don't get these queries for functions that I don't have?

[MAKOMO]

Well, I don't know which functions you have. Maybe its time for you too check out the source code of Artisan for details. The kepAlive query is set in the Probat setup that you took as starting point. Just remove that in the Events tab (under Sampling) if you do not need that. Same for "getCurrentRoastingStep", which is set in the WebSocket tab under Commands.

[glassTransition]

Ok, thank you. I see the events that I don't need and can disable them. I don't see the ones that I do want though.

All I need are events to get the environmental temperature and bean temperature so that Artisan can plot them and calculate RoR and DT/ dt etc.

I could make up my own events, but I still don't know what to commands to use and how / where the data that my server returns is bound to the "special" variables ET and BT?

[glassTransition]

Looking at the source code, I would guess that temp1 is ET and temp2 is BT by default. So are those the variable names I should return with the temperature values in the JSON response string?

What command will Artisan send?

[glassTransition]

On the device assignment dialog when I select the ET / BT tab and the "Meter" radio button and "WebSocket" in the dialog, I have the "ET" and "BT" boxes checked for Curves. So are these the variable names in the JSON name-value pairs that I should return? What command should be sent by Artisan to request them? Do I have to create an event or message somehow through the Ports Configuration Websocket dialog?

[glassTransition]

I set the events as shown, however, I'm still getting the getCurrentRoastingStep command. I don't think I understand something.

[MAKOMO]

This goes beyond what I can support for free. Please book a support hour with me if you need my further advice on this: https://shop.artisan.plus/en/consulting/video-conference

[glassTransition]

This should be a basic question, but if you can't help I understand. Thank you for your help so far.

[glassTransition]

I have no commercial interest btw. I am just trying to expand your user base by making it easier to instrument hobbyist roasters.

[CarefreeBuzzBuzz]

Considering how many questions, doesn’t seem basic. You are freee to book consulting time. Michael Herbert CarefreeBuzzBuzz

…

On Sep 28, 2021, at 8:34 AM, glassTransition ***@***.***> wrote:  This should be a basic question, but if you can't help I understand. Thank you for your help so far. — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub, or unsubscribe.

[glassTransition]

It's really the same two questions that I've tried to ask multiple ways since I haven't gotten an answer.

1. What do I need to call the variables in the message response so that Artisan knows they are ET / BT?

2. What command asks for them?

[poundy]

It's really already documented for you though. I know nothing about websockets, but from the previously linked documentation page https://artisan-scope.org/devices/websockets/, you can see all the things you need.

1. You call them whatever you fill in via the NODE value on the dialog box shown in the page above.
2. The request comes from the Commands, Data Request value. Put whatever value there you need.

If you read the detail, GetCurrentRoastingStep is the command that is issued to retrieve data - you can change it as per point 2 above, so that it works for whatever you have called your function. If you find ET and BT are transposed, you can change them as per point 1.

hope this helps you cross the current valley to reach the next !

[poundy]

also there's detail in there saying how Artisan handles if you need to call a specific webrequest to get just the BT or just the ET (or just any value) by having the "request" field on an input object as non-blank. Perhaps that's what you're expecting, but as documented, it's more efficient to use a single request to retrieve all values whenever possible

[MAKOMO]

I extended the documentation by a simple example on how to harvest ET and BT via WebSockets: https://artisan-scope.org/devices/websockets/

[glassTransition]

Thank you Marko. That's what I needed.

My server works now. I have attached the python script I'm using for the server running on a raspberry pi zero w. I will add reading of actual thermocouples and update it in the future.

artisan_websocket_server.txt