Node-RED Apple HomeKit: различия между версиями

Node-RED Apple HomeKit (просмотреть исходный код)

Версия 18:45, 18 апреля 2024

2695 байт добавлено ,  1 месяц назад
→‎Подготовка
 
(не показано 57 промежуточных версий 1 участника)
Строка 1: Строка 1:
{{DISPLAYTITLE: Настройка Apple HomeKit на контроллере Wiren Board}}
{{DISPLAYTITLE: Настройка Apple HomeKit на контроллере Wiren Board через Node-RED}}
{{Draft}}
[[Image:apple-home.png |300px|thumb|right| Список устройств в приложении Home ]]
[[Image:apple-home.png |300px|thumb|right| Список устройств в приложении Home ]]


== Описание ==
== Описание ==
Алиса — это программный фреймворк для умных устройств от Apple. Все добавленные устройства будут видны в приложении Home, что позволит вам управлять ими удалённо со своего iPhone и других устройств Apple.
В инструкции мы расскажем, как подключиться к [[Apple HomeKit]] с помощью Node-RED и модуля ''node-red-contrib-homekit-bridged''.


В инструкции используется модуль '''node-red-contrib-homekit-bridged''', поддержку которого осуществляет сообщество [https://t.me/SprutAI_NodeRED Node-RED].
Разработкой и поддержкой модуля занимается открытое сообщество пользователей [https://t.me/SprutAI_NodeRED Node-RED].


== Подготовка ==
== Подготовка ==
Для настройки моста Apple HomeKit на контроллере [[Wiren Board]] с помощью Node-RED нам понадобится:
Для настройки моста Apple HomeKit на контроллере [[Wiren Board]] с помощью Node-RED нам понадобится:
* установленный [[Node-Red | Node-RED]],
* установленный Node-RED совместимой версии и [[Node-Red | настроенный модуль WB Nodes]],
* настроенный модуль [[Node-Red#WB_Nodes |WB Nodes]],  
* модуль [https://flows.nodered.org/node/node-red-contrib-homekit-bridged node-red-contrib-homekit-bridged] — его мы установим ниже и для этого нам понадобится доступ в интернет,
* модуль [https://flows.nodered.org/node/node-red-contrib-homekit-bridged node-red-contrib-homekit-bridged] — его мы установим ниже,
* аккаунт iCloud и устройство Apple с приложением Home.
* аккаунт iCloud и мобильное приложение Home.
 
На контроллере должен быть доступ к интернету — HomeKit без него не работает.


{{Wbincludes:Node-RED Intro}}
{{Wbincludes:Node-RED Intro}}
Строка 27: Строка 23:
}}
}}


После установки, в левой панели появится секция ''alice''.
После установки, в левой панели появится группа ''Apple HomeKit''.


== Добавление устройства ==
== Добавление устройства ==
Строка 35: Строка 31:
# Прописываем логику, которое это устройство реализует, например, включение зуммера.
# Прописываем логику, которое это устройство реализует, например, включение зуммера.
# Публикуем флоу кнопкой ''Deploy''.
# Публикуем флоу кнопкой ''Deploy''.
# В мобильном приложении Home обновляем список устройств.
# Если мост уже добавлен в приложение Home, то устройство появится в нём автоматически.


В примере ниже мы добавим сенсор температуры процессора и переключатель, который будет управлять зуммером контроллера.
В примерах ниже мы настроим мост, а также добавим сенсор температуры процессора и переключатель, который будет управлять зуммером контроллера.


=== Настройка моста ===
=== Настройка моста ===
Строка 49: Строка 45:
# В окне '''Edit service node''' нажмите кнопку '''Cancel''' и удалите ноду с рабочей области.
# В окне '''Edit service node''' нажмите кнопку '''Cancel''' и удалите ноду с рабочей области.


Мост настроен, дальше можно добавлять устройства.
Мост настроен, дальше можно добавлять устройства. В процессе нужно учесть два момента:
# устройство HomeKit на вход принимает и отдаёт объект, который содержит имя характеристики и значение;
# WB ноды '''in''' и '''out''' отдают и принимают значения в виде строки.
 
Чтобы синхронизировать разные типы данных, мы будем создавать конвертеры значений.


<gallery mode="packed" heights="200px" caprion="Настройка моста">
<gallery mode="packed" heights="200px" caprion="Настройка моста">
Строка 59: Строка 59:
В примере мы настроим сенсор температуры HomeKit, который будет выводить температуру процессора.
В примере мы настроим сенсор температуры HomeKit, который будет выводить температуру процессора.


[[Image: 1. WB CPU Temp in HomeKit 1.png | 300px|thumb|right| Нода ''wb-in'', окно ''Edit in node'' ]]
Добавим ноду WB, которая будет выдавать CPU Temperature:
Добавим ноду WB, которая будет выдавать CPU Temperature:
# Перетяните в рабочую область ноду '''in''', которая находится слева в группе '''Wiren Board'''.
{{Node-RED Tuning wb-in
# Дважды кликните на ней — откроется окно '''Edit in node''', где укажите:
| name = CPU Temp
#* Name — имя, например, CPU Temp.
| mqtt-topic = hwmon/CPU Temperature
#* Server — MQTT-сервер, связь с которым настраивается при установке модуля ''WB Nodes''.
}}
#* Channel — выберите в открывшемся списке mqtt-топик '''hwmon/CPU Temperature'''. Если список пуст, нажмите кнопку ''Refresh Device List''.
# Чтобы сохранить, нажмите кнопку '''Done'''.


Настроим конвертер сообщений:
[[Image: 1. WB CPU Temp in HomeKit 2.png | 300px|thumb|right| Конвертер ''to Float'' ]]
# Перетяните в рабочую область ноду '''function''', которая находится слева в группе '''function'''.
Настроим конвертер, который преобразует значение ''CPU Temperature'' в объект ''HomeKit'':
# Дважды кликните на ней — откроется окно '''Edit function node''' и впишите в поле '''onMessage''' код:
{{Node-RED Tuning function
#<syntaxhighlight lang="js">
|name = to Float
|code = <syntaxhighlight lang="js">
msg.payload = {'CurrentTemperature': parseFloat(msg.payload)};
msg.payload = {'CurrentTemperature': parseFloat(msg.payload)};


return msg;
return msg;
</syntaxhighlight>
</syntaxhighlight>
# Укажите имя в поле '''Name''', например, ''to Float''.
}} Конвертер готов.
# Нажмите кнопку '''Done'''. Конвертер готов.


''CurrentTemperature'' — это имя характеристики, взято из [https://developer.apple.com/documentation/homekit/hmcharacteristic/characteristic_types документации Apple HomeKit].
''CurrentTemperature'' — это имя характеристики, взято из [https://developer.apple.com/documentation/homekit/hmcharacteristic/characteristic_types документации Apple HomeKit].


Добавим ноду HomeKit типа Service:
[[Image: 1. WB CPU Temp in HomeKit 3.png | 300px|thumb|right| Настройка устройства HomeKit]]
Добавим ноду HomeKit, которая создаст виртуальное устройство:
# Перетяните в рабочую область ноду '''service''', которая находится слева в группе '''Apple HomeKit'''.
# Перетяните в рабочую область ноду '''service''', которая находится слева в группе '''Apple HomeKit'''.
# Дважды кликните на ней — откроется окно '''Edit service node''', где:
# Дважды кликните по ней — откроется окно '''Edit service node''', где:
#* в поле '''Service''' выберите '''TemperatureSensor''',
#* в поле '''Service''' выберите '''TemperatureSensor''',
#* в поле '''Bridge''' выберите мост, который мы создавали ранее — ''wb-demo''.
#* в поле '''Bridge''' выберите мост, который мы создавали ранее — ''wb-demo''.
Строка 88: Строка 88:
# Нажмите кнопку '''Done'''.
# Нажмите кнопку '''Done'''.


У нас получилось три ноды, соедините их между собой: CPU Temp (WB) → to Float → CPU Temp (HK).
У нас получилось три ноды, соедините их между собой: CPU Temp (wb-in) → to Float → CPU Temp (HK).
 
[[Image: 1. WB CPU Temp in HomeKit 4.png | Общий вид флоу]]


Чтобы изменения вступили в силу, нажмите справа вверху страницы кнопку '''Deploy'''.
Чтобы изменения вступили в силу, нажмите справа вверху страницы кнопку '''Deploy'''.


<gallery mode="packed" heights="100px" caption="Настройка датчика температуры">
=== Устройство с управлением ===
Image: 1. WB CPU Temp in HomeKit 1.png | Окно ''Edit in node''
Теперь настроим переключатель HomeKit, который будет управлять устройством Buzzer.
Image: 1. WB CPU Temp in HomeKit 2.png | Конвертер
 
Image: 1. WB CPU Temp in HomeKit 3.png | Настройка устройства KomeKit
[[Image: 2. WB Buzzer in HomeKit 1.png | 300px|thumb|right| Нода ''wb-in'', окно ''Edit in node'' ]]
Image: 1. WB CPU Temp in HomeKit 4.png | Общий вид флоу
Добавим ноду WB, которая будет выдавать состояние Buzzer:
</gallery>
{{Node-RED Tuning wb-in
| name = Buzzer
| mqtt-topic = buzzer/enabled
}}
 
[[Image: 2. WB Buzzer in HomeKit 2.png | 300px|thumb|right| Конвертер ''true/false'' ]]
Настроим конвертер, который преобразует состояние ''Buzzer'' в объект ''HomeKit'':
{{Node-RED Tuning function
|name = true/false
|code = <syntaxhighlight lang="js">
msg.payload = (msg.payload == '1') ? {'On':true} : {'On':false};
 
return msg
</syntaxhighlight>
}} Конвертер готов.
 
[[Image: 2. WB Buzzer in HomeKit 3.png | 300px|thumb|right| Настройка устройства HomeKit ]]
Добавим ноду HomeKit, которая создаст виртуальное устройство:
# Перетяните в рабочую область ноду '''service''', которая находится слева в группе '''Apple HomeKit'''.
# Дважды кликните по ней — откроется окно '''Edit service node''', где:
#* в поле '''Service''' выберите '''Switch''',
#* в поле '''Bridge''' выберите мост, который мы создавали ранее — ''wb-demo''.
#* укажите имя в поле '''Name''', например, ''Buzzer''.
# Нажмите кнопку '''Done'''.
 
[[Image: 2. WB Buzzer in HomeKit 4.png | 300px|thumb|right| Конвертер ''1/0'' ]]
Настроим конвертер, который преобразует объект ''HomeKit'' в состояние ''Buzzer'':
{{Node-RED Tuning function
|name = 1/0
|code = <syntaxhighlight lang="js">
msg.payload = (msg.payload.On) ? '1' : '0';
 
return msg
</syntaxhighlight>
}} Конвертер готов.
 
[[Image: 2. WB Buzzer in HomeKit 5.png | 300px|thumb|right| Нода ''wb-out'' ]]
Добавим ещё одну ноду WB, которая будет устанавливать состояние Buzzer:
{{Node-RED Tuning wb-out
|name = Buzzer
|mqtt-topic = buzzer/enabled
}}
 
У нас получилось пять нод, соедините их между собой: Buzzer (wb-in) → true/false → Buzzer (HK) → 1/0 → Buzzer (wb-out).


=== Устройство с управлением ===
[[Image: 2. WB Buzzer in HomeKit 6.png | Общий вид флоу]]


Чтобы изменения вступили в силу, нажмите справа вверху страницы кнопку '''Deploy'''.


== Настройка в Phone ==
== Настройка в устройстве Apple ==
{{Wbincludes:Apple HomeKit Tunning iPhone}}


== Полезные ссылки ==
== Полезные ссылки ==
*
* [[Media: Apple HomeKit DemoFlow.zip | Пример флоу из инструкции ]], замените пин-код в настройках моста.
* [https://developer.apple.com/homekit/ Документация Apple HomeKit]
* [https://developer.apple.com/documentation/homekit/hmcharacteristic/characteristic_types Список доступных характеристик Apple HomeKit]
Brainroot
wb_editors
890

правок

Источник — https://wirenboard.com/wiki/Служебная:Сравнение_версий/61913...80447