- MQTT API
- REST API
- Интеграции с системами умных домов
- Home Assistant
- MajorDOMO
- Sprut.hub (от партнеров)
Подключение к локальному серверу 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
Открытый API для интеграции приборов Vakio c системами умного дома (для работы прибору необходим доступ к интернету)
- Загрузите приложение Vakio Smart Control с App Store или Google Play.
- Зарегистрируйтесь и подтвердите Email.
- Отправьте письмо на почту developer@vakio.ru с пометкой "Регистрация индивидуального API", в тексте укажите Email, имя и номер телeфона, которые относятся к этому аккаунту.
- Мы вышлем вам данные для авторизации.
Адрес
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": [],
"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"
}
]
}
- Режимы Base Smart
"inflow" - Приток
"outflow" - Вытяжка
"recuperator" - Рекуперация
"inflow_max" - Максимальный приток
"outflow_max" - Максимальная вытяжка
"night" - Ночной режим
- Скорости Base Smart -
1 - 7
- Вкл/ выкл Base Smart
"on"/ "off"