Wiki source code of Настройка плагина Modbus-интеграции
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | Настройка плагина осуществляется в разделе (% style="color: rgb(23,43,77);" %)[[Конфигурация узлов>>doc:ui.Параметры узла.WebHome]] > [[doc:ui.Параметры узла.Плагины.WebHome]] веб-интерфейса узла, через который осуществлялось физическое подключение «сторонней» системы: контроллера БОРЕЙ при интеграции по Modbus RTU, или Платформы НЕЙРОСС при интеграции по Modbus TCP. | ||
| 2 | |||
| 3 | [[image:attach:ui.Параметры узла.WebHome@content.png||thumbnail="true" height="10"]] Содержание: | ||
| 4 | |||
| 5 | {{toc/}} | ||
| 6 | |||
| 7 | (% style="font-size: 20.0px;letter-spacing: -0.008em;" %)Установка плагина | ||
| 8 | |||
| 9 | (% style="letter-spacing: 0.0px;" %)Модуль Modbus-интеграции в виде (% style="color: rgb(51, 51, 51); color: rgb(23, 43, 77)" %)[[плагина>>doc:ui.Параметры узла.Плагины.WebHome]] — (% style="color: rgb(51, 51, 51); color: rgb(12, 14, 13)" %)независимого программного модуля, предназначенного для расширения функционала(% style="color: rgb(51, 51, 51); color: rgb(23, 43, 77)" %). Установка плагина является стандартной процедурой и не зависит от предоставляемых функций. П(% style="color: rgb(51,51,51);" %)еречень разработанных плагинов и порядок их установки приведён в разделе ~[[[doc:ui.Параметры узла.Плагины.WebHome]]]. | ||
| 10 | |||
| 11 | {{info}} | ||
| 12 | Право использования функции мониторинга состояний и управление Modbus-элементами по количеству профилей систем указывается в параметрах лицензии. Дополнительная активация не требуется. | ||
| 13 | {{/info}} | ||
| 14 | |||
| 15 | (% style="font-size: 20.0px;letter-spacing: -0.008em;" %)Порядок настройки | ||
| 16 | |||
| 17 | (% style="color: rgb(0,0,0);letter-spacing: 0.0px;" %)Выполните подключение к [[веб-интерфейсу>>doc:ui.Рабочий стол НЕЙРОСС.WebHome]] узла НЕЙРОСС, через который осуществлялась интеграция. (% style="letter-spacing: 0.0px;" %)В разделе [[Конфигурация узлов>>doc:ui.Параметры узла.WebHome]] > [[doc:ui.Параметры узла.Плагины.WebHome]] найдите в списке установленных плагинов требуемый и нажмите на кнопку **Настроить**. | ||
| 18 | |||
| 19 | (% style="color: rgb(23,43,77);" %)[[image:attach:PluginModbus5.png||height="170"]]\\ | ||
| 20 | |||
| 21 | (% style="color: rgb(23,43,77);" %)Откроется окно конфигурирования плагина. Загрузите профиль интеграции. Для этого укажите путь к файлу профиля в формате **LUA**(% style="color: rgb(23, 43, 77); color: rgb(68, 68, 68)" %). (% style="color: rgb(23, 43, 77); color: rgb(68, 68, 68); color: rgb(0, 0, 0)" %)Дождитесь окончания процедуры импорта. Откроется редактор плагина. | ||
| 22 | |||
| 23 | (% style="color: rgb(23, 43, 77); color: rgb(68, 68, 68)" %)[[image:attach:PluginModbus6_new.png]]\\ | ||
| 24 | |||
| 25 | (% style="color: rgb(23, 43, 77); color: rgb(0, 0, 0)" %)**Редактор плагина** | ||
| 26 | |||
| 27 | (% style="color: rgb(23, 43, 77); color: rgb(0, 0, 0)" %)[[image:attach:s_PluginModbus_redactor.png||width="900"]] | ||
| 28 | |||
| 29 | 1. ((( | ||
| 30 | Вкладки редактора | ||
| 31 | |||
| 32 | (% class="wrapped" %) | ||
| 33 | |=((( | ||
| 34 | Вкладка | ||
| 35 | )))|=((( | ||
| 36 | Комментарий | ||
| 37 | ))) | ||
| 38 | |((( | ||
| 39 | Профили системы | ||
| 40 | )))|((( | ||
| 41 | В заголовке вкладки указано количество загруженных профилей и общее количество профилей, доступных по лицензии. Например, (2/5) означает, что загружено два профиля, свободно ещё три лицензии. | ||
| 42 | ))) | ||
| 43 | |((( | ||
| 44 | Элементы | ||
| 45 | )))|((( | ||
| 46 | Вкладка содержит дерево элементов, вычитанных профилями. Вы можете задать пользовательские имена ~[[[#Изменение имён элементов>>doc:||anchor="НастройкаплагинаModbus-интеграции-Изменениеимёнэлементов"]]]. | ||
| 47 | ))) | ||
| 48 | ))) | ||
| 49 | 1. ((( | ||
| 50 | Перечень загруженных профилей. Содержит инструменты управления профилями. | ||
| 51 | |||
| 52 | (% class="wrapped" %) | ||
| 53 | |=((( | ||
| 54 | Команда | ||
| 55 | )))|=((( | ||
| 56 | Комментарий | ||
| 57 | ))) | ||
| 58 | |((( | ||
| 59 | (% class="content-wrapper" %) | ||
| 60 | ((( | ||
| 61 | Удалить профиль | ||
| 62 | ))) | ||
| 63 | )))|((( | ||
| 64 | (% class="content-wrapper" %) | ||
| 65 | ((( | ||
| 66 | Для удаления профиля нажмите на кнопку [[image:attach:btn_del_new.png||thumbnail="true" height="15"]] в заголовке вкладки и подтвердите удаление | ||
| 67 | ))) | ||
| 68 | ))) | ||
| 69 | |((( | ||
| 70 | Добавить профиль | ||
| 71 | )))|((( | ||
| 72 | (% class="content-wrapper" %) | ||
| 73 | ((( | ||
| 74 | Для добавления профиля нажмите на кнопку [[image:attach:ui.Параметры узла.WebHome@fa-plus.png||thumbnail="true" height="19"]] в заголовке новой вкладки и укажите путь к файлу профиля. | ||
| 75 | ))) | ||
| 76 | ))) | ||
| 77 | ))) | ||
| 78 | 1. ((( | ||
| 79 | Скачать или обновить файл профиля. | ||
| 80 | |||
| 81 | (% class="wrapped" %) | ||
| 82 | |=((( | ||
| 83 | Команда | ||
| 84 | )))|=((( | ||
| 85 | Комментарий | ||
| 86 | ))) | ||
| 87 | |((( | ||
| 88 | (% class="content-wrapper" %) | ||
| 89 | ((( | ||
| 90 | Скачать профиль | ||
| 91 | ))) | ||
| 92 | )))|((( | ||
| 93 | (% class="content-wrapper" %) | ||
| 94 | ((( | ||
| 95 | Нажмите скачать, чтобы загрузить файл профиля в папку загрузок браузера. Вы можете отредактировать профиль и затем повторно загрузить его или воспользоваться встроенным редактором [5]. | ||
| 96 | ))) | ||
| 97 | ))) | ||
| 98 | |((( | ||
| 99 | Обновить профиль | ||
| 100 | )))|((( | ||
| 101 | (% class="content-wrapper" %) | ||
| 102 | ((( | ||
| 103 | Нажмите на кнопку **Выберите файл** и укажите путь к файлу профиля. Нажмите на кнопку **Импортировать**. | ||
| 104 | ))) | ||
| 105 | ))) | ||
| 106 | ))) | ||
| 107 | 1. ((( | ||
| 108 | **Переменные профиля**: если переменные в профиле оформлены специальным образом, доступен режим редактирования переменных из формы. При этом вам не потребуется просматривать код профиля и искать строчку объявления переменных. Оформление переменных в коде профиля: | ||
| 109 | |||
| 110 | (% class="wrapped" style="text-align: left;" %) | ||
| 111 | (% style="text-align: left;" %)|(% style="text-align: left;" %)((( | ||
| 112 | (% style="text-align: left;" %) | ||
| 113 | (% class="java comments" style="text-align: left;" %){{code language="none"}}// @parameter { "type": "тип поля", "title": "заголовок поля", "key": "имя переменной" }{{/code}} | ||
| 114 | ))) | ||
| 115 | |||
| 116 | Где: | ||
| 117 | |||
| 118 | * type — тип поля, возможные значения: "boolean", "string", "number", "select"; | ||
| 119 | * title — заголовок поля в форме — произвольный текст; | ||
| 120 | * key — имя переменной. | ||
| 121 | \\ | ||
| 122 | ))) | ||
| 123 | 1. **Исходный код профиля**. Путём редактирования исходного кода профиля вам доступны не только базовые переменные профиля, но также возможность изменения формулировок команд и меток элементов. | ||
| 124 | |||
| 125 | Задайте параметры плагина, при необходимости, откорректируйте профиль ~[[[#Корректировка профиля интеграции>>doc:||anchor="НастройкаплагинаModbus-интеграции-Корректировкапрофиляинтеграции"]]]. | ||
| 126 | |||
| 127 | При необходимости, откорректируйте названия элементов ~[[[#Изменение имён элементов>>doc:||anchor="НастройкаплагинаModbus-интеграции-Изменениеимёнэлементов"]]]. | ||
| 128 | |||
| 129 | == {{id name="НастройкаплагинаModbus-интеграции-Корректировкапрофиляинтеграции"/}}Корректировка профиля интеграции == | ||
| 130 | |||
| 131 | {{info}} | ||
| 132 | (% style="color: rgb(51,51,51);" %)Благодаря встроенному редактору Lua-скриптов с подсветкой, проверкой синтаксиса и инструкциями по отладке, вы легко сможете отредактировать скрипт: изменить метки типов элементов, формулировки состояний и команд управления, а также заголовки событий для вывода в АРМ НЕЙРОСС Центр. | ||
| 133 | |||
| 134 | (% style="color: rgb(51,51,51);" %)Вы также можете скачать профиль интеграции, отредактировать его в любом удобном вам редакторе и загрузить отредактированный файл. Для выгрузки профиля используйте ссылку (% style="color: rgb(51, 51, 51); color: rgb(0, 204, 255)" %)скачать(% style="color: rgb(51,51,51);" %). | ||
| 135 | {{/info}} | ||
| 136 | |||
| 137 | Для изменения формулировок достаточно отредактировать текст. | ||
| 138 | |||
| 139 | Пример событий, отображаемых в ленте событий, и меток состояний элементов: | ||
| 140 | |||
| 141 | {{code language="java"}} | ||
| 142 | ['Alarm,FireWarning'] = { | ||
| 143 | headline ="Предварительная тревога «Внимание»", | ||
| 144 | min = 4 | ||
| 145 | }, | ||
| 146 | Alarm = { | ||
| 147 | headline ="Тревога", | ||
| 148 | min = 5 | ||
| 149 | }, | ||
| 150 | Fault = { | ||
| 151 | headline ="Неисправность", | ||
| 152 | min = 6 | ||
| 153 | }, | ||
| 154 | Armed = { | ||
| 155 | headline = "На охране", | ||
| 156 | eventTags = "BurglarAlarm", | ||
| 157 | min = 11 | ||
| 158 | }, | ||
| 159 | ['Fire,Alarm'] = { | ||
| 160 | headline ="Пожар", | ||
| 161 | eventTags = "FireAlarm", | ||
| 162 | min = 20 | ||
| 163 | }, | ||
| 164 | {{/code}} | ||
| 165 | |||
| 166 | Пример списка команд: | ||
| 167 | |||
| 168 | {{code language="java"}} | ||
| 169 | action_tco_alarm = { | ||
| 170 | commands = { | ||
| 171 | ['На охрану'] = "0x101", | ||
| 172 | ['Снять'] = "0x102", | ||
| 173 | ['Сбросить охранный ШС'] = "0x103", | ||
| 174 | ['Обход'] = "0x104" | ||
| 175 | } | ||
| 176 | }, | ||
| 177 | action_tco_fire = { | ||
| 178 | commands = { | ||
| 179 | ['Сбросить пожарный ШС'] = "0x301" | ||
| 180 | } | ||
| 181 | }, | ||
| 182 | action_aspt = { | ||
| 183 | commands = { | ||
| 184 | ['Включить автоматику АСПТ'] = "0x901", | ||
| 185 | ['Отключить автоматику АСПТ'] = "0x902", | ||
| 186 | ['Пуск АСПТ'] = "0x904", | ||
| 187 | ['Отмена пуска АСПТ'] = "0x906", | ||
| 188 | ['Сбросить АСПТ'] = "0x907" | ||
| 189 | } | ||
| 190 | }, | ||
| 191 | {{/code}} | ||
| 192 | |||
| 193 | Пример списка меток типов и состояний элементов для кастомизации внешнего вида иконок и геометрических фигур в АРМ НЕЙРОСС Центр ~[[[doc:ui.Параметры узла.Элементы.WebHome]]]. | ||
| 194 | |||
| 195 | {{error}} | ||
| 196 | Для кастомизации отображения в АРМ НЕЙРОСС Центр используйте английское написание меток! Русское название дано для информации. | ||
| 197 | {{/error}} | ||
| 198 | |||
| 199 | {{code language="java"}} | ||
| 200 | R08_Devices = "Папка ТСО", | ||
| 201 | R08_Device = "ТСО", | ||
| 202 | R08_Zones = "Папка зон", | ||
| 203 | R08_Zone = "ЗонаР08", | ||
| 204 | Normal = "Норма", | ||
| 205 | FireAlarmNormal = "Норма пож.ШС", | ||
| 206 | Alarm = "Тревога", | ||
| 207 | BurglarAlarm = "ТревогаОТС", | ||
| 208 | Fault = "Неисправность", | ||
| 209 | AsptFault = "НеисправностьАСПТ", | ||
| 210 | BurglarFault = "НеисправностьОТС", | ||
| 211 | FireFault = "НеисправностьПС", | ||
| 212 | EdFault = "НеисправностьИУ", | ||
| 213 | ModbusError = "Ошибка", | ||
| 214 | Fire = "Пожар", | ||
| 215 | AsptFire = "ПожарАСПТ", | ||
| 216 | Armed = "НаОхране", | ||
| 217 | Disarmed = "БезОхраны", | ||
| 218 | NotReadyToArm = "Невзятие", | ||
| 219 | On = "Включено", | ||
| 220 | Off = "Выключено", | ||
| 221 | FireWarning = "Пожарное «Внимание»", | ||
| 222 | FireReady = "Готов пож.ШС", | ||
| 223 | {{/code}} | ||
| 224 | |||
| 225 | == {{id name="НастройкаплагинаModbus-интеграции-Изменениеимёнэлементов"/}}Изменение имён элементов == | ||
| 226 | |||
| 227 | Протокол Modbus не поддерживает передачу имён элементов, а только числовых данных как значений регистров, поэтому при вычитывании списка элементов их имена задаются автоматически на основе номеров разделов/зон/датчиков. В целях удобства использования мы предусмотрели механизм изменения заданных по умолчанию имён. | ||
| 228 | |||
| 229 | [[image:attach:ModbusElements.png]] | ||
| 230 | |||
| 231 | Чтобы задать пользовательское название: | ||
| 232 | |||
| 233 | 1. В окне плагина перейдите к вкладке **Элементы**. | ||
| 234 | 1. В дереве элементов слева выберите требуемый элемент и откорректируйте его наименование. Для этого в поле **Название** введите новое название и нажмите на кнопку **Сохранить**. | ||
| 235 | |||
| 236 | {{info}} | ||
| 237 | Заданное в плагине пользовательское имя элемента сохраняется и не меняется при обновлении списка элементов ~[[[#Поиск элементов>>doc:||anchor="НастройкаплагинаModbus-интеграции-Поискэлементов"]]]. Это же имя вычитывается в Платформу НЕЙРОСС и используется для наименования элементов как источников событий. Если имя было изменено впоследствии, необходимо перевычитать конфигурацию ~[[[Сеть ~> Выгрузка конфигурации узлов>>doc:ui.Сеть.WebHome||anchor="Сеть-Выгрузкаконфигурацииузлов"]]]. | ||
| 238 | {{/info}} | ||
| 239 | |||
| 240 | Чтобы **сбросить** название элемента к дефолтному (заданному профилем интеграции автоматически): | ||
| 241 | |||
| 242 | Нажмите на кнопку **Сбросить к стандартному названию.** | ||
| 243 | |||
| 244 | [[image:attach:ModbusElements1.png||width="550"]] | ||
| 245 | |||
| 246 | {{info}} | ||
| 247 | Метки состояния отражают состояние выбранного элемента на момент загрузки окна **Элементы**. | ||
| 248 | {{/info}} | ||
| 249 | |||
| 250 | == {{id name="НастройкаплагинаModbus-интеграции-Поискэлементов"/}}Поиск элементов == | ||
| 251 | |||
| 252 | Поиск элементов может осуществляться как по стандартному, так и по пользовательскому имени. Для этого в окне поиска достаточно ввести значащую часть названия. | ||
| 253 | |||
| 254 | Кнопка **Обновить список элементов** запускает процедуру вычитывания элементов из сети Modbus. При этом пользовательские имена, заданные ранее не сбрасываются. |