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

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

Функция	Описание
vibration	Отображение событий физического воздействия: вибрация, падение, переворачивание.
open	Отображение событий открытия/закрытия дверей, окон и т. п.
button	Отображение событий нажатия кнопки.
motion	Отображение событий, связанных с наличием движения в области действия датчика.
smoke	Отображение событий наличия дыма в помещении.
gas	Отображение событий наличия газа в помещении.
battery_level	Отображение событий заряда батареи.
food_level	Отображение событий, связанных с уровнем корма.
water_level	Отображение событий, связанных с уровнем воды.
water_leak	Отображение событий протечки воды.

vibration

Отображение событий физического воздействия: вибрация, падение, переворачивание.

Характеристики

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

Ниже приведено описание объекта vibration из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `vibration`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

tilt — переворачивание;
fall — падение;
vibration — вибрация.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "vibration",
    "events": [{
        "value": "tilt"
      },
      {
        "value": "fall"
      }
    ]
  }
  ...
}

Примеры устройств с функцией vibration

devices.types.sensor.vibration

open

Отображение событий открытия/закрытия дверей, окон и т. п.

Характеристики

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

Ниже приведено описание объекта open из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `open`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

opened — открыто;
closed — закрыто.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "open",
    "events": [{
        "value": "opened"
      },
      {
        "value": "closed"
      }
    ]
  }
  ...
}

Примеры устройств с функцией open

button

Отображение событий нажатия кнопки.

Характеристики

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

Ниже приведено описание объекта button из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `button`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

click — одиночное нажатие;
double_click — двойное нажатие;
long_press — долгое нажатие.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "button",
    "events": [{
        "value": "click"
      },
      {
        "value": "double_click"
      }
    ]
  }
  ...
}

Примеры устройств с функцией button

devices.types.sensor.button

motion

Отображение событий, связанных с наличием движения в области действия датчика.

Характеристики

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

Ниже приведено описание объекта motion из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `motion`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

detected — обнаружено;
not_detected — не обнаружено.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "motion",
    "events": [{
        "value": "detected"
      },
      {
        "value": "not_detected"
      }
    ]
  }
  ...
}

Примеры устройств с функцией motion

devices.types.sensor.motion

smoke

Отображение событий наличия дыма в помещении.

Характеристики

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

Ниже приведено описание объекта smoke из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `smoke`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

detected — обнаружено;
not_detected — не обнаружено;
high — высокий уровень.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
    ...
    "parameters": {
        "instance": "smoke",
        "events": [{
            "value": "detected"
        },
        {
            "value": "not_detected"
        }]
    }
    ...
}

Примеры устройств с функцией smoke

devices.types.sensor.smoke

gas

Отображение событий наличия газа в помещении.

Характеристики

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

Ниже приведено описание объекта gas из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `gas`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

detected — обнаружено;
not_detected — не обнаружено;
high — высокий уровень.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "gas",
    "events": [{
        "value": "detected"
      },
      {
        "value": "not_detected"
      }
    ]
  }
  ...
}

Примеры устройств с функцией gas

devices.types.sensor.gas

battery_level

Отображение событий заряда батареи.

Характеристики

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

Ниже приведено описание объекта battery_level из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `battery_level`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

low — низкий;
normal — нормальный.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "battery_level",
    "events": [{
        "value": "low"
      },
      {
        "value": "normal"
      }
    ]
  }
  ...
}

Примеры устройств с функцией battery_level

food_level

Отображение событий, связанных с уровнем корма.

Характеристики

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

Ниже приведено описание объекта food_level из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `food_level`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

empty — пустой;
low — низкий;
normal — нормальный.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "food_level",
    "events": [{
        "value": "empty"
      },
      {
        "value": "low"
      },
      {
        "value": "normal"
      }
    ]
  }
  ...
}

Примеры устройств с функцией food_level

devices.types.pet_feeder

water_level

Отображение событий, связанных с уровнем воды.

Характеристики

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

Ниже приведено описание объекта water_level из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `water_level`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

empty — пустой;
low — низкий;
normal — нормальный.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "water_level",
    "events": [{
        "value": "empty"
      },
      {
        "value": "low"
      },
      {
        "value": "normal"
      }
    ]
  }
  ...
}

Примеры устройств с функцией water_level

water_leak

Отображение событий протечки воды.

Характеристики

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

Ниже приведено описание объекта water_leak из раздела Описание свойства.

Объект parameters

Параметр	Тип	Описание
instance	String	Название функции для свойства. Допустимые значения: `water_leak`.
events	Array of event objects	Массив объектов `event`, которые описывают события, поддерживаемые свойством. Минимальное количество событий в массиве: 1.

Объект event, который входит в массив events

Параметр

Тип

Описание

value

String

Название функции для свойства. Допустимые значения:

dry — нет протечки;
leak — протечка.

Использование данной функции при описании возможностей различных устройств:

Пример объекта parameters

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

{
  ...
  "parameters": {
    "instance": "water_leak",
    "events": [{
        "value": "dry"
      },
      {
        "value": "leak"
      }
    ]
  }
  ...
}

Примеры устройств с функцией water_leak

devices.types.sensor.water_leak

Массив элементов, разделенных запятой. Элементом могут быть стандартные элементы JSON: строка, число, true, false, объект или массив. Массив выделяется квадратными скобками []:

"cities": ["Moscow", "Tokyo", "New York"]

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

Event

Протокол работы платформы умного дома