Node-RED: различия между версиями
(Прибил гвоздями версию 3.1.11) |
|||
(не показаны 4 промежуточные версии 2 участников) | |||
Строка 32: | Строка 32: | ||
Запустите установку Node-RED: | Запустите установку Node-RED: | ||
:<syntaxhighlight lang="bash"> | :<syntaxhighlight lang="bash"> | ||
npm install -g --unsafe-perm node-red | npm install -g --unsafe-perm node-red | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Строка 39: | Строка 39: | ||
В релизах wb-2207 и старее устаревшая версия NodeJS, поэтому свежий Node-RED можно поставить только в docker — [[Node-RED_docker|инструкция по установке Node-RED в docker]]. | В релизах wb-2207 и старее устаревшая версия NodeJS, поэтому свежий Node-RED можно поставить только в docker — [[Node-RED_docker|инструкция по установке Node-RED в docker]]. | ||
== Создание сервиса == <!--T:27--> | == Создание сервиса == <!--T:27--> | ||
Строка 135: | Строка 134: | ||
=== Настройка подключения === | === Настройка подключения === | ||
[[Image: NodeRed_mqtt_nodes.jpg |300px|thumb|right| Ноды MQTT в Node-Red ]] | [[Image: NodeRed_mqtt_nodes.jpg |300px|thumb|right| Ноды MQTT в Node-Red ]] | ||
Альтернативный вариант — использовать ноды '''mqtt in''' и '''mqtt out'''. Для этого вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице [[Wiren Board Web Interface#mqtt-channels |MQTT-каналы]]. | |||
<!--T:50--> | <!--T:50--> |
Версия 08:35, 7 июля 2023
Описание
Node-RED — это инструмент визуального программирования, основанный на Node.js и который разрабатывается и поддерживается открытым сообществом.
Подробное описание, инструкции и примеры использования можно найти на сайте nodered.org, а поддержку сообщества в телеграм-канале Node-RED.
Копируйте команды из инструкции, вставляйте их в консоль контроллера с помощью клавиш Shift+Insert и запускайте клавишей Enter. В случае ошибок, внимательно читайте вывод, там будут инструкции и подсказки.
Установка
Чтобы не потерять установленный софт и его данные, обновляйте ПО контроллера только через менеджер пакетов apt. Подробнее читайте в статье Программное обеспечение Wiren Board.
Встроенный флеш-накопитель контроллера разбит на разделы и для пользователя отведён самый большой из них, который монтируется в папку /mnt/data
. Нужно учесть эту особенность при установке программ, а также при обновлении прошивки контроллера.
Копируйте команды из инструкции, вставляйте их в консоль контроллера с помощью клавиш Shift+Insert и запускайте клавишей Enter. В случае ошибок, внимательно читайте вывод, там будут инструкции и подсказки.
Установите необходимые компоненты:
apt update && apt install -y nodejs git make g++ gcc build-essential
Запустите установку Node-RED:
npm install -g --unsafe-perm node-red
Если потребуется обновить версию Node-RED, выполните команду установки ещё раз.
В релизах wb-2207 и старее устаревшая версия NodeJS, поэтому свежий Node-RED можно поставить только в docker — инструкция по установке Node-RED в docker.
Создание сервиса
Для автозапуска Node-RED необходимо настроить сервис. Для этого в папке /etc/systemd/system/
создайте файл nodered.service
:
nano /etc/systemd/system/nodered.service
Затем вставьте в этот файл строки:
[Unit] Description=Node-RED graphical event wiring tool Wants=network.target [Service] Type=simple User=root Group=root WorkingDirectory=/home Nice=5 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 [Install] WantedBy=multi-user.target
Сохраните изменения и закройте файл. Теперь включите сервис и запустите его командой:
systemctl enable nodered && systemctl start nodered
Проверьте статус сервиса командой, в выводе должна быть строчка Active: active (running)
:
# systemctl status nodered
● nodered.service - Node-RED graphical event wiring tool
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
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
Удаление
Если вам больше не нужен Node-RED, то его можно удалить:
- Остановите, отключите и удалите сервис:
systemctl stop nodered && systemctl disable nodered && rm /etc/systemd/system/nodered.service
- Удалите сам Node-RED:
npm -g remove node-red && npm -g remove node-red-admin && rm -R ~/.node-red
Node.js, тоже можно удалить, но убедитесь, что у вас не установлены другие програмы, которые его используют, например, zigbee2mqtt. Чтобы удалить node.js, выполните команду:
apt remove nodejs
Веб-интерфейс Node-RED
После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880. Например: http://192.168.42.1:1880
Инструкции по работе c Node-RED можно найти на сайте nodered.org
Ноды mqtt in и mqtt out (рекомендуется)
Настройка подключения
Альтернативный вариант — использовать ноды mqtt in и mqtt out. Для этого вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице MQTT-каналы.
Для настройки MQTT-соединения в Node-RED выполните следующие действия:
- Перетащите ноду mqtt in в рабочую область.
- Войдите в конфигурацию ноды и нажмите на Карандаш напротив поля Server.
- На вкладке Connecting задайте адрес брокера и номер порта.
- В поле Name введите любое имя сервера.
- На вкладке Security можно указать Имя пользователя и Пароль для подключения к брокеру. Если в качестве брокера выступает контроллер Wiren Board, это поле нужно оставить пустым.
- После заполнения всех полей нажмите кнопку Update. Созданный брокер теперь можно использовать для настройки всех подключений.
- Выберите созданные брокер из списка в поле Server.
- Введите адрес mqtt-топика в поле Topic.
- Нажмите кнопку Done.
По такому же принципу настраивается нода mqtt out.
- Настройка MQTT-брокера (Server)
Отправка команд
Для отправки команды контроллеру по MQTT используется нода mqtt out. При этом в поле Topic указывается адрес mqtt-топика контроллера, в который необходимо записать параметр. Нужно учитывать, что в конце адреса ноды mqtt out нужно написать /on
, иначе параметр в топик не запишется. Например, /devices/wb-mrgbw-d-fw3_129/controls/RGB Strip/on
. Подробнее читайте на странице MQTT.
- Настройка нод для работы с MQTT
Для отправки параметра в ноду mqtt out можно использовать ноду inject.
- Перетащите ноду inject в рабочую область.
- Подключите ее ко входу ноды mqtt out.
- Зайдите в настройки ноды inject и задайте Имя ноды, Тип переменной и ее Значение. Нажмите кнопку Done.
После настройки ввода и вывода можно обрабатывать данные внутри Node-RED и настроить использование сторонних сервисов, например, Умный дом с Алисой.
WB Nodes (решение сообщества)
Чтобы упростить взаимодействие Node-RED с контроллером Wiren Board, пользователь Andrej_Popov написал модуль node-red-contrib-wirenboard
.
Установка
Установим его через веб-интерфейс Node-RED:
- Зайдите в веб-интерфейс Node-RED.
- В правом верхнем углу вызовите меню.
- В открывшемся окне выберите вкладку Управление палитрой (Manager palette).
- Перейдите на вкладку Установка (Install), введите в поле поиска wirenboard и нажмите на клавиатуре Enter.
- Установите пакет с названием node-red-contrib-wirenboard.
- Закройте окно с настройками. Установка модуля завершена.
После установки, в левой панели появится секция Wiren Board.
Настройка
После того как вы установили 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 пропишите
localhost
. В поле Name укажите произвольное имя, а в поле MQTT Port — 1883. - Сохраните настройки сервера нажатием на кнопку Done.
- Закройте окно Edit in node нажатием на Cancel.
После настройки подключения, примените настройку сервера нажатием кнопки Deploy справа вверху. Только после этого будет доступен список каналов контроллера Wiren Board.
Вы настроили WB Nodes и можете писать автоматизации с использованием Node-RED.
Проверка настроек
Чтобы проверить правильность настроек:
- Добавьте в рабочую область любую ноду из группы Wiren Board, например, WB-input.
- Дважды кликните на ноде WB-input, откроется окно Edit in node.
- В окне Edit in node нажмите кнопку Refresh Device List.
Если соединение настроено верно, то в выпадающем списке поля Сhannel появится список доступных для использования каналов.
Примеры
В комплекте с WB-Nodes есть примеры для Apple HomeKit и Яндекс.Алисы, найти их можно в Menu → Import → Examples.
- Примеры из комплекта WB-Nodes
Решение проблем
Иногда, если во флоу есть ошибка, то веб-интерфейс Node-RED может перестать загружаться, в этом случае нужно проверить логи сервиса nodered.
Если в логах будет видна ошибка во флоу, то:
- Подключиться к контроллеру по SSH.
- Остановить службу, если она запущена:
systemctl stop nodered
- Запустить Node-RED в безопасном режиме:
node-red --safe
- Установить проблему и остановить запущенный в безопасном режиме Node-RED.
- Снова запустить сервис:
systemctl start nodered
Если вы ставили Node-RED в docker, воспользуйтесь инструкцией на странице Установка Node-RED в docker.
Примеры использования
Примеры использования Node-RED с WB-Nodes на контроллерах Wiren Board:
- Настройка Telegram-бота.
- Настройка Алисы на контроллере Wiren Board.
- Настройка Apple HomeKit на контроллере Wiren Board.
- Создание панелей (Dashboards) в Node-RED.
- Видео от нашего партнёра: Wiren Board + Node-RED
- Умный дом на Wiren Board и Node-RED: четыре полезных сценария без программирования
- Умный дом на Wiren Board и Node-RED: ещё три полезных сценария без программирования
- Работаем с Zigbee-устройствами через Zigbee2mqtt и Node-RED