Outbound Websocket

The Outbound Webscoket component makes it possible to configure a Gen2 Shelly device to establish and maintain an outbound websocket connection. An RPC channel is available over said connection, supporting all features of inbound WS and MQTT channels, along with unsolicited complete status notifications on connect. The Outbound Websocket component uses ws as RPC namespace and provides the methods:

• Ws.SetConfig to update the component's configuration
• Ws.GetConfig to obtain the component's configuration
• Ws.GetStatus to obtain the component's status

It uses the key ws when enumerated in objects including multiple component payloads, like Shelly.GetStatus.

Methods

Ws.SetConfig

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Ws.GetConfig

Find the Ws.GetConfig response properties in config section

Ws.GetStatus

Find the Ws.GetStatus response properties in status section

Configuration

Property	Type	Description
enable	boolean	true if websocket outbound connection is enabled, false otherwise
server	string	Name of the server to which the device is connected. When prefixed with wss:// a TLS socket will be used
ssl_ca	string	Type of the TCP sockets Value Description * TLS with disabled certificate validation user_ca.pem TLS connection verified by the user-provided CA ca.pem TLS connection verified by the built-in CA bundle

Status

Property	Type	Description
connected	boolean	true if device is connected to a websocket outbound connection or false otherwise.

Examples

Ws.SetConfig example

Ws.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Ws.SetConfig?config={"ssl_ca":"*"}

Ws.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Ws.SetConfig","params":{"config":{"ssl_ca":"*"}}}' http://${SHELLY}/rpc

Ws.SetConfig Mos Request

mos --port ${PORT} call Ws.SetConfig '{"config":{"ssl_ca":"*"}}'

Response

Ws.SetConfig HTTP GET Response

{
  "restart_required": true
}

Ws.SetConfig Curl Response

{
  "id": 1,
  "src": "shellypro4pm-f008d1d8b8b8",
  "params": {
    "restart_required": true
  }
}

Ws.SetConfig Mos Response

{
  "restart_required": true
}

Ws.GetConfig example

Ws.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Ws.GetConfig

Ws.GetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Ws.GetConfig"}' http://${SHELLY}/rpc

Ws.GetConfig Mos Request

mos --port ${PORT} call Ws.GetConfig

Response

Ws.GetConfig HTTP GET Response

{
  "enable": false,
  "server": null,
  "ssl_ca": "*"
}

Ws.GetConfig Curl Response

{
  "id": 1,
  "src": "shellypro4pm-f008d1d8b8b8",
  "params": {
    "enable": false,
    "server": null,
    "ssl_ca": "*"
  }
}

Ws.GetConfig Mos Response

{
  "enable": false,
  "server": null,
  "ssl_ca": "*"
}

Ws.GetStatus example

Ws.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Ws.GetStatus

Ws.GetStatus Curl Request

curl -X POST -d '{"id":1,"method":"Ws.GetStatus"}' http://${SHELLY}/rpc

Ws.GetStatus Mos Request

mos --port ${PORT} call Ws.GetStatus

Response

Ws.GetStatus HTTP GET Response

{
  "connected": false
}

Ws.GetStatus Curl Response

{
  "id": 1,
  "src": "shellypro4pm-f008d1d8b8b8",
  "params": {
    "connected": false
  }
}

Ws.GetStatus Mos Response

{
  "connected": false
}