Передача конфигурации устройств (config)

Обновлено 22 декабря 2024

Направление: клиент → облако.

Приложение-агент отправляет умному дому Sber конфигурацию устройств.

Пример ситуации использования:

1. Пользователь на контроллере изменяет характеристику одного или нескольких устройств: название, версию прошивки или другую.
2. Агент получает от контроллера актуальную конфигурацию устройств и отправляет сообщение с этой конфигурацией. Отправка сообщения может быть инициирована как самостоятельно, так и в ответ на сообщение умного дома sberdevices/v1/<username>/down/config_request.
3. Умный дом актуализирует устройства и корректно отображает их в приложении Салют, приложении СберБанк Онлайн, на SberPortal, SberBox и других устройствах с ассистентом Салют.

Формат сообщения

Топик:

sberdevices/v1/<username>/up/config

Параметр	Тип	Обязательный?	Описание
username	string	✔︎	Логин, с которым осуществляется подключение к MQTT-серверу Sber (см. раздел [Получение данных для подключения агента к облаку](/ru/smarthome/mqtt-diy/agent-authorization))

Тело сообщения:

Поле	Тип	Обязательное?	Описание
devices	list<objects>	✔︎	Список устройств (см. Устройство пользователя (device)), конфигурация которых передается

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

Пример сообщения

Приложение-агент на контроллере уведомляет умный дом Sber об обновлении конфигурации умной лампы пользователя.

Топик:

sberdevices/v1/1234567/up/config

Тело сообщения:

{
    "devices": [
        {
        "id": "ABCD_005",
        "name": "Ночник",
        "default_name": "Умная лампа"
        }
    ]
}