Wb-rules: различия между версиями
Admin (обсуждение | вклад) |
|||
| (не показано 11 промежуточных версий 2 участников) | |||
| Строка 7: | Строка 7: | ||
Альтернатива правилам wb-rules для создания сценариев управления — среда графического программирования [[Node-Red | Node-RED]]. | Альтернатива правилам wb-rules для создания сценариев управления — среда графического программирования [[Node-Red | Node-RED]]. | ||
== Как создавать и редактировать правила == | == Как создавать и редактировать правила == | ||
| Строка 23: | Строка 21: | ||
#Нажмите кнопку '''Сохранить'''. | #Нажмите кнопку '''Сохранить'''. | ||
Если в правиле нет | Если в правиле нет ошибок, оно начинает работать сразу после сохранения файла. | ||
==Если правило не работает== | ==Если правило не работает== | ||
| Строка 38: | Строка 32: | ||
Если правило не работает или показывает красным строку и вы не понимаете причину, то вы можете получить дополнительную информацию в [[Wiren_Board_Web_Interface#logs|Системном журнале]], который можно отфильтровать по имени сервиса — wb-rules. | Если правило не работает или показывает красным строку и вы не понимаете причину, то вы можете получить дополнительную информацию в [[Wiren_Board_Web_Interface#logs|Системном журнале]], который можно отфильтровать по имени сервиса — wb-rules. | ||
==Дополнительная информация== | |||
== | |||
Примеры правил: | Примеры правил: | ||
* в статье [[Rule_Examples|Примеры правил]]; | * в статье [[Rule_Examples|Примеры правил]]; | ||
* в [http://forums.contactless.ru/t/dvizhok-pravil-primery-koda/483 специальной теме на портале техподдержки]; | * в [http://forums.contactless.ru/t/dvizhok-pravil-primery-koda/483 специальной теме на портале техподдержки]; | ||
Проекты сообщества на wb-rules: | Проекты сообщества на wb-rules: | ||
* Конвертер ESPHome → Wiren Board: [https://github.com/ | * Конвертер ESPHome → Wiren Board: [https://github.com/wb-adegtyarev/esphome2wb esphome2wb]. | ||
* Конвертер OpenMQTTGateway → Wiren Board [https://github.com/ | * Конвертер OpenMQTTGateway → Wiren Board [https://github.com/wb-adegtyarev/omg2wb omg2wb]. | ||
* Телеграм-бот [https://github.com/ | * Телеграм-бот [https://github.com/wb-adegtyarev/telegram2wb telegram2wb]. | ||
== Версии wb-rules и совместимость скриптов == | == Версии wb-rules и совместимость скриптов == | ||
Версия 14:23, 16 декабря 2022
Описание
wb-rules — это специальный сервис в контроллере Wiren Board, который работает поверх операционной системы и позволяет создавать сценарии управления с помощью правил на языке JavaScript.
wb-rules установлен в контроллер по умолчанию и запускается автоматически. Управлять им можно из консоли контроллера, о чем подробнее написано в статье Диагностика ошибок в работе контроллера Wiren Board.
Альтернатива правилам wb-rules для создания сценариев управления — среда графического программирования Node-RED.
Как создавать и редактировать правила
Файлы с правилами хранятся в контроллере в папке /etc/wb-rules/ с расширением .js. Их можно редактировать и загружать их напрямую с компьютера, а также использовать встроенный в веб-интерфейс редактор правил на вкладке Rules.
Для написания правил необходимы базовые знания синтаксиса языка JavaScript с учетом особенностей ECMAScript 5. Если вы ранее не работали с JavaScript, то рекомендуем учебник learn.javascript.ru.
Каждое правило представляет собой функцию на языке JavaScript с определенным набором входных параметров. Выполнение правила происходит при наступлении заданного события или циклически. Подробное описание типов правил и механизма их работы читайте в документации на Github.
Для создания правила:
- Откройте вкладку Rules в веб-интерфейсе контроллера.
- Создайте новый файл правил или откройте стандартный rules.js.
- Напишите скрипт или вставьте код из примера.
- Нажмите кнопку Сохранить.
Если в правиле нет ошибок, оно начинает работать сразу после сохранения файла.
Если правило не работает
Если написанный скрипт не работает:
- Проверьте еще раз знаки пунктуации, количество открывающихся и закрывающихся скобок, возможные ошибки в написании имен переменных. Обычно синтаксические ошибки подсвечиваются красным, но некоторые могут быть пропущены компилятором.
- Проверьте правильность написания ссылок на MQTT-топики.
- Уточните правильно ли выбран тип правила.
Если правило не работает или показывает красным строку и вы не понимаете причину, то вы можете получить дополнительную информацию в Системном журнале, который можно отфильтровать по имени сервиса — wb-rules.
Дополнительная информация
Примеры правил:
- в статье Примеры правил;
- в специальной теме на портале техподдержки;
Проекты сообщества на wb-rules:
- Конвертер ESPHome → Wiren Board: esphome2wb.
- Конвертер OpenMQTTGateway → Wiren Board omg2wb.
- Телеграм-бот telegram2wb.
Версии wb-rules и совместимость скриптов
Существует две версии движка:
- wb-rules 1.7 — устаревшая версия, поддерживаются контроллеры Wiren Board 5 и 6.
- wb-rules 2.0 — актуальная версия, поддерживаются контроллеры Wiren Board 6 и 7.
Если у вас контроллер Wiren Board 6 из первых партий и вы переходите с версии 1.7 на 2.0, то прочитайте статью Совместимость скриптов — в ней мы описали возможные проблемы и пути решения.