✎ Общая конфигурация плагинов и модулей [ПромАвтоматика]

Эта страница только для чтения. Вы можете посмотреть исходный текст, но не можете его изменить. Сообщите администратору, если считаете, что это неправильно.
====== Общие настройки ======


===== Плагины и модули =====
Для удобства расширения функциональности используются плагины. 

Плагин - это подключаемый jar-файл, хранящийся по умолчанию в ''jar/plugin''. При запуске ''jar/core/jroboplc.jar'' выполняется проверка доступных к использованию плагинов, загрузка плагинов и создание модулей. 

Модуль - это основной программный компонент, из которых состоит работающее приложение. Модули создаются на стадии загрузки программы, объединяются в задачи и, после старта системы, выполняют определенную им работу. 

===== Конфигурационные файлы =====
Конфигурация проекта может состоять из одного и более yml-файлов, которые хранятся в каталоге проекта. Данный каталог указывается параметром ''-cfg'' при запуске приложения. При загрузке сканируется весь каталог (без вложенных каталогов), и загружаются все найденные yml-файлы (кроме скрытых, начинающихся с точки).

Конфигурация записывается в [[http://yaml.org/start.html|YAML-формате]]. 
<note important>Внимание! В YAML отступы имеют значение. Для отступов используется пробел. TAB'ы использовать запрещено.\\ 
[[https://www.youtube.com/watch?v=AXLoRpKnK8U]]</note>

Общий формат конфигурационного файла:<code yaml>
param1: value
param2: value

plugin.pluginA:
  enable: on
  module.moduleA1
    modprm1: value
    modprm2: value
  module.moduleA2
    modprm1: value
    modprm2: value

plugin.pluginB:
  enable: off
  module.moduleB1
    modprm1: value
    
  tag.values:
    tagname: value
    regex:   value
    
  tag.flags:
    tagname1: none
    tagname2: autosave
    regex:    autosave hidden
    

</code>


===== Общие настройки для плагинов =====
|**plugin.name**  |название плагина ([[doc:jroboplc:notes:how_to_name_modules]])  |
|**enable**  |разрешение работы плагина  |
|:::|**off** - плагин отключен и не загружается при старте приложения  |
|:::|**on** - плагин включен  |

===== Общие настройки для модулей =====
|**module.name**  |название модуля  |
|**enable**  |разрешение работы модуля  |
|:::|**off** - модуль загружается при старте приложения, но не выполняется в runtime  |
|:::|**on** - модуль выполняется в runtime  |
|**tag.values**  |переопределение значений тегов, где tagname имя тега модуля, либо regex-выражение  |
|**tag.flags**  |переопределение флагов тегов, где tagname имя тега модуля, либо regex-выражение. Флаги указываются через пробел или запятую:  |
|:::|**none**  |
|:::|**autosave** - значение тега сохраняется (необходимо использовать модуль [[doc:jroboplc:modules:tagsaver]] |
|:::|**hidden** - тег не предназначен для показа удаленным клиентам |
|:::|**external** - тег содержит значение, запрошенное с удаленного сервера |
|:::|**status** - тег может изменять свой статус ''GOOD''/''BAD'' |



===== Настройка логирования =====

В файле ''conf.yml'' указывается путь (относительно каталога конфигурации) до каталога с лог-файлами.<code yaml>
log.dir:      log
</code>