|
|
Строка 1: |
Строка 1: |
| <languages/>{{DISPLAYTITLE:Установка Node-RED на контроллер Wiren Board}} | | <languages/> |
| [[Файл:Node-red.PNG|500px|thumb|right| Node-RED на контроллере Wiren Board]] | | {{DISPLAYTITLE:Wiren Board 6: Node-RED}} |
| | [[Файл:Node-red.PNG|400px|thumb|right| Node-RED на WB6]] |
|
| |
|
| == Описание == | | == Описание == |
| {{YouTube
| | Node-RED - это инструмент визуального программирования. Работает на платформе Node.js. |
| |link= https://youtu.be/cKQmU4LZo4c
| |
| |text= Видеоурок по Node-RED на Wiren Board от SetPoint
| |
| }}
| |
| Node-RED — это инструмент визуального программирования, основанный на Node.js и который разрабатывается и поддерживается открытым сообществом.
| |
|
| |
|
| Подробное описание, инструкции и примеры использования можно найти на сайте [https://nodered.org/ nodered.org], а поддержку сообщества в телеграм-канале [https://t.me/SprutAI_NodeRED Node-RED].
| | Более подробное описание, инструкции и примеры использования можно найти на сайте [https://nodered.org/ nodered.org] |
|
| |
|
| {{Wbincludes:Installing Software In Console}}
| | == Установка == |
| | Для установки Node-RED на Wiren board 6 подключитесь к контроллеру по SSH и введите в консоль несколько команд: |
|
| |
|
| == Установка ==
| | Настраиваем репозиторий Node JS |
| Для установки Node-RED 2.2 на контроллер Wiren Board подключитесь к нему по [[SSH]] и введите в консоль несколько команд.
| | <pre> |
| | curl -sL https://deb.nodesource.com/setup_10.x | bash - |
| | </pre> |
|
| |
|
| Установите необходимые компоненты:
| | Устанавливаем необходимые компоненты |
| <syntaxhighlight lang="bash"> | | <pre> |
| apt update && apt install -y nodejs git make g++ gcc build-essential | | apt-get install -y nodejs git make g++ gcc build-essential |
| </syntaxhighlight> | | </pre> |
|
| |
|
| Запустите установку Node-RED:
| | Запускаем установку Node-RED |
| <syntaxhighlight lang="bash"> | | <pre> |
| npm install -g --unsafe-perm node-red@2.2 | | npm install -g --unsafe-perm node-red |
| </syntaxhighlight> | | </pre> |
|
| |
|
| Если потребуется обновить версию Node-RED, выполните команду установки ещё раз.
| | == Создание Сервиса == |
|
| |
|
| == Создание сервиса ==
| | Для автозапуска Node-RED необходимо настроить сервис. Для этого зайдите в папку /etc/systemd/system/ и создайте файл nodered.service |
| | <pre> |
| | /etc/systemd/system/nodered.service |
| | </pre> |
|
| |
|
| Для автозапуска Node-RED необходимо настроить сервис. Для этого в папке <code>/etc/systemd/system/</code> создайте файл <code>nodered.service</code>:
| | Затем скопируйте в этот файл: |
| | |
| <syntaxhighlight lang="bash">
| |
| mcedit /etc/systemd/system/nodered.service
| |
| </syntaxhighlight>
| |
| | |
| Затем вставьте в этот файл строки: | |
| <pre> | | <pre> |
| [Unit] | | [Unit] |
Строка 59: |
Строка 56: |
| </pre> | | </pre> |
|
| |
|
| Сохраните изменения и закройте файл. Теперь включите сервис и запустите его командой: | | Сохраните изменения и закройте файл.Теперь для включения сервиса нужно ввести команду: |
| | <pre> |
| | systemctl enable nodered.service |
| | </pre> |
|
| |
|
| <syntaxhighlight lang="bash"> | | == WB Nodes == |
| systemctl enable nodered && systemctl start nodered
| | Для упрощения взаимодействия Node-RED с WB пользователь [https://support.wirenboard.com/t/node-red-contrib-wirenboard/2019 Andrej_Popov] написал модуль node-red-contrib-wirenboard. |
| </syntaxhighlight> | | Для установки введите следующие команды в консоль: |
| | <pre> |
| | cd $HOME/.node-red |
| | npm install node-red-contrib-wirenboard |
| | </pre> |
|
| |
|
| Проверьте статус сервиса командой, в выводе должна быть строчка <code>Active: active (running)</code>:
| | == Запуск == |
| <syntaxhighlight lang="console"> | | Для управления сервисом используйте команды |
| # systemctl status nodered
| | <pre> |
| ● nodered.service - Node-RED graphical event wiring tool
| | service nodered start |
| Loaded: loaded (/etc/systemd/system/nodered.service; enabled; vendor preset: enabled)
| | service nodered stop |
| Active: active (running) since Fri 2021-12-03 06:32:25 UTC; 24s ago
| | service nodered restart |
| Main PID: 2757 (node)
| | service nodered status |
| CGroup: /system.slice/nodered.service
| | </pre> |
| └─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
| |
| </syntaxhighlight>
| |
|
| |
| == Удаление ==
| |
| Если вам больше не нужен 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>
| |
|
| |
| Node.js, тоже можно удалить, но убедитесь, что у вас не установлены другие програмы, которые его используют, например, zigbee2mqtt. Чтобы удалить node.js, выполните команду:
| |
| :<syntaxhighlight lang="bash">
| |
| apt remove nodejs
| |
| </syntaxhighlight>
| |
|
| |
| ==Веб-интерфейс Node-RED==
| |
| После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880. | | После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880. |
| Например: http://192.168.42.1:1880
| | На пример: http://192.168.1.70:1880 |
|
| |
|
| Инструкции по работе c Node-RED можно найти на [https://nodered.org/docs/getting-started/ сайте nodered.org] | | Инструкции по работе c Node-RED можно найти на [https://nodered.org/docs/getting-started/ сайте nodered.org] |
|
| |
| == WB Nodes ==
| |
| [[Файл: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>.
| |
|
| |
| === Установка ===
| |
| Установим его через [[#Веб-интерфейс Node-RED | веб-интерфейс Node-RED]]:
| |
| {{Node-RED Installing plugin
| |
| |search= wirenboard
| |
| |name= 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 пропишите <code>localhost</code>. В поле '''Name''' укажите произвольное имя, а в поле '''MQTT Port''' — 1883.
| |
| # Сохраните настройки сервера нажатием на кнопку '''Done'''.
| |
| # Закройте окно '''Edit in node''' нажатием на '''Cancel'''.
| |
| {{note|info| После настройки подключения, примените настройку сервера нажатием кнопки '''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 есть примеры для [[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>
| |
|
| |
| == Использование нод ''mqtt in'' и ''mqtt out'' для взаимодействия с Wiren Board ==
| |
| === Настройка подключения ===
| |
| [[Image: NodeRed_mqtt_nodes.jpg |300px|thumb|right| Ноды MQTT в Node-Red ]]
| |
| Альтернативный вариант — использовать ноды '''mqtt in''' и '''mqtt out'''. Для этого вам понадобятся адреса топиков, взять их можно в веб-интерфейсе контроллера на странице [[Wiren Board Web Interface#mqtt-channels |MQTT-каналы]].
| |
|
| |
| Для настройки MQTT-соединения в Node-RED выполните следующие действия:
| |
| #Перетащите ноду '''mqtt in''' в рабочую область.
| |
| #Войдите в конфигурацию ноды и нажмите на '''Карандаш''' напротив поля '''Server'''.
| |
| #На вкладке '''Connecting''' задайте адрес брокера и номер порта.
| |
| #:В поле '''Name''' введите любое имя сервера.
| |
| #:На вкладке '''Security''' можно указать Имя пользователя и Пароль для подключения к брокеру. Если в качестве брокера выступает контроллер Wiren Board, это поле нужно оставить пустым.
| |
| #После заполнения всех полей нажмите кнопку '''Update'''. Созданный брокер теперь можно использовать для настройки всех подключений.
| |
| #Выберите созданные брокер из списка в поле '''Server'''.
| |
| #Введите адрес mqtt-топика в поле '''Topic'''.
| |
| #Нажмите кнопку '''Done'''.
| |
|
| |
| По такому же принципу настраивается нода '''mqtt out'''.
| |
| <gallery mode="packed" heights="150px" caption="Настройка MQTT-брокера (Server)>
| |
| Image: NodeRed_mqtt2.jpg | Вкладка ''Connecting''
| |
| Image: NodeRed_mqtt3.jpg | Вкладка ''Security''
| |
| </gallery>
| |
|
| |
| === Отправка команд ===
| |
| Для отправки команды контроллеру по MQTT используется нода '''mqtt out'''. При этом в поле '''Topic''' указывается адрес mqtt-топика контроллера, в который необходимо записать параметр. Нужно учитывать, что в конце адреса ноды '''mqtt out''' нужно написать <code>/on</code>, иначе параметр в топик не запишется. Например, <code>/devices/wb-mrgbw-d-fw3_129/controls/RGB Strip/on</code>. Подробнее читайте на странице [[MQTT | MQTT]].
| |
| <gallery mode="packed" heights="150px" caption="Настройка нод для работы с MQTT">
| |
| Image: NodeRed_mqtt4.jpg | Пример настройки ноды '''mqtt in'''
| |
| Image: mqtt_out_no.jpg | Пример настройки ноды '''mqtt out'''
| |
| Image: NodeRed_mqtt1.jpg | Обмен данными через MQTT в Node-Red
| |
| </gallery>
| |
| Для отправки параметра в ноду '''mqtt out''' можно использовать ноду '''inject'''.
| |
| #Перетащите ноду '''inject''' в рабочую область.
| |
| #Подключите ее ко входу ноды '''mqtt out'''.
| |
| #Зайдите в настройки ноды '''inject''' и задайте ''Имя'' ноды, ''Тип переменной'' и ее ''Значение''. Нажмите кнопку '''Done'''.
| |
| <gallery mode="packed" heights="130px">
| |
| Image: Inject1.jpg | Пример настроек ноды '''inject''' для управления дискретным параметром
| |
| Image: Inject2.jpg | Поле настройки периодов повторения отправки ноды '''inject'''
| |
| </gallery>
| |
| <gallery mode="packed" heights="100px">
| |
| Image: Node_inject.jpg | Пример использования ноды '''inject'''
| |
| </gallery>
| |
|
| |
| После настройки ввода и вывода можно обрабатывать данные внутри Node-RED и настроить использование сторонних сервисов, например, [[Node-RED_Alice | Умный дом с Алисой]].
| |
|
| |
| <gallery mode="packed" heights="150px">
| |
| Image: NodeRed_mqtt5.jpg | Пример управления с помощью Алисы
| |
| </gallery>
| |
|
| |
| == Примеры использования ==
| |
| Примеры использования Node-RED с WB-Nodes на контроллерах Wiren Board:
| |
| * [[Node-RED_Telegram | Настройка Telegram-бота]].
| |
| * [[Node-RED_Alice | Настройка Алисы на контроллере Wiren Board]].
| |
| * [[Node-RED Apple HomeKit | Настройка Apple HomeKit на контроллере Wiren Board]].
| |
| * [[Node-RED Dashboards|Создание панелей (Dashboards) в Node-RED]].
| |
| * [https://youtu.be/cKQmU4LZo4c Видео от нашего партнёра: Wiren Board + Node-RED]
| |
Описание
Node-RED - это инструмент визуального программирования. Работает на платформе Node.js.
Более подробное описание, инструкции и примеры использования можно найти на сайте nodered.org
Установка
Для установки Node-RED на Wiren board 6 подключитесь к контроллеру по SSH и введите в консоль несколько команд:
Настраиваем репозиторий Node JS
curl -sL https://deb.nodesource.com/setup_10.x | bash -
Устанавливаем необходимые компоненты
apt-get install -y nodejs git make g++ gcc build-essential
Запускаем установку Node-RED
npm install -g --unsafe-perm node-red
Создание Сервиса
Для автозапуска Node-RED необходимо настроить сервис. Для этого зайдите в папку /etc/systemd/system/ и создайте файл nodered.service
/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.service
WB Nodes
Для упрощения взаимодействия Node-RED с WB пользователь Andrej_Popov написал модуль node-red-contrib-wirenboard.
Для установки введите следующие команды в консоль:
cd $HOME/.node-red
npm install node-red-contrib-wirenboard
Запуск
Для управления сервисом используйте команды
service nodered start
service nodered stop
service nodered restart
service nodered status
После запуска сервиса откройте браузер и введите адрес своего контроллера в сети и порт 1880.
На пример: http://192.168.1.70:1880
Инструкции по работе c Node-RED можно найти на сайте nodered.org