Event
devices.properties.event
Отображение показаний свойств устройства (свойства могут иметь одно из заданных состояний).
Описание свойства
Структура используется в ответе операции Информация об устройствах пользователя.
Параметры свойства
Параметр |
Тип |
Описание |
Обязательный |
type |
String |
Тип свойства. |
Да |
retrievable |
Boolean |
Доступен ли для свойства устройства запрос состояния. Допустимые значения:
|
Нет |
reportable |
Boolean |
Оповещает ли свойство об изменении состояния платформу умного дома, используя сервис уведомлений. Допустимые значения:
|
Нет |
parameters |
Object |
Объект |
Да |
Объект parameters
Параметр |
Тип |
Описание |
Обязательный |
instance |
String |
Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций. |
Да |
events |
Array of event objects |
Массив объектов |
Да |
Объект event
, который входит в массив events
Параметр |
Тип |
Описание |
Обязательный |
value |
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": "sensor-001-snsr",
"name": "Сенсор",
"description": "Сенсор в спальне",
"room": "Спальня",
"type": "devices.types.sensor",
"custom_data": {
"api_location": "rus"
},
"capabilities": [],
"properties": [{
"type": "devices.properties.event",
"retrievable": true,
"reportable": true,
"parameters": {
"instance": "open",
"events": [{
"value": "opened"
},
{
"value": "closed"
}
]
}
}],
"device_info": {
"manufacturer": "Provider-01",
"model": "snsr 1",
"hw_version": "1.2",
"sw_version": "5.4"
}
}]
}
}
Текущее состояние свойства
Структура используется в ответе операции Информация о состояниях устройств пользователя и в теле запроса операции Уведомление об изменении состояний устройств.
Параметры свойства
Параметр |
Тип |
Описание |
Обязательный |
type |
String |
Тип свойства. |
Да |
state |
Object |
Параметры состояния свойства. |
Да |
Объект state
Параметр |
Тип |
Описание |
Обязательный |
instance |
String |
Название функции для свойства. Допустимые значения можно посмотреть в разделе Список функций. |
Да |
value |
String |
Значение свойства для данного умения. |
Да |
Пример использования
Платформа умного дома отправляет провайдеру запрос о состоянии устройств пользователя. Провайдер в ответ передает информацию о том, что свойство показывает открытие окна или двери.
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": "sensor-001-snsr",
"custom_data": {
"api_location": "rus"
}
}
]
}'
HTTP/1.1 200 OK
{
"request_id": "ff36a3cc-ec34-11e6-b1a0-64510650abcf",
"payload": {
"devices": [{
"id": "sensor-001-snsr",
"properties": [{
"type": "devices.properties.event",
"state": {
"instance": "open",
"value": "opened"
}
}]
}]
}
}
Cтрока, выделяется кавычками, например "Hello world"
.
Список пар "ключ": значение
, разделенных запятой. Выделяется фигурными скобками {}
.
{
"name": "John",
"surname": "Smith"
}
Массив элементов, разделенных запятой. Элементом могут быть стандартные элементы JSON: строка, число, true
, false
, объект или массив. Массив выделяется квадратными скобками []
:
"cities": ["Moscow", "Tokyo", "New York"]
Логическое значение без кавычек: true
(истина) или false
(ложь).