Group

The virtual Group component is used to store a list of components keys. It uses Group as RPC namespace and has the following methods:

• Group.SetConfig to update the component's configuration
• Group.GetConfig to obtain the component's configuration
• Group.GetStatus to obtain the component's status
• Group.Set to update the component's value

Methods

Group.SetConfig

Property	Type	Description
id	number	Id of the component instance
config	object	Configuration that the method takes

Find more about the config properties in config section

Group.GetConfig

Properties:

Property	Type	Description
id	number	Id of the component instance

Find the Group.GetConfig response properties in config section

Group.GetStatus

Properties:

Property	Type	Description
id	number	Id of the component instance

Find more about the status response properties in status section

Group.Set

This method updates the value of the Group component.

Request

Parameters:

Property	Type	Description
id	number	Id of the component instance. Required
value	array of strings	List of valid components keys (in format <type>:<cid>, e.g. boolean:200) Required

Configuration

The configuration of the Group component contains information about the default value, whether it should persist after reboot, and properties of how it will be rendered in the UI. To Get/Set the configuration of the Group component its id must be specified.

Properties:

Property	Type	Description
id	number	Id of the component instance
name	string or null	Name of the component instance
meta	object or null	Stores the component's metadata

Status

The status of the Group component contains information about its current value, the timestamp for the value update, and the source of the last command. To obtain the status of the Group component its id must be specified.

Properties:

Property	Type	Description
source	string	Source of the last command
value	array of strings	List of valid components keys (in format <type>:<cid>, e.g. boolean:200)
last_update_ts	number	Unix timestamp for the value update

Examples

Group.SetConfig example

Group.SetConfig HTTP GET Request

http://192.168.33.1/rpc/Group.SetConfig?id=200&config={"name":"Thermostat"}

Group.SetConfig Curl Request

curl -X POST -d '{"id":1,"method":"Group.SetConfig","params":{"id":200,"config":{"name":"Thermostat"}}}' http://${SHELLY}/rpc

Group.SetConfig Mos Request

mos --port ${PORT} call Group.SetConfig '{"id":200,"config":{"name":"Thermostat"}}'

Response

Group.SetConfig HTTP GET Response

{
  "restart_required": false
}

Group.SetConfig Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "restart_required": false
  }
}

Group.SetConfig Mos Response

{
  "restart_required": false
}

Group.GetConfig example

Group.GetConfig HTTP GET Request

http://192.168.33.1/rpc/Group.GetConfig?id=200

Group.GetConfig Curl Request

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

Group.GetConfig Mos Request

mos --port ${PORT} call Group.GetConfig '{"id":200}'

Response

Group.GetConfig HTTP GET Response

{
  "id": 200,
  "name": "Thermostat"
}

Group.GetConfig Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "id": 200,
    "name": "Thermostat"
  }
}

Group.GetConfig Mos Response

{
  "id": 200,
  "name": "Thermostat"
}

Group.GetStatus example

Group.GetStatus HTTP GET Request

http://192.168.33.1/rpc/Group.GetStatus?id=200

Group.GetStatus Curl Request

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

Group.GetStatus Mos Request

mos --port ${PORT} call Group.GetStatus '{"id":200}'

Response

Group.GetStatus HTTP GET Response

{
  "value": [
    "boolean:200",
    "enum:200"
  ],
  "source": "rpc",
  "last_update_ts": 1700864253
}

Group.GetStatus Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": {
    "value": [
      "boolean:200",
      "enum:200"
    ],
    "source": "rpc",
    "last_update_ts": 1700864253
  }
}

Group.GetStatus Mos Response

{
  "value": [
    "boolean:200",
    "enum:200"
  ],
  "source": "rpc",
  "last_update_ts": 1700864253
}

Group.Set example

Group.Set HTTP GET Request

http://192.168.33.1/rpc/Group.Set?id=200&value=["boolean:200","enum:200"]

Group.Set Curl Request

curl -X POST -d '{"id":1,"method":"Group.Set","params":{"id":200,"value":["boolean:200","enum:200"]}}' http://${SHELLY}/rpc

Group.Set Mos Request

mos --port ${PORT} call Group.Set '{"id":200,"value":["boolean:200","enum:200"]}'

Response

Group.Set HTTP GET Response

null

Group.Set Curl Response

{
  "id": 1,
  "src": "shelly1pmminig3-84fce63fe000",
  "params": null
}

Group.Set Mos Response

null