ym88659208ym87991671
Устройство light | Документация для разработчиков

light

Обновлено 30 августа 2023

Осветительный прибор, которым можно управлять. Примеры:

  • Лампочка
  • Ночник

Доступные функции устройства

У устройства могут быть все нижеперечисленные функции или только часть из них. Например, если умная лампа не умеет менять температуру цвета, включать функцию light_colour_temp в описание ее модели не нужно.

Некоторые функции обязательные: они должны быть у всех ламп.

ФункцияОбязательная?Описание
light_brightnessЯркость устройства
light_colourЦвет устройства
light_colour_tempТемпература цвета устройства
light_modeРежим работы устройства: цветной или белый цвет
on_off✔︎Удаленное включение и выключение устройства
online✔︎Доступность устройства: офлайн или онлайн

Пример описания модели лампы

Модель описывается в соответствии со структурой model. В примере описана лампа, которая может включаться и выключаться удаленно, поддерживает белый и цветной режим работы, умеет менять яркость, цвет и цветовую температуру. У лампы есть таймер выключения.

Кроме того, для модели описана зависимость функции light_colour (цвет освещения) от функции light_mode (режим работы): менять цвет лампы можно, только если она переключена в цветной режим работы.

Также изменены доступные значения для функции light_brightness (яркость): указано, что устройства этой модели умеют менять яркость в диапазоне от 10 до 900 с шагом в 1.

{
"id": "QWERTY123",
"manufacturer": "Xiaqara",
"model": "SM0123456789",
"hw_version": "3.2",
"sw_version": "5.7",
"description": "Умная лампа Xiaqara",
"category": "light",
"features": [
"online",
"on_off",
"light_mode",
"light_brightness",
"light_colour",
"light_colour_temp",
"sleep_timer"
],
"dependencies": {
"light_colour": {
"key": "light_mode",
"value": [
{
"type": "ENUM",
"enum_value": "colour"
}
]
}
},
"allowed_values": {
"light_brightness": {
"type": "INTEGER",
"integer_values": {
"min": "10",
"max": "900",
"step": "1"
}
}
}
}

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

Устройство описывается в соответствии со структурой device. В примере нет описания модели лампы — считаем, что модели описаны отдельно, поэтому достаточно указать только ID модели (здесь — QWERTY123).

{
"id": "ABCD_003",
"name": "Моя лампа",
"default_name": "Умная лампа",
"nicknames": [
"Светодиодная лампа",
"Смарт-лампа"
],
"home": "Мой дом",
"room": "Гостиная",
"groups": [
"Верхний свет",
"Ниша"
],
"model_id": "QWERTY123",
"hw_version": "3.2",
"sw_version": "5.7",
"partner_meta": {
"internal-id": 1234,
"specificity": "microchip 2A"
},
}
ПАО Сбербанк использует cookie для персонализации сервисов и удобства пользователей.
Вы можете запретить сохранение cookie в настройках своего браузера.