Настройка плагина Modbus-интеграции

1

Настройка плагина осуществляется в разделе [[Плагины>>doc:ui.Параметры узла.Плагины.WebHome]] веб-интерфейса узла, через который осуществлялось физическое подключение «сторонней» системы: контроллера БОРЕЙ при интеграции по Modbus RTU, или Платформы НЕЙРОСС при интеграции по Modbus TCP.

2

3

== Установка плагина ==

4

5

Модуль Modbus-интеграции в виде [[плагина>>doc:ui.Параметры узла.Плагины.WebHome]] — независимого программного модуля, предназначенного для расширения функционала. Установка плагина является стандартной процедурой и не зависит от предоставляемых функций. Перечень разработанных плагинов и порядок их установки приведён в разделе ~[[[doc:ui.Параметры узла.Плагины.WebHome]]].

6

7

8

Право использования функции мониторинга состояний и управление Modbus-элементами по количеству профилей систем указывается в параметрах лицензии. Дополнительная активация не требуется.

9

10

11

== Загрузка профиля ==

12

13

Профиль интеграции обеспечивает вычитывание конфигурации сторонней системы, присвоение имен вычитанным элементов, а также работу всех интеграционных функций. При приобретении Комплекта БОРЕЙ под конкретную интеграцию ~[[[Комплекты интеграции>>doc:borey3.Комплекты интеграции.WebHome]]] контроллер поставляется с установленным плагином и профилем. Вы также можете загрузить профиль самостоятельно.

14

15

Выполните подключение к [[веб-интерфейсу>>doc:ui.Рабочий стол НЕЙРОСС.WebHome]] узла НЕЙРОСС, через который осуществлялась интеграция. В списке установленных плагинов требуемый и нажмите на кнопку **Настроить** ~[[[Плагины>>doc:ui.Параметры узла.Плагины.WebHome]]].

16

17

[[image:attach:PluginModbus5.png||height="170"]]

18

19

Откроется окно конфигурирования плагина. Загрузите профиль интеграции. Для этого укажите путь к файлу профиля в формате **LUA**. Дождитесь окончания процедуры импорта. Откроется редактор плагина.

20

21

[[image:attach:PluginModbus6_new.png]]

22

23

== Редактор плагина ==

24

25

[[image:attach:s_PluginModbus_redactor.png||width="900"]]

1. (((

Вкладки редактора

|=(((

Вкладка

)))|=(((

Комментарий

)))

|(((

Профили системы

)))|(((

В заголовке вкладки указано количество загруженных профилей и общее количество профилей, доступных по лицензии. Например, (2/5) означает, что загружено два профиля, свободно ещё три лицензии.

)))

|(((

Элементы

)))|(((

Вкладка содержит дерево элементов, вычитанных профилями. Вы можете задать пользовательские имена ~[[[#Изменение имён элементов>>doc:||anchor="НастройкаплагинаModbus-интеграции-Изменениеимёнэлементов"]]].

)))

)))

1. (((

Перечень загруженных профилей. Содержит инструменты управления профилями.

|=(((

Команда

)))|=(((

Комментарий

)))

|(((

(((

Удалить профиль

)))

)))|(((

(((

Для удаления профиля нажмите на кнопку [[image:attach:btn_del_new.png||thumbnail="true" height="15"]] в заголовке вкладки и подтвердите удаление

)))

)))

|(((

Добавить профиль

)))|(((

(((

Для добавления профиля нажмите на кнопку [[image:attach:ui.Параметры узла.WebHome@fa-plus.png||thumbnail="true" height="19"]] в заголовке новой вкладки и укажите путь к файлу профиля.

)))

)))

)))

1. (((

Скачать или обновить файл профиля.

|=(((

Команда

)))|=(((

Комментарий

)))

|(((

(((

Скачать профиль

)))

)))|(((

(((

Нажмите скачать, чтобы загрузить файл профиля в папку загрузок браузера. Вы можете отредактировать профиль и затем повторно загрузить его или воспользоваться встроенным редактором [5].

)))

)))

|(((

Обновить профиль

)))|(((

(((

Нажмите на кнопку **Выберите файл** и укажите путь к файлу профиля. Нажмите на кнопку **Импортировать**.

)))

)))

)))

1. (((

**Переменные профиля**: если переменные в профиле оформлены специальным образом, доступен режим редактирования переменных из формы. При этом вам не потребуется просматривать код профиля и искать строчку объявления переменных. Оформление переменных в коде профиля:

98

99

(% class="wrapped" style="text-align:left" %)

100

(% style="text-align:left" %)|(% style="text-align:left" %)(((

101

(% style="text-align: left;" %)

102

(% class="comments java" style="text-align:left" %){{code language="none"}}// @parameter { "type": "тип поля", "title": "заголовок поля", "key": "имя переменной" }{{/code}}

)))

Где:

* type — тип поля, возможные значения: "boolean", "string", "number", "select";

108

* title — заголовок поля в форме — произвольный текст;

109

* key — имя переменной.

110

111

)))

112

1. **Исходный код профиля**. Путём редактирования исходного кода профиля вам доступны не только базовые переменные профиля, но также возможность изменения формулировок команд и меток элементов.

113

114

Задайте параметры плагина, при необходимости, откорректируйте профиль ~[[[Корректировка профиля интеграции>>doc:||anchor="corr"]]].

115

116

При необходимости, откорректируйте названия элементов ~[[[Изменение имён элементов>>doc:||anchor="rename"]]].

117

118

== {{id name="corr"/}}Корректировка профиля интеграции ==

119

120

121

Благодаря встроенному редактору Lua-скриптов с подсветкой, проверкой синтаксиса и инструкциями по отладке, вы легко сможете отредактировать скрипт: изменить метки типов элементов, формулировки состояний и команд управления, а также заголовки событий для вывода в АРМ НЕЙРОСС Центр.

122

123

Вы также можете скачать профиль интеграции, отредактировать его в любом удобном вам редакторе и загрузить отредактированный файл. Для выгрузки профиля используйте ссылку скачать.

124

125

126

Для изменения формулировок достаточно отредактировать текст.

127

128

Пример событий, отображаемых в ленте событий, и меток состояний элементов:

129

130

131

['Alarm,FireWarning'] = {

132

headline ="Предварительная тревога «Внимание»",

min = 4

},

Alarm = {

headline ="Тревога",

min = 5

},

Fault = {

headline ="Неисправность",

min = 6

},

Armed = {

headline = "На охране",

145

eventTags = "BurglarAlarm",

min = 11

},

['Fire,Alarm'] = {

headline ="Пожар",

eventTags = "FireAlarm",

min = 20

},

Пример списка команд:

action_tco_alarm = {

commands = {

['На охрану'] = "0x101",

161

['Снять'] = "0x102",

162

['Сбросить охранный ШС'] = "0x103",

['Обход'] = "0x104"

}

},

action_tco_fire = {

commands = {

['Сбросить пожарный ШС'] = "0x301"

}

},

action_aspt = {

commands = {

['Включить автоматику АСПТ'] = "0x901",

174

['Отключить автоматику АСПТ'] = "0x902",

175

['Пуск АСПТ'] = "0x904",

176

['Отмена пуска АСПТ'] = "0x906",

177

['Сбросить АСПТ'] = "0x907"

}

},

Пример списка меток типов и состояний элементов для кастомизации внешнего вида иконок и геометрических фигур в АРМ НЕЙРОСС Центр ~[[[doc:ui.Параметры узла.Элементы.WebHome]]].

183

184

185

Для кастомизации отображения в АРМ НЕЙРОСС Центр используйте английское написание меток! Русское название дано для информации.

R08_Devices = "Папка ТСО",

190

R08_Device = "ТСО",

191

R08_Zones = "Папка зон",

192

R08_Zone = "ЗонаР08",

193

Normal = "Норма",

194

FireAlarmNormal = "Норма пож.ШС",

195

Alarm = "Тревога",

196

BurglarAlarm = "ТревогаОТС",

197

Fault = "Неисправность",

198

AsptFault = "НеисправностьАСПТ",

199

BurglarFault = "НеисправностьОТС",

200

FireFault = "НеисправностьПС",

201

EdFault = "НеисправностьИУ",

202

ModbusError = "Ошибка",

203

Fire = "Пожар",

204

AsptFire = "ПожарАСПТ",

205

Armed = "НаОхране",

206

Disarmed = "БезОхраны",

207

NotReadyToArm = "Невзятие",

208

On = "Включено",

209

Off = "Выключено",

210

FireWarning = "Пожарное «Внимание»",

211

FireReady = "Готов пож.ШС",

212

213

214

== {{id name="rename"/}}Изменение имён элементов ==

215

216

Протокол Modbus не поддерживает передачу имён элементов, а только числовых данных как значений регистров, поэтому при вычитывании списка элементов их имена задаются автоматически на основе номеров разделов/зон/датчиков. В целях удобства использования мы предусмотрели механизм изменения заданных по умолчанию имён.

217

218

[[image:attach:ModbusElements.png]]

219

220

Чтобы задать пользовательское название:

221

222

1. В окне плагина перейдите к вкладке **Элементы**.

223

1. В дереве элементов слева выберите требуемый элемент и откорректируйте его наименование. Для этого в поле **Название** введите новое название и нажмите на кнопку **Сохранить**.

224

225

226

Заданное в плагине пользовательское имя элемента сохраняется и не меняется при обновлении списка элементов ~[[[Поиск элементов>>doc:||anchor="search"]]]. Это же имя вычитывается в Платформу НЕЙРОСС и используется для наименования элементов как источников событий. Если имя было изменено впоследствии, необходимо перевычитать конфигурацию ~[[[Обновление конфигурации узлов>>doc:ui.Сеть.Обновление конфигурации узлов.WebHome]]].

227

228

229

Чтобы **сбросить** название элемента к дефолтному (заданному профилем интеграции автоматически):

230

231

Нажмите на кнопку **Сбросить к стандартному названию.**

232

233

[[image:attach:ModbusElements1.png||width="550"]]

234

235

236

Метки состояния отражают состояние выбранного элемента на момент загрузки окна **Элементы**.

237

238

239

== {{id name="search"/}}Поиск элементов ==

240

241

Поиск элементов может осуществляться как по стандартному, так и по пользовательскому имени. Для этого в окне поиска достаточно ввести значащую часть названия.

242

243

Кнопка **Обновить список элементов** запускает процедуру вычитывания элементов из сети Modbus. При этом пользовательские имена, заданные ранее, не сбрасываются.

Исходный код вики Настройка плагина Modbus-интеграции