Websocket Client

How to use the Websocket Client robot skill

A client to send and receive data to a WebSocket, assign the response to a variable, and execute scripts.




Use ControlCommand to open a connection to a remote host and send data. The received data will be assigned to a variable and the specified script will execute. Once a connection is established to the server using the ControlCommand Open, your program may now send messages to the server via the ControlCommand Send. Any messages received from the server are stored in a variable and the script is launched. 





Configuration Menu




1) The Response Variable will hold the text response message that is sent from the server.

2) Response Script will be executed for every response that is sent from the server. Within this script, the response message is available in the Response Variable. By default, an example script will speak the response data.

3) The Connection Status Variable holds a true or false bool regarding the status of the connection to the server.

4) Enable Debug will display the full response message in the log window. This will consume unnecessary CPU and memory in a production environment and is only for debugging. By default, this is checked.


Open Connection
This example command will create a connection to the public WebSocket echo server for testing. Any data sent to this web socket server will be echoed back.

Code:

ControlCommand("WebSocket Client", "Open", "ws://echo.websocket.org");

Send Data
Send test data once the connection has been established. You can continually send data as needed. When data is received from the server, the response will be assigned to a variable and the script will execute. By default, the script will speak the response.

Code:

ControlCommand("WebSocket Client", "Send", "Text to send");

ControlCommand("WebSocket Client", "Open", "ws://echo.websocket.org");
sleep(1000)
ControlCommand("WebSocket Client", "Send", "{'test'}");