Working with WB devices without a controller: различия между версиями

Материал из Wiren Board
(→‎ОС Windows: убрал про адаптер из данного раздела)
(убрал информацию про Modbus Poll, добавил про работу с Rilheva Modbus Poll)
Строка 10: Строка 10:
Независимо от используемой операционной системы вам нужно знать [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] устройства, [[Протокол Modbus#Коды функций чтения и записи регистров|коды функций]] чтения и записи регистров, а также адреса регистров устройства. Перечень общих для всех устройств Wiren Board регистров можно найти в [[Common_Modbus_Registers | таблице общих регистров]]. Полный список регистров для каждого устройства смотрите в документации к нему.
Независимо от используемой операционной системы вам нужно знать [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] устройства, [[Протокол Modbus#Коды функций чтения и записи регистров|коды функций]] чтения и записи регистров, а также адреса регистров устройства. Перечень общих для всех устройств Wiren Board регистров можно найти в [[Common_Modbus_Registers | таблице общих регистров]]. Полный список регистров для каждого устройства смотрите в документации к нему.


=== ОС Windows ===
== Программы для работы по протоколу Modbus ==
Для работы с устройствами по протоколу Modbus из ОС Windows мы рекомендуем использовать программу <b>[https://www.rilheva.com/rilheva-modbus-poll-desktop-edition/ Rilheva Modbus Poll]</b>. Эта программа бесплатна, имеет понятный интерфейс и возможность сохранения настроек обмена и конфигурации регистров.
Для работы с устройствами по протоколу Modbus мы рекомендуем использовать программу <b>[https://www.rilheva.com/rilheva-modbus-poll-desktop-edition/ Rilheva Modbus Poll]</b>. Эта программа бесплатна, не требует установки, имеет понятный интерфейс и возможность сохранения настроек обмена и конфигурации регистров.  
Можно также использовать утилиты [https://www.modbustools.com/download.html Modbus Poll] из комплекта Modbus Tools (программа платная, но с бесплатным пробным периодом в 30 дней) и [http://s2-team.ru/wrkrs/prods/modbus-tools/termite/ termite] (есть «Pro» и «Free» версия).


==== Выбор порта ====
Программа написана для ОС Windows. Однако ОС Linux программа может быть запущена с помощью эмулятора [https://www.winehq.org/ wine] и указанием пути к исполняемому файлу:
<syntaxhighlight lang="console">
wine ~/RilhevaModbusPoll_1.0.7/RilhevaModbusPoll.exe
</syntaxhighlight>
Для запуска использовалась программа wine версии  7.0.
 
Можно также использовать утилиты [https://www.modbustools.com/download.html Modbus Poll] из комплекта Modbus Tools (программа платная, но с бесплатным пробным периодом в 30 дней) и [http://s2-team.ru/wrkrs/prods/modbus-tools/termite/ termite] (есть «Pro» и «Free» версия) в ОС Windows и утилиту [[Modbus-client| modbus_client]] в ОС Linux.
 
== Выбор порта ==
В ОС Windows узнать, к какому порту у вас подключен адаптер, можно в диспетчере устройств. Найдите в дереве тип устройств '''Порты (COM и LPT)''', разверните ветку и найдите в ней свой адаптер. Если устройство выделено восклицательным знаком — это значит, что драйвер не был установлен автоматически. Установите его вручную по инструкции производителя.
В ОС Windows узнать, к какому порту у вас подключен адаптер, можно в диспетчере устройств. Найдите в дереве тип устройств '''Порты (COM и LPT)''', разверните ветку и найдите в ней свой адаптер. Если устройство выделено восклицательным знаком — это значит, что драйвер не был установлен автоматически. Установите его вручную по инструкции производителя.


В ОС Linux порт можно узнать с помощью команды команды <code>dmesg -wH</code>, которую нужно запустить перед физическим подключением USB-адаптера. В диагностических сообщениях будет выведено сообщение об обнаружении адаптера и назначении ему порта:
<syntaxhighlight lang="console">
[  +7,705022] usb 3-7: new full-speed USB device number 6 using xhci_hcd
[  +0,149142] usb 3-7: New USB device found, idVendor=1a86, idProduct=7523, bcdDevice= 2.62
[  +0,000014] usb 3-7: New USB device strings: Mfr=0, Product=2, SerialNumber=0
[  +0,000005] usb 3-7: Product: USB2.0-Serial
[  +0,001500] ch341 3-7:1.0: ch341-uart converter detected
[  +0,000549] usb 3-7: ch341-uart converter now attached to ttyUSB0
</syntaxhighlight>
В данном примере был назначен порт /dev/ttyUSB0.
В интерфейсе программы '''Rilheva Modbus Poll''' для адаптера обычно нужно выбрать COM-порт с самым большим номером. Чтобы проверить правильность выбора порта в Linux, нужно в пользовательской директории со списком портов эмулятора wine (<code>~/.wine/dosdevices</code>) найти файл, который является символической ссылкой на реальный USB-порт, к которому подключен адаптер.
<gallery mode="traditional" widths ="350px" heights="200px">
<gallery mode="traditional" widths ="350px" heights="200px">
Image: Windows-com-port-check.png |Определение номера COM-порта адаптера в диспетчере устройств ОС Windows
Image: Windows-com-port-check.png |Определение номера COM-порта в диспетчере устройств ОС Windows
Image: Wine-com-port-check.png | Определение номера COM-порта при работе через wine в OC Linux
</gallery>
</gallery>


=== Настольный компьютер с Linux ===
== Работа с программой Rilheva Modbus Poll ==
Для работы с modbus-утройством используется утилита [[Modbus-client| modbus_client]].


Скачайте [https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb пакет для настольных компьютеров с Linux].


Перейдите в папку со скаченным пакетом и установите его командой:
<syntaxhighlight lang="bash">
sudo apt install ./modbus-utils_1.2_amd64.deb
</syntaxhighlight>


Также автоматически должен установиться пакет <code>libmodbus</code>, если этого не произошло — установите его из репозитория apt.


Как работать и примеры использования смотрите в статье[[Modbus-client| modbus_client]].
=== Создание собственной конфигурации ===
Для начала работы с modbus-модулем нужно настроить параметры обмена: выбрать порт, а также скорость, четность и количество стопбитов в соответствии с настройками модуля, таймаут ответа и частоту запросов. Затем требуется добавить регистры устройства, которые необходимо опрашивать. Нажмите кнопку <b>Add register</b> и в появившемся диалоговом окне заполните поля в соответствии с картой регистров используемого модуля. Для регистров, значения которых нужно изменить снимите галочку <b>Read only</b>. Подтвердите правильность ввода, нажав на кнопку <b>OK</b>. Можно добавлять в список опроса сразу несколько регистров одного типа, а также задавать множитель, сдвиг и количество десятичных знаков для значения регистра.


== Работа из ОС Windows с помощью Modbus Poll ==
Для начала опроса регистров нужно нажать кнопку <b>Connect</b>. Состояния регистров примут актуальные значения. При необходимости изменения значения регистров типа <code>holding</code> или <code>coil</code> задайте его в поле <code>Current value</code>. Для прекращения опроса регистров нужно нажать <b>Disconnect</b>.
<gallery mode="traditional" widths ="350px" heights="200px">
Image: Rilheva-modbus-poll-register-config.png | Конфигурирование опроса регистра устройства Wirenboard, содержащего modbus-адрес
Image: Rilheva-modbus-poll-register-polling.png | Опроса регистра устройства Wirenboard, содержащего modbus-адрес
</gallery>


Рассмотрим работу с устройством по протоколу Modbus на примере трехфазного счетчика электроэнергии [[WB-MAP3E]].
=== Конфигурирование модулей Wirenboard ===
Чтобы избавить пользователей от необходимости создавать шаблон опроса регистров самостоятельно мы подготовили файл файл с общими регистрами для всех устройств, а также файлы с набором основных регистров настройки для модулей реле WB-MR6xx, WB-MR3xx, модуля диммера [[WB-MDM3_230V_Modbus_Dimmer | WB-MDM3]], модуля диммера светодиодных лент [[ WB-MRGBW-D_Modbus_LED_Dimmer | WB-MRGBW-D]].  


=== Настройка соединения ===
После запуска программы нужно выбрать файл конфигурации регистров соответственно модулю. Все настойки обмена будут заполнены для работы с параметрами модуля по умолчанию. Если какие-либо настройки устройства были изменены ранее, то установите соответствующие значения. Также нужно задать адрес устройства (у всех устройств он разный) и выбрать используемый COM-порт. Для начала опроса регистров нужно нажать кнопку <b>Connect</b>. Состояния регистров примут актуальные значения. При необходимости изменения значения регистров типа <code>holding</code> или <code>coil</code> задайте его в поле <code>Current value</code>. Для прекращения опроса регистров нужно нажать <b>Disconnect</b>.
Перед началом работы нужно настроить соединение: выберите в меню '''Connection''' → '''Connect''' и в открывшемся окне укажите параметры соединения.


При запуске программы у вас уже будет открыто окно опроса устройства. Если вы его закрыли или вам нужно опросить еще одно устройство — выберите в меню '''File''' → '''New'''. Окно опроса устройства содержит таблицу, в строках которой выводится пара «Имя регистра» — «Значение».
<gallery mode="traditional" widths ="350px" heights="200px">
Image: Rilheva-modbus-poll-wb-mr6с.png | Настройка модуля реле WB-MR6С
Image: Rilheva-modbus-poll-wb-mdm3.png | Настройка диммера WB-MDM3
Image: Rilheva-modbus-poll-wb-mrgbw-d.png | Настройка диммера WB-MRGBW-D
</gallery>


[[File:Usbrs485-2.PNG||450px|thumb|right|Настройка соединения в программе Modbus Poll]]
==== Файлы регистров модулей ====
Файл с общими для всех Modbus-устройств Wiren Board регистрами:<br>
[[Media:Common-registers-wb-device.zip | Общие для всех Modbus-устройств Wiren Board регистры ]]


=== Чтение значений из регистров ===
Файлы регистров и настроек для Modbus-модулей Wirenboard по типам: <br>
Чтобы вывести значение регистра в таблицу, нужно указать его тип, адрес и другие параметры опроса. Для этого в таблице выберите строку, вызовите контекстное меню правой кнопки мыши и кликните на пункте '''Read/Write Definition'''. Имя регистра необязательно и нужно для удобства восприятия информации, вводится вручную. Чтобы ввести имя, кликните дважды на ячейке и введите текст с клавиатуры.
[[Media: Registers-wb-mrgbw-d.zip | WB-MRGBW-D fw3 (4-канальный диммер светодиодных лент)]] <br>
[[Media: Registers-wb-mr6xx-without-inputs.zip | WB-MR6CU v.2, WB-MRPS6 (6-канальный модуль реле)]] <br>
[[Media: Registers-wb-mr6xx-with-inputs.zip | WB-MR6C v.2, WB-MR6LV/x, WB-MR6HV/x, WB-MR6C/NC (6-канальный модуль реле)]] <br>
[[Media: Registers-wb-mr3xx-with-inputs.zip | WB-MR3LV/x, WB-MR3HV/x, WB-MRWL3  (3-канальный модуль реле)]] <br>
[[Media: Registers-wb-mdm3.zip | WB-MDM3 (3-канальный диммер)]] <br>


==== Считывание одного регистра ====


Для примера считаем из устройства значение одного Holding-регистра. В табличной части окна опроса выберите первую строку, кликните правой кнопкой мыши и в контекстном меню выберите '''Read/Write Definition'''.


Заполните параметры опроса регистра:
* '''Slave id''' — modbus адрес устройства, напечатан на наклейке и имеет вид «Addr: XX».
* '''Function''' — мы хотим считать holding-регистр, поэтому выберите '''03: Read Holding Registers (4x)'''. Тип регистра можно узнать из таблицы в документации на устройство.
* '''Address mode''' — формат адреса регистра. Зависит от того, в каком виде представлен адрес регистра в документации на устройство.
* '''Address''' — адрес регистра можно взять из таблицы регистров устройства. Мы считаем общий для всех наших устройств регистр — 110. Список общих регистров можно посмотреть на странице [[Common_Modbus_Registers|Общие Modbus регистры]]. Обратите внимание на формат адреса — в нашем случае он десятичный. Если формат будет в шестнадцатеричном формате, то измените значение настройки '''Address mode'''.
* '''Quantity''' — количество считываемых последовательно регистров, начиная с регистра, указанного в поле '''Address'''. Мы будем считывать один регистр — установите значение «1».
* '''Scan Rate''' — период опроса регистра. Оставьте по умолчанию.
* '''Address in Cell''' — если вы хотите вывести адрес регистра в ячейку рядом со значением — отметьте этот флажок.


Остальные значения оставьте по умолчанию. Нажмите кнопку '''OK'''.
== Работа с программой modbus_client ==
Для работы с modbus-утройством используется утилита [[Modbus-client| modbus_client]].  


[[File:Modbys poll 03-test3.png|450px|thumb|none|Считанное значение общего регистра с адресом «100»]]
Скачайте [https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb пакет для настольных компьютеров с Linux].


==== Считывание нескольких регистров подряд ====
Перейдите в папку со скаченным пакетом и установите его командой:
<syntaxhighlight lang="bash">
sudo apt install ./modbus-utils_1.2_amd64.deb
</syntaxhighlight>


Считаем значение параметра «Прямая активная энергия для фазы L1». Находим его в [[WB-MAP3E_Data_Registers|таблице регистров WM-MAP3E]]: тип параметра — Input, разрядность u64 (занимает 4 регистра), адрес первого регистра — 0x1204.
Также автоматически должен установиться пакет <code>libmodbus</code>, если этого не произошло установите его из репозитория apt.


Заполните параметры опроса регистров:
Как работать и примеры использования смотрите в статье[[Modbus-client| modbus_client]].
* '''Slave id''' — 38.
* '''Function''' — мы хотим считать input-регистр, поэтому выберите '''04: Read Input Registers (3x)'''.
* '''Address mode''' — так как адрес первого регистра в шестнадцатеричном формате, выберите '''Hex'''.
* '''Address''' — 1204. Адрес вводится без «0x».
* '''Quantity''' — значение хранится в четырех регистрах, поэтому установите «4».
* '''Address in Cell''' — установим флажок, чтобы вывести адреса регистров в ячейки.
 
Остальные значения оставьте по умолчанию. Нажимаем кнопку '''OK'''.
 
Так как значение хранится в нескольких регистрах, то конечный результат нужно вычислить. Вы можете [[WB-MAP12H_Data_Registers|вычислить значение вручную]] или автоматически конвертировать. Чтобы конвертировать значение регистров в десятичный вид, перейдите в меню '''View''' → выберите '''64 Bit Unsigned''' → '''Little-endian'''. Теперь десятичное значение будет отображено в первом регистре последовательности.
 
<gallery mode="packed" heights="320px">
File:Modbys poll 05-energy_asis.png|Считанный параметр «Прямая активная энергия для фазы L1» из счетчика WM-MAP3E. Шестнадцатеричный вид.
File:Modbys poll 06-energy_format.png|Переключение отображения параметров в десятичный вид
File:Modbys_poll_06-energy_decimal.png|Считанный параметр «Прямая активная энергия для фазы L1» из счетчика WM-MAP3E. Десятичный вид.
</gallery>
 
=== Запись в регистр ===
Для демонстрации записи в регистр, изменим адрес modbus-устройства.
 
Откройте окно опроса устройства и вызовите окно записи данных:
* откройте новое окно опроса устройства: меню '''File''' → '''New''';
* выберите в главном меню '''Functions''' → '''Write Single Register'''.
 
В открывшемся окне заполните поля:
* '''Slave id''' — введите текущий адрес устройства;
* '''Address''' — введите регистр, где хранится адрес modbus — 128 (десятичный);
* '''Value''' — введите новый адрес устройства;
* '''Use Function''' — установите значение '''06: Write single register'''.
 
Для отправки данных в устройство нажмите кнопку '''Send'''.
 
[[File:Usbrs485-4.PNG|450px|thumb|none||Запись нового адреса modbus-устройства]]

Версия 10:53, 16 июня 2022

Схема подключения modbus-устройств через адаптер USB-RS485. Если у адаптера есть клемма GND — подключите её к клемме GND modbus-устройства

Аппаратная часть

Большинство устройств Wiren Board могут работать без управления контроллером — достаточно подать питание на клеммы «V+» и «GND». Но для их настройки и считывания данных потребуется подключиться к ним по протоколу Modbus. Для этого вы можете использовать компьютер с ОС Windows или Linux и адаптер USB-RS485.

Чтобы начать обмен с modbus-устройством, нужно клеммы A и B устройства подключить ко входам адаптера, подать на устройство питание и настроить программное обеспечение на компьютере.

Подготовка к работе

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

Программы для работы по протоколу Modbus

Для работы с устройствами по протоколу Modbus мы рекомендуем использовать программу Rilheva Modbus Poll. Эта программа бесплатна, не требует установки, имеет понятный интерфейс и возможность сохранения настроек обмена и конфигурации регистров.

Программа написана для ОС Windows. Однако ОС Linux программа может быть запущена с помощью эмулятора wine и указанием пути к исполняемому файлу:

wine ~/RilhevaModbusPoll_1.0.7/RilhevaModbusPoll.exe

Для запуска использовалась программа wine версии 7.0.

Можно также использовать утилиты Modbus Poll из комплекта Modbus Tools (программа платная, но с бесплатным пробным периодом в 30 дней) и termite (есть «Pro» и «Free» версия) в ОС Windows и утилиту modbus_client в ОС Linux.

Выбор порта

В ОС Windows узнать, к какому порту у вас подключен адаптер, можно в диспетчере устройств. Найдите в дереве тип устройств Порты (COM и LPT), разверните ветку и найдите в ней свой адаптер. Если устройство выделено восклицательным знаком — это значит, что драйвер не был установлен автоматически. Установите его вручную по инструкции производителя.

В ОС Linux порт можно узнать с помощью команды команды dmesg -wH, которую нужно запустить перед физическим подключением USB-адаптера. В диагностических сообщениях будет выведено сообщение об обнаружении адаптера и назначении ему порта:

[  +7,705022] usb 3-7: new full-speed USB device number 6 using xhci_hcd
[  +0,149142] usb 3-7: New USB device found, idVendor=1a86, idProduct=7523, bcdDevice= 2.62
[  +0,000014] usb 3-7: New USB device strings: Mfr=0, Product=2, SerialNumber=0
[  +0,000005] usb 3-7: Product: USB2.0-Serial
[  +0,001500] ch341 3-7:1.0: ch341-uart converter detected
[  +0,000549] usb 3-7: ch341-uart converter now attached to ttyUSB0

В данном примере был назначен порт /dev/ttyUSB0. В интерфейсе программы Rilheva Modbus Poll для адаптера обычно нужно выбрать COM-порт с самым большим номером. Чтобы проверить правильность выбора порта в Linux, нужно в пользовательской директории со списком портов эмулятора wine (~/.wine/dosdevices) найти файл, который является символической ссылкой на реальный USB-порт, к которому подключен адаптер.

Работа с программой Rilheva Modbus Poll

Создание собственной конфигурации

Для начала работы с modbus-модулем нужно настроить параметры обмена: выбрать порт, а также скорость, четность и количество стопбитов в соответствии с настройками модуля, таймаут ответа и частоту запросов. Затем требуется добавить регистры устройства, которые необходимо опрашивать. Нажмите кнопку Add register и в появившемся диалоговом окне заполните поля в соответствии с картой регистров используемого модуля. Для регистров, значения которых нужно изменить снимите галочку Read only. Подтвердите правильность ввода, нажав на кнопку OK. Можно добавлять в список опроса сразу несколько регистров одного типа, а также задавать множитель, сдвиг и количество десятичных знаков для значения регистра.

Для начала опроса регистров нужно нажать кнопку Connect. Состояния регистров примут актуальные значения. При необходимости изменения значения регистров типа holding или coil задайте его в поле Current value. Для прекращения опроса регистров нужно нажать Disconnect.

Конфигурирование модулей Wirenboard

Чтобы избавить пользователей от необходимости создавать шаблон опроса регистров самостоятельно мы подготовили файл файл с общими регистрами для всех устройств, а также файлы с набором основных регистров настройки для модулей реле WB-MR6xx, WB-MR3xx, модуля диммера WB-MDM3, модуля диммера светодиодных лент WB-MRGBW-D.

После запуска программы нужно выбрать файл конфигурации регистров соответственно модулю. Все настойки обмена будут заполнены для работы с параметрами модуля по умолчанию. Если какие-либо настройки устройства были изменены ранее, то установите соответствующие значения. Также нужно задать адрес устройства (у всех устройств он разный) и выбрать используемый COM-порт. Для начала опроса регистров нужно нажать кнопку Connect. Состояния регистров примут актуальные значения. При необходимости изменения значения регистров типа holding или coil задайте его в поле Current value. Для прекращения опроса регистров нужно нажать Disconnect.

Файлы регистров модулей

Файл с общими для всех Modbus-устройств Wiren Board регистрами:
Общие для всех Modbus-устройств Wiren Board регистры

Файлы регистров и настроек для Modbus-модулей Wirenboard по типам:
WB-MRGBW-D fw3 (4-канальный диммер светодиодных лент)
WB-MR6CU v.2, WB-MRPS6 (6-канальный модуль реле)
WB-MR6C v.2, WB-MR6LV/x, WB-MR6HV/x, WB-MR6C/NC (6-канальный модуль реле)
WB-MR3LV/x, WB-MR3HV/x, WB-MRWL3 (3-канальный модуль реле)
WB-MDM3 (3-канальный диммер)



Работа с программой modbus_client

Для работы с modbus-утройством используется утилита modbus_client.

Скачайте пакет для настольных компьютеров с Linux.

Перейдите в папку со скаченным пакетом и установите его командой:

sudo apt install ./modbus-utils_1.2_amd64.deb

Также автоматически должен установиться пакет libmodbus, если этого не произошло — установите его из репозитория apt.

Как работать и примеры использования смотрите в статье modbus_client.