Отримати ієрархію додому

GET 
/home

Отримайте повну структуру дому. Цей кінцевий пункт повертає всю ієрархічну структуру дому з розділами, кімнатами, а також пристроями.

Responses

200

Повна будівельна конструкція

application/json

Schema

Schema

successbooleanrequired

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

sections

object

idinteger

Розділ ID

Example: 2

namestring

Назва розділу

Example: Коридор

orderinteger

Порядок розділу

Example: 1

rooms

object

idinteger

Ідентифікатор кімнати

Example: 3

namestring

Назва кімнати.

Example: Коридор

orderinteger

Порядок кімнат у секції

Example: 1

section_idinteger

Батьківський розділ кімнати

Example: 1

background_imagestring

Зображення тла кімнати

Example: 123321.jpg

iconstring

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

Example: ch-door

main_devices

object

Основні пристрої кімнати

temperature_sensorinteger

Первинний температурний датчик.

Example: 132

humidity_sensorinteger

Первинний датчик вологості

Example: 22

luminosity_sensorinteger

Світло.

Example: 23

power_sensorinteger

Датчик потужності

property name*integer

Будь-який сенсор багаторівневого сенсору може стати первинним кімнатним сенсором для свого типу. Ім'я властивості складається з типу сенсору з приставкою _sensor у нижньому регістрі (наприклад, сенсор з "sensorType": "Smoke" стане smoke_sensor в властивості main_devices)

devices

object

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

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

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

Example (from schema)

{
  "success": true,
  "sections": {
    "id": 2,
    "name": "Коридор",
    "order": 1,
    "rooms": {
      "id": 3,
      "name": "Коридор",
      "order": 1,
      "section_id": 1,
      "background_image": "123321.jpg",
      "icon": "ch-door",
      "main_devices": {
        "temperature_sensor": 132,
        "humidity_sensor": 22,
        "luminosity_sensor": 23,
        "power_sensor": 0
      },
      "devices": {
        "id": 0,
        "type": "DevGateway",
        "interfaces": [
          "ZWaveDevice",
          "SwitchBinary"
        ],
        "alive": true,
        "has_template": true,
        "params": {
          "nodeId": 12,
          "Status": true,
          "pulsable": false
        },
        "last_online": 1600000000,
        "plugin_uuid": "12345678-1234-1234-1234-123456789012",
        "name": "Some Switch",
        "room_id": 0,
        "role": "Control",
        "icon": "string",
        "hidden": true,
        "order": 0,
        "note_text": "Цей пристрій розташований у ​​електричній коробці десь.",
        "note_image": "someimage.png",
        "favorite": true
      }
    }
  }
}

401

Користувач не має дозволу.

application/json

Schema

Schema

successbooleanrequired

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

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Example

{
  "success": false,
  "errorCode": 4131,
  "errorMessage": "User not authorized",
  "errorParameters": "Not authorized"
}