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

Материал из Wiren Board
(Перенаправление на Wb-rules 2.0)
Метка: новое перенаправление
 
м (Добавил текст от Никиты)
(не показаны 2 промежуточные версии этого же участника)
Строка 1: Строка 1:
#REDIRECT [[wb-rules 2.0]]
{{DISPLAYTITLE: Движок правил wb-rules}}
[[File:Wb rules demo.png|400px|thumb|right|Редактирование правил в веб-интерфейсе]]
== Описание ==
WB-RULES это возможность писать правила на языка JS. В первую очередь нужно понимать что такое JS. Знать синтаксис, как происходит работа с функциями, переменными и основными языковыми конструкциями. Подробнее про язык можно узнать в официальном учебнике https://learn.javascript.ru/
 
Однако, если вы не готовы программировать, возможно вам стоит попробовать создавать правила в среде [[Node-Red | NODE-RED]].
 
Если ваше правило не работает или показывает красным строку и вы не понимаете причину, то возможно вы можете получить дополнительную информацию в системном логе выполнив в консоли команду
<syntaxhighlight lang="bash">
journalctl -u wb-rules
</syntaxhighlight>
== Совместимость скриптов при обновлении wb-rules ==
 
Предполагается, что при обновлении с предыдущей на следующую версию wb-rules и при соблюдении гайдлайнов при написании скриптов - все сценарии продолжают работать без каких-либо изменений.
Но возможны проблемы в связи с изменением логики обработки скриптов новыми версиями движка, см. [[Совместимость скриптов при обновлении wb-rules| Совместимость скриптов]].
 
== Как создавать и редактировать правила == <!--T:3-->
 
<!--T:4-->
*Список файлов с правилами находится на странице ''Rules'' веб-интерфейса. Они хранятся на контроллере текстовыми файлов в папке <code>/etc/wb-rules/</code>, поэтому [[Просмотр файлов контроллера с компьютера|их можно редактировать и загружать напрямую с компьютера]].
 
*Для редактирования правила нажмите на название файла.
*Для создания нового правила, нажмите на ''New...'', вверху введите название (латинские буквы и цифры, в качестве расширения укажите ''.js''), в основное поле введите текст скрипта, и нажмите ''Save'' вверху.
*Правило начинает сразу работать после сохранения, если в нём нет ошибок.
*В одном файле можно хранить неограниченное количество правил. Но обычно в одном файле хранятся правила с близкими функциями.
 
== Как писать правила ==
Описание смотрите в статье [[How_to_write_rules|Как писать правила]].
 
Так же вам поможет статья [[Wb-jscript|Написание скриптов для начинающих]].
 
Для для полного понимания стоит прочитать [https://github.com/contactless/wb-rules Полное описание движка правил].
 
== Примеры правил ==
Примеры правил смотрите:
* в статье [[Rule_Examples|Примеры правил]];
* в [http://forums.contactless.ru/t/dvizhok-pravil-primery-koda/483 специальной теме на портале техподдержки ].
 
== Возможности и изменения в разных версиях == <!--T:193-->
 
<!--T:194-->
* [[Движок_правил_wb-rules_1.7|Движок правил wb-rules 1.7]]
* [[Движок_правил_wb-rules_2.0|Движок правил wb-rules 2.0]]
 
== API сценариев wb-rules ==
[[API_сценариев_wb-rules]]

Версия 18:40, 7 сентября 2021

Редактирование правил в веб-интерфейсе

Описание

WB-RULES это возможность писать правила на языка JS. В первую очередь нужно понимать что такое JS. Знать синтаксис, как происходит работа с функциями, переменными и основными языковыми конструкциями. Подробнее про язык можно узнать в официальном учебнике https://learn.javascript.ru/

Однако, если вы не готовы программировать, возможно вам стоит попробовать создавать правила в среде NODE-RED.

Если ваше правило не работает или показывает красным строку и вы не понимаете причину, то возможно вы можете получить дополнительную информацию в системном логе выполнив в консоли команду

journalctl -u wb-rules

Совместимость скриптов при обновлении wb-rules

Предполагается, что при обновлении с предыдущей на следующую версию wb-rules и при соблюдении гайдлайнов при написании скриптов - все сценарии продолжают работать без каких-либо изменений. Но возможны проблемы в связи с изменением логики обработки скриптов новыми версиями движка, см. Совместимость скриптов.

Как создавать и редактировать правила

  • Для редактирования правила нажмите на название файла.
  • Для создания нового правила, нажмите на New..., вверху введите название (латинские буквы и цифры, в качестве расширения укажите .js), в основное поле введите текст скрипта, и нажмите Save вверху.
  • Правило начинает сразу работать после сохранения, если в нём нет ошибок.
  • В одном файле можно хранить неограниченное количество правил. Но обычно в одном файле хранятся правила с близкими функциями.

Как писать правила

Описание смотрите в статье Как писать правила.

Так же вам поможет статья Написание скриптов для начинающих.

Для для полного понимания стоит прочитать Полное описание движка правил.

Примеры правил

Примеры правил смотрите:

Возможности и изменения в разных версиях

API сценариев wb-rules

API_сценариев_wb-rules