• MQTT API
  • Подключение прибора
  • Управление VakioBaseSmart Rev2 (ESP32)
    • +/system
    • +/mode
    • +/state
    • +/workmode
    • +/speed
  • Управление VakioOpenair Rev2 (ESP32)
    • device/+/openair/system | server/+/openair/system
    • device/+/openair/mode | server/+/openair/mode
    • +/state
    • +/workmode
    • +/gate
    • +/speed
    • +/temp
    • +/hud
  • Управление VakioAtmosphere
    • +/system
    • +/temp
    • +/co2
    • +/hud
  • Управление VakioCityAir (250, 500)
    • +/+/lwt
    • +/+/system
    • +/+/log
    • +/+/state
    • +/+/ten_state
    • +/+/damper_state
    • +/+/target_temp
    • +/+/target_speed
    • +/+/speed
    • +/+/in_temp
    • +/+/out_temp
    • +/+/damper
    • +/+/filter
    • +/+/odometer
    • +/+/error
    • +/+/reset_error
    • +/+/reset_filter
    • +/+/update
  • Управление VakioVector
    • device/+/vector/mode
    • device/+/vector/mode
• REST API
  • Регистрация
  • Получение данных о приборах
  • Управление VakioBaseSmart
  • Управление VakioOpenAir
  • Управление VakioVector
  • Управление VakioCityair500
• Интеграции с системами умных домов
  • Home Assistant
    • VAKIO Smart Series
    • VAKIO Openair
    • VAKIO Atmosphere
    • VAKIO Kiv Smart
  • MajorDOMO
    • Smart-устройства
  • Sprut.hub (от партнеров)
    • VAKIO Smart Series + Wirenboard

Подключение к локальному серверу c помощью MQTT для интеграции приборов Vakio c системами умного дома
Инструкция по подключению приборов по MQTT.

Команды для актуальной версии (1.2.1), если они недоступны, обновите прибор

"+" - Ваш топик по умолчанию (vakio/system)

  topic: +/system
  message: 0609

"+" - Ваш топик по умолчанию (vakio/system)

Регистрация прибора (Отправляется при каждом подключении)

0601{series:esp32,subtype:"subtype","xtal_freq":"xtal_freq"}

060006versionmacaddress | 0600061.2.1FF:FF:FF:FF:FF

Запустить обновление прибора

0609

Повтор регистрации

0687

Прибор отправит на +/system команды регистрации прибора и сообщение 0685

Сброс к заводским настройкам

0608

"+" - Ваш топик по умолчанию (vakio/mode)

Включить/Выключить прибор

06000 - Выключить
06001 - Включить

Режим рекуперации

06010 - Рекуперация лето
06011 - Рекуперация зима

Режим приток

06021 - Приток
06022 - Приток MAX

Режим вытяжка

06031 - Вытяжка
06032 - Вытяжка MAX

Режим ночной

06041

Скорость

0650X (X - от 1 до 7)

"+" - Ваш топик по умолчанию (vakio/state)

Управление состояние прибора (Вкл/Выкл)

Команда

on - Включить
0ff - Выключить

"+" - Ваш топик по умолчанию (vakio/workmode)

Управление режимом прибора

Команда

inflow - Приток
inflow_max - Приток MAX
recuperator - Рекуперация лето
winter - Рекуперация зима
outflow - Вытяжка
outflow_max - Вытяжка MAX
night - Ночной

"+" - Ваш топик по умолчанию (vakio/speed)

Управление скоростью прибора

Команда

1-7 (Номер скорости)

Команды для актуальной версии (1.1.0), если они недоступны, обновите прибор

C версии 1.1.0 openair поддерживает команды в json с массивами, так и в формате объектов

"+" - Ваш топик по умолчанию (vakio/system)

Топик: server/+/openair/system

{
  "firmware": [
    {
      "domain": "service.vakio.ru"
    },
    {
      "start": 1
    }
  ]
}

"+" - Ваш топик по умолчанию (vakio/system)

Топик для получения команд от прибора

device/+/openair/system

Регистрация прибора (Отправляется при каждом подключении)

{
  "type": "auth",
  "auth": {
    "device_mac": "FF:FF:FF:FF:FF",
    "version": "1.1.1"
  },
  "device_subtype": {
    "exchange_type": "json",
    "series": "esp32",
    "subtype": "tmp8015-chip",
    "xtal_freq": "40"
  }
}

Ошибка переохладения (Отправляется при критически низкой температуры платы)

{
  "errors": {
    "shutdown": 1 // 1 - Состояние переохлаждения | 0 - нормальное состояние
  }
}

Топик для отправки команд прибору

server/+/openair/system

Настройка переохлаждения

{
  "shutdown": {
    "limit": 0 // Значение температуры при котором войдет в состояние переохлаждения
  }
}

Сброс настроек

{
  "reset": [
    {
      "wireless": "reset" // Сброс настроек подключения
    },
    {
      "device": "reset" // Сброс параметров режима работы
    },
    {
      "all": "reset" // Полный сброс настроек
    }
  ]
}

Обновление прошивки

{
  "firmware": [
    {
      "domain": "service.vakio.ru"
    },
    {
      "start": 1
    }
  ]
}

Актальная версия прибора (с 1.1.0)

{
  "firmware": {
    "domain": "service.vakio.ru",
    "start": 1
  }
}

"+" - Ваш топик по умолчанию (vakio/system)

Топик для получения команд от прибора

device/+/openair/mode

Рабочий режим capabilities

{
  "capabilities": {
    "mode": "manual", // Режим работы "manual", "super_auto"
    "on_off": "on", // Состояние прибора "on","off"
    "speed": 1, // 0-5
    "gate": 4 // 1 - 4 (4 - полностью открыт)
  }
}

Настройки settings

{
  "settings": {
    "temperature_speed": [20, 5], // Настройка умного режима от ВНУТРЕННОГО датчика, 1 - темпераутра, 2 - скорость
    "emerg_shunt": 10, // Температура при который клапан прекратит работу (Для избежания образования росы на плате)
    "gate": 4 // 1 - 4 (4 - полностью открыт) Положение заслонки в умном режиме от ВНУТРЕННОГО датчика
  }
}

Топик для отправки команд прибору

server/+/openair/mode

Управление прибором

{
  "capabilities": [
    { "speed": 2 },
    { "gate": 4 },
    { "on_off": "on" },
    { "mode": "manual" } // "super_auto"
  ]
}

Актальная версия прибора (с 1.1.0)

{
  "capabilities": {
    "mode": "manual", // Режим работы "manual", "super_auto"
    "on_off": "on", // Состояние прибора "on","off"
    "speed": 1, // 1-5
    "gate": 4 // 1 - 4 (4 - полностью открыт)
  }
}

Настройка прибора

{
  "settings": [
    { "gate": 1 }, // 1-4 Положение заслонки в SMART режиме
    { "smart_speed": 1 }, // 1-5 Скорость в SMART режиме
    { "emerg_shunt": 5 } // Темперура отключения прибора
  ]
}

Актальная версия прибора (с 1.1.0)

{
  "settings": {
    "gate": 1, // 1-4 Положение заслонки в SMART режиме
    "smart_speed": 1, // 1-5 Скорость в SMART режиме
    "emerg_shunt": 5 // Темперура отключения прибора
  }
}

"+" - Ваш топик по умолчанию (vakio/state)

Управление состояние прибора (Вкл/Выкл)

Команда

on - Включить
0ff - Выключить

"+" - Ваш топик по умолчанию (vakio/workmode)

Управление режимом прибора

Команда

manual - Ручной режим
super_auto - SMART режим

"+" - Ваш топик по умолчанию (vakio/speed)

Управление скоростью прибора

Команда

0-5 (Номер скорости)

"+" - Ваш топик по умолчанию (vakio/gate)

Управление заслонкой прибора

Команда

1-4 (Позиция заслонки)

"+" - Ваш топик по умолчанию (vakio/temp)

Показания внутренного датчика температуры

Пример:
20

"+" - Ваш топик по умолчанию (vakio/hud)

Показания внутренного датчика влажности

Пример:
33

Команды для актуальной версии (1.0.2), если они недоступны, обновите прибор

"+" - Ваш топик по умолчанию (vakio/system)

  topic: +/system
  message: 0709

"+" - Ваш топик по умолчанию (vakio/system)

Регистрация прибора (Отправляется при каждом подключении)

0701{"series":"esp8266","subtype":"subtype","xtal_freq":"xtal_freq"}

070007versionmacaddress | 0700061.2.1FF:FF:FF:FF:FF

Запустить обновление прибора

0709

Вкл/Выкл светодиодов

0732X (X - 0/1)

Ротация дисплея

0731X (X - 0/1)

Выбор режима подсветки

0727x (X - 0-1)
0 - ручная настройка яркости подсветки
1 - яркость подсветки зависит от освещенности

Яркость подсветки в ручном режиме

0727x (X - 000-100) 3 символа

Сброс настроек

0708

Проверка онлайна

0787

"+" - Ваш топик по умолчанию (vakio/temp)

Показания внутренного датчика температуры

Пример:
20

"+" - Ваш топик по умолчанию (vakio/hud)

Показания внутренного датчика влажности

Пример:
33

"+" - Ваш топик по умолчанию (vakio/hud)

Показания внутренного датчика CO2

Пример:
1000

Команды для актуальной версии, если они недоступны, обновите прибор.
Для данного прибора формирование топиков происходит по следующей схеме:
+/+/..
"+" - последние 2 байта мас адреса устройства
"+" - ваш топик (по умолчанию cityair)
.. - изменяемая часть

При отключении прибора от серверу происходит публикация сообщения "Offline"

При получении прибором команды "GET" на сервер отправляются все настройки устройства

При каждом подключении прибора к серверу происходит публикация сообщения
версии прибора, mac адреса прибора, ip прибора

Команды вкл/выкл прибора: "on"/"off"

Команды вкл/выкл тена прибора: "on"/"off"

Команды использования/не использования заслонки: "on"/"off"

Команды целевой температуры тена: 10..25 (в градусах)

Команды целевой скорости вентилятора: 1..7

Команды скорости вентилятора: 0..100 (в процентах)

Команды температуры датчика температуры на входе: -55..+125 (в градусах)

Команды температуры датчика температуры на выходе: -55..+125 (в градусах)

Команды положения заслонки: "closed", "opened", "opens", "closes"

Команды фильтра наработки моточасов (в часах)

Команды фильтра наработки часов (в часах)

Команды ошибок прибора: "temp_hot", "temp_cold", "stop_hot", "stop_cold", "ds18_bus", "ds18_lack", "no"

Команда сброса ошибок прибора: любое значение

Команда сброса фильтра: любое значение

Команда обновления прошивки прибора: любое значение

Команды актуальны для версии (0.1.8) и выше.

Топики:
device/+/vector/mode - отправка команд от прибора на сервер
server/+/vector/mode - отправка команд от сервера на прибор

"+" - Ваш топик по умолчанию (vakio)

При подключении прибор отправляет два json объекта с настройками capabilities, settings.

Состояние прибора включить/выключить (on/off) (прием от сервера, отправка на сервер)

Пример:
{"capabilities": {"on_off": "on"}}

Скорость вентилятора (1-7) (прием от сервера, отправка на сервер)

Пример:
{"capabilities": {"speed": 3}}

Подогрев выходящего воздуха, в градусах цельсия (5-30) (прием от сервера, отправка на сервер)

Пример:
{"capabilities": {"heat": 14}}

Режим работы, smart доступен только при настройке через приложение (manual/smart) (прием от сервера, отправка на сервер)

Пример:
{"capabilities": {"mode": "manual"}}

Режим продувки вкл/выкл (on/off) (прием от сервера, отправка на сервер)

Пример:
{"capabilities": {"blow": "on"}}

Состояние заслонки (0-3) (0 - открытие, 1 - открыта, 2 - закрывается, 3 - закрыта) (отправка на сервер)

Пример:
{"capabilities": {"stepper": 2}}

Яркость экрана, в процентах (5-100) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"disp_bright": 37}}

Режим автоматической яркости экрана вкл/выкл (on/off) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"disp_mode": "off"}}

Поворот экрана (0-3) (0 - портретный, 1 - портретный инвертированный, 2 - горизонтальный,
3 - горизонтальный инвертированный) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"disp_rotate": 2}}

Включение экрана при приеме команд от сервера вкл/выкл (on/off) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"disp_wakeup": "on"}}

Постоянно включенный экран вкл/выкл (on/off) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"always_on": "off"}}

Работа нагревателя вкл/выкл (on/off) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"heater_state": "on"}}

Время продувки, в минутах (1-10) (прием от сервера, отправка на сервер)

Пример:
{"settings": {"blow_time": 6}}

Наличие датчика co2 (on/off) (отправка на сервер)

Пример:
{"settings": {"sens_co2": "off"}}

Разные команды от одного объекта можно отправлять вместе

Пример:
{"settings": {"speed": 2, "heat": 11}}

Открытый API для интеграции приборов Vakio c системами умного дома (для работы прибору необходим доступ к интернету)

1. Загрузите приложение Vakio Smart Control с App Store или Google Play.
2. Зарегистрируйтесь и подтвердите Email.
3. Отправьте письмо на почту developer@vakio.ru с пометкой "Регистрация индивидуального API", в тексте укажите Email, имя и номер телeфона, которые относятся к этому аккаунту.
4. Мы вышлем вам данные для авторизации.

Адрес

POST https://api.vakio.ru/oauth/token

Заголовки

'Content-Type': 'application/json'

Тело

{
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "grant_type": "password",
  "username": "<you email>",
  "password": "<your password, not SHA1ed>"
}

Адрес

POST https://api.vakio.ru/oauth/token

Заголовки

'Content-Type': 'application/json'

Тело

{
  "client_id": "<client_id>",
  "client_secret": "<client_secret>",
  "grant_type": "refresh_token",
  "refresh_token": "<you refresh_token>"
}

Успешный ответ

{
  "access_token": "f33e31633a2d70c29ef13adef639c36dc1445a93",
  "expires_in": 86400,
  "token_type": "Bearer",
  "scope": null,
  "refresh_token": "24bbee6297ee59d3b25e145da758cdf2b6504f39f"
}

Адрес

GET https://api.vakio.ru/devices

Заголовки

'Content-Type': 'application/json'
'Authorization': 'Bearer <token>'

Успешный ответ

{
    "code": 200,
    "content": [
        {
            "id": 19,
            "device_name": "Мой прибор 1",
            "device_type": {
                "name": "Vakio Plus Series",
                "slug": "vakio-window-plus",
                "image": "https://connect.vakio.ru/wp-content/uploads/vakio-window-plus.jpg",
            },
            "device_group": "кухня",
            "capabilities": {
                "on_off": "off",
                "mode": "inflow",
                "speed": "5"
            },
            "properties": {
                *// Для устройств с датчиками (Atmosphere, Openair и др.)*
                "humidity": 24,
                "temperature": 345
            },
            "relation": {
                            "on_off_dependence":"<on/off>",
                            *// Для Atmosphere*
                            "dependence":{
                                "mode":"<inflow/outflow/recuperator>",
                                "device_id_master":"<device_id_master>",
                                "min_value":"<device_id_master>",
                                "step":"<device_id_master>",
                                "parametr":"<co2/temp/hud>"
                            }
                            *// Для Base Smart*
                            "dependence":{
                                "mode":"<sync/async>",
                                "device_id_master":"<device_id_master>",
                            }
                        },
            "verified": 1,
            "device_type_id": 2
        }
    ]
}

Адрес

POST https://api.vakio.ru/devices/{DEVICE_ID}

Заголовки

'Content-Type': 'application/json',
'Authorization': 'Bearer <token>',

Успешный ответ

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

Адрес

PUT https://api.vakio.ru/devices/{DEVICE_ID}

Заголовки

'Content-Type': 'application/json',
'Authorization': 'Bearer <token>',
},

Тело

{
  "capabilities": [
    {
      "instance": "mode",
      "value": "inflow"
    },
    {
      "instance": "speed",
      "value": "3"
    },
    {
      "instance": "on_off",
      "value": "on"
    }
  ]
}

Успешный ответ

{
  "code": 200,
  "content": "updated"
}

{
  "capabilities": [
    {
      "instance": "mode",
      "value": "inflow"
    }
  ]
}

1. Режимы Base Smart

   "inflow" - Приток

   "outflow" - Вытяжка

   "recuperator" - Рекуперация

   "inflow_max" - Максимальный приток

   "outflow_max" - Максимальная вытяжка

   "night" - Ночной режим

2. Скорости Base Smart -

   1 - 7

3. Вкл/ выкл Base Smart

   "on"/ "off"

Адрес

PUT https://api.vakio.ru/devices/{DEVICE_ID}

Заголовки

'Content-Type': 'application/json',
'Authorization': 'Bearer <token>',

Тело

{
  "capabilities": [
    {
      "instance": "mode",
      "value": "manual"
    },
    {
      "instance": "speed",
      "value": "3"
    },
    {
      "instance": "gate",
      "value": "1"
    },
    {
      "instance": "on_off",
      "value": "on"
    }
  ]
}

Успешный ответ

{
  "code": 200,
  "device": {
    // Информация об изменённом устройстве
  }
}

{
  "capabilities": [
    {
      "instance": "mode",
      "value": "manual"
    }
  ]
}

1. Режимы Openair

   "manual" - Режим ручного управления

   "smart_auto" - Smart-режим

2. Скорости Openair

   0 - 5

3. Положение заслонки Openair (доступно не на всех устройствах)

   1 - 4

   *доступно не на всех устройствах.

   **изменение положения заслонки не работает, если значение скорости больше 0.

4. Вкл/выкл Openair

   "on"/ "off"