Cloud

The cloud component is called Cloud. It handles cloud services of a device. The cloud component uses cloud as RPC namespace and provides the methods:

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

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

Methods

Cloud.SetConfig

Properties:

Property	Type	Description
config	object	Configuration that the method takes

Find more about the config properties in config section

Cloud.GetConfig

The Cloud.GetConfig method does not own any request properties.Find the response properties in config section

Cloud.GetStatus

The Cloud.GetStatus method does not own any request properties.Find the response properties in status section

Configuration

The configuration of the Cloud component shows information about the connection to the cloud.

Property	Type	Description
enable	boolean	True if cloud connection is enabled, false otherwise
server	string or null	Name of the server to which the device is connected

Status

Through the status of the Cloud component it can be checked whether the device is connected to the cloud.

Attributes in the result:

Property	Type	Description
connected	boolean	True if the device is connected to the Shelly cloud, false otherwise

Examples

Cloud.SetConfig example

Cloud.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Cloud.SetConfig?config={"enable":true}

Cloud.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Cloud.SetConfig","params":{"config":{"enable":true}}}' http://${SHELLY}/rpc

Cloud.SetConfig Mos Request

mos --port ${PORT} call Cloud.SetConfig '{"config":{"enable":true}}'

Response

Cloud.SetConfig HTTP GET Response

{
  "restart_required": false
}

Cloud.SetConfig Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {
    "restart_required": false
  }
}

Cloud.SetConfig Mos Response

{
  "restart_required": false
}

Cloud.GetConfig example

Cloud.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Cloud.GetConfig

Cloud.GetConfig Curl Request

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

Cloud.GetConfig Mos Request

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

Response

Cloud.GetConfig HTTP GET Response

{
  "enable": false,
  "server": "iot.shelly.cloud:6012/jrpc"
}

Cloud.GetConfig Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {
    "enable": false,
    "server": "iot.shelly.cloud:6012/jrpc"
  }
}

Cloud.GetConfig Mos Response

{
  "enable": false,
  "server": "iot.shelly.cloud:6012/jrpc"
}

Cloud.GetStatus example

Cloud.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Cloud.GetStatus

Cloud.GetStatus Curl Request

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

Cloud.GetStatus Mos Request

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

Response

Cloud.GetStatus HTTP GET Response

{
  "connected": true
}

Cloud.GetStatus Curl Response

{
  "id": 1,
  "src": "shellyplus1pm-441793ce3f08",
  "params": {
    "connected": true
  }
}

Cloud.GetStatus Mos Response

{
  "connected": true
}