Skip to main content

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:

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

Methods

Cloud.SetConfig

Properties:

PropertyTypeDescription

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.

PropertyTypeDescription

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:

PropertyTypeDescription

connected

boolean

True if the device is connected to the Shelly cloud, false otherwise

Examples

Cloud.SetConfig example

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

Response

{
"restart_required": false
}

Cloud.GetConfig example

http://192.168.33.1/rpc/Cloud.GetConfig

Response

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

Cloud.GetStatus example

http://192.168.33.1/rpc/Cloud.GetStatus

Response

{
"connected": true
}