Перейти до основного вмісту

Отримати інформацію про пристрій

GET 

/devices/:id

Отримати інформацію про пристрій

Request

Path Parameters

    id integerrequired

    Ідентифікатор пристрою

Query Parameters

    show_hidden boolean

    Включити приховані параметри

    compact boolean

    Якщо параметр compact встановлено на false, відповідь буде містити додаткову інформацію про параметри конфігурації та асоціації з шаблону пристрою.

    with_actions boolean

    Уключіть дії пристрою у відповідь

    fields booleanrequired

    Обмежте параметри, що повертаються у відповіді. all - поверне всі невидимі параметри, тоді як default - поверне лише параметри, потрібні для мобільного інтерфейсу.

Responses

Інформація про пристрій

Schema

    successbooleanrequired

    Прапорець, який показує, чи був запит успішним

    idinteger

    Внутрішній ідентифікатор пристрою

    typestring

    Тип пристрою, див. Типи пристроїв

    Possible values: [DevGateway, DevSwitch, DevDimmer, DevDimmerColor, DevShutter, DevBinarySensor, DevGenericSensor, DevThermostat, DevDoorLock, DevMeter, DevUnknown]

    interfacesstring[]

    Список інтерфейсів, реалізованих пристроєм

    Example: ["ZWaveDevice","SwitchBinary"]
    aliveboolean

    Чи пристрій працює?

    has_templateboolean

    Пристрій має шаблон

    params

    object

    Карта параметрів пристроїв

    description
    last_onlineint64

    Відмітка часу останнього повідомлення від пристрою

    Example: 1600000000
    plugin_uuidstringnullable

    Якщо пристрій створено за допомогою плагіна, це поле містить UUID плагіна

    Example: 12345678-1234-1234-1234-123456789012
    namestring

    Назва пристрою

    Example: Some Switch
    room_idinteger

    Ідентифікатор кімнати, де знаходиться пристрій.

    rolestring

    Роль пристрою

    Possible values: [Control, Lighting, Shutters, ClimateThermostat, ClimateThermostatHeating, ClimateThermostatCooling, ClimateWarmFloor, ClimateFanSpeed1, ClimateFanSpeed2, ClimateFanSpeed3, MultilevelSensor, BinaryMotionSensor, BinaryGenericSensor, BinarySmokeSensor, BinaryDoorSensor, BinaryWindowSensor, BinaryLeakingSensor, Doorlock, DoorlockNO, NotAvailable]

    Example: Control
    iconstring

    Ім'я значка, для списку значків дивіться Список значків

    hiddenboolean

    Пристрої приховані від інтерфейсу користувача.

    orderinteger

    Порядок розташування пристроїв у кімнаті

    note_textstring

    Примітка тексту

    Example: Цей пристрій розташований у ​​електричній коробці десь.
    note_imagestring

    Примітка до назви файлу зображення

    Example: someimage.png
    favoriteboolean

    Пристрій у списку обраних користувачем