Float - Платформа умного дома Яндекса

Протокол работы с платформой

Свойства

Float

devices.properties.float

Отображение значений свойств устройства в числовом формате.

Описание свойства

Структура используется в ответе операции Информация об устройствах пользователя.

Параметры свойства


Параметр	Тип	Описание	Обязательный
type	String	Тип свойства.	Да
retrievable	Boolean	Доступен ли для свойства устройства запрос состояния. Допустимые значения: `true` — для свойства доступен запрос состояния. Является значением по умолчанию; `false` — для свойства недоступен запрос состояния. Значение доступно, если `reportable:true`.	Нет
reportable	Boolean	Оповещает ли свойство об изменении состояния платформу умного дома, используя сервис уведомлений. Допустимые значения: `true` — оповещение включено. Производитель оповещает платформу умного дома о каждом изменении состояния свойства; `false` — оповещение выключено. Производитель не оповещает платформу об изменении состояния свойства. Является значением по умолчанию.	Нет
parameters	Object	Объект `parameters`.	Да
Объект `parameters`
instance	String	Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций.	Да
unit	String	Единицы измерения значений функции. Допустимые значения можно посмотреть в разделе Список функций.	Да


Параметр	Тип	Описание	Обязательный
type	String	Тип свойства.	Да
retrievable	Boolean	Доступен ли для свойства устройства запрос состояния. Допустимые значения: `true` — для свойства доступен запрос состояния. Является значением по умолчанию; `false` — для свойства недоступен запрос состояния. Значение доступно, если `reportable:true`.	Нет
reportable	Boolean	Оповещает ли свойство об изменении состояния платформу умного дома, используя сервис уведомлений. Допустимые значения: `true` — оповещение включено. Производитель оповещает платформу умного дома о каждом изменении состояния свойства; `false` — оповещение выключено. Производитель не оповещает платформу об изменении состояния свойства. Является значением по умолчанию.	Нет
parameters	Object	Объект `parameters`.	Да
Объект `parameters`
instance	String	Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций.	Да
unit	String	Единицы измерения значений функции. Допустимые значения можно посмотреть в разделе Список функций.	Да

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

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

curl -i -X GET 'https://example.com/v1.0/user/devices' \
-H 'Authorization: Bearer 123qwe456a...' \
-H 'X-Request-Id: ff36a3cc-ec...'
Скопировано

HTTP/1.1 200 OK
                                
{
    "request_id": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "payload": {
        "user_id": "user-001",
        "devices": [{
            "id": "humidifier-001-hmdfr",
            "name": "увлажнитель",
            "description": "умный увлажнитель hmdfr",
            "room": "спальня",
            "type": "devices.types.humidifier",
            "custom_data": {
                "api_location": "rus"
            },
            "capabilities": [{
                "type": "devices.capabilities.on_off"
            }],
            "properties": [{
                "type": "devices.properties.float",
                "retrievable": true,
                "reportable": true,
                "parameters": {
                    "instance": "humidity",
                    "unit": "unit.percent"
                }
            }],
            "device_info": {
                "manufacturer": "Provider-01",
                "model": "hmdfr 1",
                "hw_version": "1.2",
                "sw_version": "5.4"
            }
        }]
    }
}
Скопировано

Текущее состояние свойства

Структура используется в ответе операции Информация о состояниях устройств пользователя и в теле запроса операции Уведомление об изменении состояний устройств.

Параметры свойства


Параметр	Тип	Описание	Обязательный
type	String	Тип свойства.	Да
state	Object	Параметры состояния свойства.	Да
Объект `state`
instance	String	Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций.	Да
value	Float	Значение свойства для данного умения.	Да


Параметр	Тип	Описание	Обязательный
type	String	Тип свойства.	Да
state	Object	Параметры состояния свойства.	Да
Объект `state`
instance	String	Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций.	Да
value	Float	Значение свойства для данного умения.	Да

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

Платформа умного дома отправляет провайдеру запрос о состоянии устройств пользователя. Провайдер в ответ передает информацию о том, что свойство увлажнителя показывает 55% влажности.

curl -i -X POST 'https://example.com/v1.0/user/devices/query' \
-H 'Authorization: Bearer 123qwe456a...' \
-H 'X-Request-Id: ff36a3cc-ec...' \
-H 'Content-Type: application/json' \
-d '{
      "devices": 
      [
        {
            "id": "humidifier-001-hmdfr",
            "custom_data": {
                "api_location": "rus"
            } 
        }
      ]
    }'
Скопировано

HTTP/1.1 200 OK

{
    "request_id": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
    "payload": {
        "devices": [{
            "id": "humidifier-001-hmdfr",
            "properties": [{
                "type": "devices.properties.float",
                "state": {
                    "instance": "humidity",
                    "value": 55
                }
            }]
        }]
    }
}                                
Скопировано

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

О свойствах

Список функций

В этой статье

Описание свойства Текущее состояние свойства

О свойствах

Список функций