Devices configuration transmission (config)

Last updated on December 22, 2024

Direction: client → cloud.

The agent app provides Sber Smart Home with configurations of devices.

Use case example:

1. On the controller, the user changes a characteristic of one or more devices: name, firmware version or something else.
2. The agent receives from the controller the current device configuration and sends a message indicating it. The message can be sent independently or as a response to the Smart Home's message: sberdevices/v1/<username>/down/config_request.
3. The Smart Home updates the list of devices and correctly displays them in the Salute app, on SberPortal, SberBox and other devices with Salute assistant.

Message format

Topic:

sberdevices/v1/<username>/up/config

Parameter	Type	Mandatory?	Description
username	string	✔︎	Login for connection to the Sber MQTT server (see [Getting data for connecting an agent to the cloud](/en/smarthome/mqtt-diy/agent-authorization) section)

Message body:

Field	Type	Mandatory?	Description
devices	list<object>	✔︎	List of devices (see User device (device)), the configuration of which is transmitted

{
    "devices": [
        {
            "id": string,
            "name": string,
            "default_name": string
            // ...
        },
        {
            "id": string,
            "name": string,
            "default_name": string
            // ...
        }
    ]
}

Message example

The agent app installed on the controller notifies Sber Smart Home of the fact that the user's smart lamp has been updated.

Topic:

sberdevices/v1/1234567/up/config

Message body:

{
    "devices": [
        {
        "id": "ABCD_005",
        "name": "Night light",
        "default_name": "Smart lamp"
        }
    ]
}