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

Материал из Wiren Board
(не показано 10 промежуточных версий 3 участников)
Строка 1: Строка 1:
<languages/><translate>
<languages/><translate>
<!--T:19-->
<!--T:19-->
Строка 17: Строка 18:
{{Wbincludes:Installing Software In Console}}
{{Wbincludes:Installing Software In Console}}


== Установка ==  <!--T:23-->


{{Wbincludes:Installing Software In Console Catalog And Update}}


{{Wbincludes:Installing Software In Console}}
== Установка ==  <!--T:23-->
Для установки Node-RED на контроллер Wiren Board подключитесь к нему по [[SSH]] и введите в консоль несколько команд.


<!--T:24-->
# Установите docker по [[docker | инструкции]].
Установите необходимые компоненты:
# Создайте каталог под служебные файлы:
<syntaxhighlight lang="bash">
#:<syntaxhighlight lang="bash">
apt update && apt install -y nodejs git make g++ gcc build-essential
mkdir /mnt/data/root/nodered
chown -R 1000:1000 /mnt/data/root/nodered
chmod -R 777 /mnt/data/root/nodered
</syntaxhighlight>
</syntaxhighlight>
 
# Запустите образ nodered — docker автоматически загрузит его из интернет и запустит:
<!--T:25-->
#:<syntaxhighlight lang="bash">
Запустите установку Node-RED:
docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host nodered/node-red
:<syntaxhighlight lang="bash">
npm install -g --unsafe-perm node-red
</syntaxhighlight>
</syntaxhighlight>


<!--T:26-->
После установки и запуска, откройте браузер и введите [[How_to_find_IP_address | адрес своего контроллера]] в сети и порт 1880. Например: http://192.168.42.1:1880 Консоль можно закрыть.
Если потребуется обновить версию Node-RED, выполните команду установки ещё раз.


В релизах wb-2207 и старее устаревшая версия NodeJS, поэтому свежий Node-RED можно поставить только в docker — [[Node-RED_docker|инструкция по установке Node-RED в docker]].
==Веб-интерфейс Node-RED== <!--T:40-->
Также в docker следует устанавливать если требуется версия более новая чем из пакетов.
После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880.  
Например: http://192.168.42.1:1880


== Создание сервиса == <!--T:27-->  
<!--T:41-->
Инструкции по работе c Node-RED можно найти на [https://nodered.org/docs/getting-started/ сайте nodered.org]


<!--T:28-->
== WB Nodes ==  <!--T:42-->
Для автозапуска Node-RED необходимо настроить сервис. Для этого в папке <code>/etc/systemd/system/</code> создайте файл <code>nodered.service</code>:
[[Файл:Installing node-red-contrib-wirenboard.PNG|500px|thumb|right| Установка WB Nodes на контроллер Wiren Board]]
[[Image: nr+wb-settings.png |600px|thumb|right|Настройка соединения с контроллером Wiren Board]]
Чтобы упростить взаимодействие Node-RED с контроллером Wiren Board, пользователь [https://support.wirenboard.com/t/node-red-contrib-wirenboard/2019 Andrej_Popov] написал модуль <code>node-red-contrib-wirenboard</code>.


<!--T:29-->
=== Установка === <!--T:43-->
<syntaxhighlight lang="bash">
Установим его через веб-интерфейс Node-RED:
nano /etc/systemd/system/nodered.service
{{Node-RED Installing plugin
</syntaxhighlight>
|search= wirenboard
|name= node-red-contrib-wirenboard
}}


<!--T:30-->
После установки, в левой панели появится секция Wiren Board.
Затем вставьте в этот файл строки:
<pre>
[Unit]
Description=Node-RED graphical event wiring tool
Wants=network.target


<!--T:31-->
=== Настройка === <!--T:44-->
[Service]
После того как вы установили WB Nodes, вам нужно настроить соединение с MQTT-брокером контроллера Wiren Board:
Type=simple
# Добавьте в рабочую область ноду '''WB-input''', которая находится в левой панели, в секции '''Wiren Board'''.
User=root
# Дважды кликните на ней, откроется окно '''Edit in node'''.
Group=root
# Найдите в нём поле '''Server''' и нажмите на кнопку с карандашом. Откроется окно '''Add new wirenboard-server config node'''.
WorkingDirectory=/home
# Заполните поля '''Name''', '''Host''' и '''MQTT Port'''. Если Node-RED установлен на контроллере — в поле Host пропишите <code>localhost</code>. В поле '''Name''' укажите произвольное имя, а в поле '''MQTT Port''' — 1883.
# Сохраните настройки сервера нажатием на кнопку '''Done'''.
# Закройте окно '''Edit in node''' нажатием на '''Cancel'''.
{{note|info| После настройки подключения, примените настройку сервера нажатием кнопки '''Deploy''' справа вверху. Только после этого будет доступен список каналов контроллера Wiren Board.}}


<!--T:32-->
<!--T:45-->
Nice=5
Вы настроили WB Nodes и можете писать автоматизации с использованием Node-RED.
Environment="NODE_OPTIONS=--max_old_space_size=256"
ExecStart=/usr/bin/env node-red $NODE_OPTIONS $NODE_RED_OPTIONS
KillSignal=SIGINT
Restart=on-failure
SyslogIdentifier=Node-RED


<!--T:33-->
=== Проверка настроек === <!--T:46-->
[Install]
Чтобы проверить правильность настроек:
WantedBy=multi-user.target
# Добавьте в рабочую область любую ноду из группы Wiren Board, например, '''WB-input'''.
</pre>
# Дважды кликните на ноде '''WB-input''', откроется окно '''Edit in node'''.
# В окне '''Edit in node''' нажмите кнопку '''Refresh Device List'''.


<!--T:34-->
<!--T:47-->
Сохраните изменения и закройте файл. Теперь включите сервис и запустите его командой:
Если соединение настроено верно, то в выпадающем списке поля '''Сhannel''' появится список доступных для использования каналов.
 
=== Примеры === <!--T:48-->
В комплекте с WB-Nodes есть примеры для [[Node-RED Apple HomeKit | Apple HomeKit]] и Яндекс.Алисы, найти их можно в '''Menu''' → '''Import''' → '''Examples'''.
<gallery mode="packed" heights="200px" caption="Примеры из комплекта WB-Nodes">
Image: WB-Nodes Examples 1.png | Список примеров
Image: WB-Nodes Examples 2.png | Пример в рабочей области
</gallery>


<!--T:35-->
=== Решение проблем ===
Иногда, если во флоу есть ошибка, то веб-интерфейс Node-RED может перестать загружаться, в этом случае нужно подключиться к контроллеру по [[SSH]] и посмотреть логи контейнера nodered.
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
systemctl enable nodered && systemctl start nodered
docker logs nodered
</syntaxhighlight>
</syntaxhighlight>


<!--T:36-->
Если в логах будет видна ошибка во флоу, то надо пересоздать контейнер с safe-запуском:
Проверьте статус сервиса командой, в выводе должна быть строчка <code>Active: active (running)</code>:
#
<syntaxhighlight lang="console">
# Остановить службу, если она запущена:
# systemctl status nodered
#: <syntaxhighlight lang="bash">
● nodered.service - Node-RED graphical event wiring tool
docker stop nodered ; docker rm nodered && docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host --entrypoint "/bin/bash" nodered/node-red -c 'npm start -- --userDir /data --safe'
  Loaded: loaded (/etc/systemd/system/nodered.service; enabled; vendor preset: enabled)
  Active: active (running) since Fri 2021-12-03 06:32:25 UTC; 24s ago
Main PID: 2757 (node)
  CGroup: /system.slice/nodered.service
          └─2757 node /usr/bin/node-red --max_old_space_size=256
 
<!--T:37-->
Dec 03 06:32:25 wirenboard-AWQBNTYP systemd[1]: Started Node-RED graphical event wiring tool.
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: 3 Dec 06:32:36 - [info]
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: Welcome to Node-RED
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: ===================
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: 3 Dec 06:32:36 - [info] Node-RED version: v2.1.4
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: 3 Dec 06:32:36 - [info] Node.js  version: v12.19.0
Dec 03 06:32:36 wirenboard-AWQBNTYP Node-RED[2757]: 3 Dec 06:32:36 - [info] Linux 5.10.35-wb6 arm LE
Dec 03 06:32:41 wirenboard-AWQBNTYP Node-RED[2757]: 3 Dec 06:32:41 - [info] Loading palette nodes
</syntaxhighlight>
</syntaxhighlight>
 
# После этой команды Node-Red запустится в безопасном режиме и не запустит деплой при старте. После исправления ошибки надо снова пересоздать контейнер с правильной командой.
== Удаление == <!--T:38-->
#: <syntaxhighlight lang="bash">
Если вам больше не нужен Node-RED, то его можно удалить:
docker stop nodered ; docker rm nodered && docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host nodered/node-red  
# Остановите, отключите и удалите сервис:
#:<syntaxhighlight lang="bash">
systemctl stop nodered && systemctl disable nodered && rm /etc/systemd/system/nodered.service
</syntaxhighlight>
# Удалите сам Node-RED:
#:<syntaxhighlight lang="bash">
npm -g remove node-red && npm -g remove node-red-admin && rm -R ~/.node-red
</syntaxhighlight>
 
<!--T:39-->
Node.js, тоже можно удалить, но убедитесь, что у вас не установлены другие програмы, которые его используют, например, zigbee2mqtt. Чтобы удалить node.js, выполните команду:
:<syntaxhighlight lang="bash">
apt remove nodejs
</syntaxhighlight>
</syntaxhighlight>


==Веб-интерфейс Node-RED== <!--T:40-->
== Использование нод ''mqtt in'' и ''mqtt out'' для взаимодействия с Wiren Board == <!--T:49-->
После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880.
Например: http://192.168.42.1:1880
 
<!--T:41-->
Инструкции по работе c Node-RED можно найти на [https://nodered.org/docs/getting-started/ сайте nodered.org]
 
== Ноды ''mqtt in'' и ''mqtt out'' (рекомендуется) == <!--T:49-->
=== Настройка подключения ===
=== Настройка подключения ===
[[Image: NodeRed_mqtt_nodes.jpg |300px|thumb|right| Ноды MQTT в Node-Red ]]
[[Image: NodeRed_mqtt_nodes.jpg |300px|thumb|right| Ноды MQTT в Node-Red ]]
Для работы по MQTT используются ноды '''mqtt in''' и  '''mqtt out'''. Также вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице [[Wiren Board Web Interface#mqtt-channels |MQTT-каналы]].
Альтернативный вариант — использовать ноды '''mqtt in''' и  '''mqtt out'''. Для этого вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице [[Wiren Board Web Interface#mqtt-channels |MQTT-каналы]].


<!--T:50-->
<!--T:50-->
Строка 182: Строка 154:
Image: NodeRed_mqtt5.jpg | Пример управления с помощью Алисы
Image: NodeRed_mqtt5.jpg | Пример управления с помощью Алисы
</gallery>
</gallery>
== WB Nodes (решение сообщества) ==  <!--T:42-->
[[Файл:Installing node-red-contrib-wirenboard.PNG|500px|thumb|right| Установка WB Nodes на контроллер Wiren Board]]
[[Image: nr+wb-settings.png |600px|thumb|right|Настройка соединения с контроллером Wiren Board]]
Чтобы упростить взаимодействие Node-RED с контроллером Wiren Board, пользователь [https://support.wirenboard.com/t/node-red-contrib-wirenboard/2019 Andrej_Popov] написал модуль <code>node-red-contrib-wirenboard</code>.
=== Установка === <!--T:43-->
Установим его через веб-интерфейс Node-RED:
{{Node-RED Installing plugin
|search= wirenboard
|name= node-red-contrib-wirenboard
}}
После установки, в левой панели появится секция Wiren Board.
=== Настройка === <!--T:44-->
После того как вы установили WB Nodes, вам нужно настроить соединение с MQTT-брокером контроллера Wiren Board:
# Добавьте в рабочую область ноду '''WB-input''', которая находится в левой панели, в секции '''Wiren Board'''.
# Дважды кликните на ней, откроется окно '''Edit in node'''.
# Найдите в нём поле '''Server''' и нажмите на кнопку с карандашом. Откроется окно '''Add new wirenboard-server config node'''.
# Заполните поля '''Name''', '''Host''' и '''MQTT Port'''. Если Node-RED установлен на контроллере — в поле Host пропишите <code>localhost</code>. В поле '''Name''' укажите произвольное имя, а в поле '''MQTT Port''' — 1883.
# Сохраните настройки сервера нажатием на кнопку '''Done'''.
# Закройте окно '''Edit in node''' нажатием на '''Cancel'''.
{{note|info| После настройки подключения, примените настройку сервера нажатием кнопки '''Deploy''' справа вверху. Только после этого будет доступен список каналов контроллера Wiren Board.}}
<!--T:45-->
Вы настроили WB Nodes и можете писать автоматизации с использованием Node-RED.
=== Проверка настроек === <!--T:46-->
Чтобы проверить правильность настроек:
# Добавьте в рабочую область любую ноду из группы Wiren Board, например, '''WB-input'''.
# Дважды кликните на ноде '''WB-input''', откроется окно '''Edit in node'''.
# В окне '''Edit in node''' нажмите кнопку '''Refresh Device List'''.
<!--T:47-->
Если соединение настроено верно, то в выпадающем списке поля '''Сhannel''' появится список доступных для использования каналов.
=== Примеры === <!--T:48-->
В комплекте с WB-Nodes есть примеры для [[Node-RED Apple HomeKit | Apple HomeKit]] и Яндекс.Алисы, найти их можно в '''Menu''' → '''Import''' → '''Examples'''.
<gallery mode="packed" heights="200px" caption="Примеры из комплекта WB-Nodes">
Image: WB-Nodes Examples 1.png | Список примеров
Image: WB-Nodes Examples 2.png | Пример в рабочей области
</gallery>
=== Решение проблем ===
Иногда, если во флоу есть ошибка, то веб-интерфейс Node-RED может перестать загружаться, в этом случае нужно проверить  логи сервиса nodered.
Если в логах будет видна ошибка во флоу, то:
# Подключиться к контроллеру по [[SSH]].
# Остановить службу, если она запущена:
#: <syntaxhighlight lang="bash">
systemctl stop nodered
</syntaxhighlight>
# Запустить Node-RED в безопасном режиме:
#: <syntaxhighlight lang="bash">
node-red --safe
</syntaxhighlight>
# Установить проблему и остановить запущенный в безопасном режиме Node-RED.
# Снова запустить сервис:
#: <syntaxhighlight lang="bash">
systemctl start nodered
</syntaxhighlight>
Если вы ставили Node-RED в docker, воспользуйтесь инструкцией на странице [[Node-RED_docker|Установка Node-RED в docker]].


== Примеры использования == <!--T:55-->
== Примеры использования == <!--T:55-->

Версия 12:24, 28 марта 2023

Другие языки:
Node-RED на контроллере Wiren Board

Описание

Видеоурок по Node-RED на Wiren Board от SetPoint

Node-RED — это инструмент визуального программирования, основанный на Node.js и который разрабатывается и поддерживается открытым сообществом.

Подробное описание, инструкции и примеры использования можно найти на сайте nodered.org, а поддержку сообщества в телеграм-канале Node-RED.

Копируйте команды из инструкции, вставляйте их в консоль контроллера с помощью клавиш Shift+Insert и запускайте клавишей Enter. В случае ошибок, внимательно читайте вывод, там будут инструкции и подсказки.


Установка

Для установки Node-RED на контроллер Wiren Board подключитесь к нему по SSH и введите в консоль несколько команд.

  1. Установите docker по инструкции.
  2. Создайте каталог под служебные файлы: 
    mkdir /mnt/data/root/nodered
chown -R 1000:1000 /mnt/data/root/nodered
chmod -R 777 /mnt/data/root/nodered
  3. Запустите образ nodered — docker автоматически загрузит его из интернет и запустит: 
    docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host nodered/node-red

После установки и запуска, откройте браузер и введите адрес своего контроллера в сети и порт 1880. Например: http://192.168.42.1:1880 Консоль можно закрыть.

Веб-интерфейс Node-RED

После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880. Например: http://192.168.42.1:1880

Инструкции по работе c Node-RED можно найти на сайте nodered.org

WB Nodes

Установка WB Nodes на контроллер Wiren Board
Настройка соединения с контроллером Wiren Board

Чтобы упростить взаимодействие Node-RED с контроллером Wiren Board, пользователь Andrej_Popov написал модуль node-red-contrib-wirenboard.

Установка

Установим его через веб-интерфейс Node-RED:

  1. Зайдите в веб-интерфейс Node-RED.
  2. В правом верхнем углу вызовите меню.
  3. В открывшемся окне выберите вкладку Управление палитрой (Manager palette).
  4. Перейдите на вкладку Установка (Install), введите в поле поиска wirenboard и нажмите на клавиатуре Enter.
  5. Установите пакет с названием node-red-contrib-wirenboard.
  6. Закройте окно с настройками. Установка модуля завершена.

После установки, в левой панели появится секция Wiren Board.

Настройка

После того как вы установили WB Nodes, вам нужно настроить соединение с MQTT-брокером контроллера Wiren Board:

  1. Добавьте в рабочую область ноду WB-input, которая находится в левой панели, в секции Wiren Board.
  2. Дважды кликните на ней, откроется окно Edit in node.
  3. Найдите в нём поле Server и нажмите на кнопку с карандашом. Откроется окно Add new wirenboard-server config node.
  4. Заполните поля Name, Host и MQTT Port. Если Node-RED установлен на контроллере — в поле Host пропишите localhost. В поле Name укажите произвольное имя, а в поле MQTT Port — 1883.
  5. Сохраните настройки сервера нажатием на кнопку Done.
  6. Закройте окно Edit in node нажатием на Cancel.

После настройки подключения, примените настройку сервера нажатием кнопки Deploy справа вверху. Только после этого будет доступен список каналов контроллера Wiren Board.

Вы настроили WB Nodes и можете писать автоматизации с использованием Node-RED.

Проверка настроек

Чтобы проверить правильность настроек:

  1. Добавьте в рабочую область любую ноду из группы Wiren Board, например, WB-input.
  2. Дважды кликните на ноде WB-input, откроется окно Edit in node.
  3. В окне Edit in node нажмите кнопку Refresh Device List.

Если соединение настроено верно, то в выпадающем списке поля Сhannel появится список доступных для использования каналов.

Примеры

В комплекте с WB-Nodes есть примеры для Apple HomeKit и Яндекс.Алисы, найти их можно в Menu → Import → Examples.

  • Примеры из комплекта WB-Nodes

  • Список примеров

  • Пример в рабочей области

Решение проблем

Иногда, если во флоу есть ошибка, то веб-интерфейс Node-RED может перестать загружаться, в этом случае нужно подключиться к контроллеру по SSH и посмотреть логи контейнера nodered. 

docker logs nodered

Если в логах будет видна ошибка во флоу, то надо пересоздать контейнер с safe-запуском:

  2. Остановить службу, если она запущена: 
    docker stop nodered ; docker rm nodered && docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host --entrypoint "/bin/bash" nodered/node-red -c 'npm start -- --userDir /data --safe'
  3. После этой команды Node-Red запустится в безопасном режиме и не запустит деплой при старте. После исправления ошибки надо снова пересоздать контейнер с правильной командой. 
    docker stop nodered ; docker rm nodered && docker run -d --name nodered --privileged --restart=unless-stopped -e TZ=Europe/Moscow -v /mnt/data/root/nodered:/data -e NODE_OPTIONS="--max_old_space_size=256"  --network=host nodered/node-red

Использование нод mqtt in и mqtt out для взаимодействия с Wiren Board

Настройка подключения

Ноды MQTT в Node-Red

Альтернативный вариант — использовать ноды mqtt in и mqtt out. Для этого вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице MQTT-каналы.

Для настройки MQTT-соединения в Node-RED выполните следующие действия:

  1. Перетащите ноду mqtt in в рабочую область.
  2. Войдите в конфигурацию ноды и нажмите на Карандаш напротив поля Server.
  3. На вкладке Connecting задайте адрес брокера и номер порта.
    В поле Name введите любое имя сервера.
    На вкладке Security можно указать Имя пользователя и Пароль для подключения к брокеру. Если в качестве брокера выступает контроллер Wiren Board, это поле нужно оставить пустым.
  4. После заполнения всех полей нажмите кнопку Update. Созданный брокер теперь можно использовать для настройки всех подключений.
  5. Выберите созданные брокер из списка в поле Server.
  6. Введите адрес mqtt-топика в поле Topic.
  7. Нажмите кнопку Done.

По такому же принципу настраивается нода mqtt out.

  • Настройка MQTT-брокера (Server)

  • Вкладка Connecting

  • Вкладка Security

Отправка команд

Для отправки команды контроллеру по MQTT используется нода mqtt out. При этом в поле Topic указывается адрес mqtt-топика контроллера, в который необходимо записать параметр. Нужно учитывать, что в конце адреса ноды mqtt out нужно написать /on, иначе параметр в топик не запишется. Например, /devices/wb-mrgbw-d-fw3_129/controls/RGB Strip/on. Подробнее читайте на странице MQTT.

  • Настройка нод для работы с MQTT

  • Пример настройки ноды mqtt in

  • Пример настройки ноды mqtt out

  • Обмен данными через MQTT в Node-Red

Для отправки параметра в ноду mqtt out можно использовать ноду inject.

  1. Перетащите ноду inject в рабочую область.
  2. Подключите ее ко входу ноды mqtt out.
  3. Зайдите в настройки ноды inject и задайте Имя ноды, Тип переменной и ее Значение. Нажмите кнопку Done.

  • Пример настроек ноды inject для управления дискретным параметром

  • Поле настройки периодов повторения отправки ноды inject

  • Пример использования ноды inject

После настройки ввода и вывода можно обрабатывать данные внутри Node-RED и настроить использование сторонних сервисов, например, Умный дом с Алисой.

  • Пример управления с помощью Алисы

Примеры использования

Примеры использования Node-RED с WB-Nodes на контроллерах Wiren Board:

Источник — https://wirenboard.com/wiki/index.php?title=Node-RED&oldid=72516