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

Отримати структуру розділів

GET 
/home/:section_id

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

Request​

Path Parameters

    section_id stringrequired

    Розділ ID

Responses​

Структура розділу

Schema

    successbooleanrequired

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

    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

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