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

Материал из Wiren Board
(не показана 41 промежуточная версия 5 участников)
Строка 3: Строка 3:
== Аппаратная часть ==
== Аппаратная часть ==


Большинство устройств Wiren Board могут работать без управления контроллером — достаточно подать питание на клеммы «V+» и «GND». Но для их настройки и считывания данных потребуется подключиться к ним по протоколу Modbus. Для этого вы можете использовать компьютер с ОС Windows или Linux и адаптер USB-RS485.
Большинство устройств Wiren Board могут работать без управления контроллером, но для их настройки потребуется подключиться к ним по протоколу Modbus. Для этого вы можете использовать компьютер с ОС Windows или Linux и преобразователь интерфейса USB-RS-485, например, [[WB-USBRS485 v.1 Interface Converter | WB-USB485 ]].


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


== Подготовка к работе ==
== Подготовка к работе ==
Независимо от используемой операционной системы вам нужно знать [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] устройства, [[Протокол Modbus#Коды функций чтения и записи регистров|коды функций]] чтения и записи регистров, а также адреса регистров устройства. Перечень общих для всех устройств Wiren Board регистров можно найти в [[Common_Modbus_Registers | таблице общих регистров]]. Полный список регистров для каждого устройства смотрите в документации к нему.
Перед настройкой устройства вам нужно знать:
# [[Определение и изменение Modbus-адреса устройств Wirenboard | modbus-адрес]] устройства,  
# [[Протокол Modbus#Коды функций чтения и записи регистров|коды функций]] чтения и записи регистров,  
# адреса регистров устройства.  
 
Перечень общих для всех устройств Wiren Board регистров можно найти в [[Common_Modbus_Registers | таблице общих регистров]]. Полный список регистров для каждого устройства смотрите в документации к нему.


== Программы для работы по протоколу Modbus ==
== Программы для работы по протоколу Modbus ==
Для работы с устройствами по протоколу Modbus мы рекомендуем использовать программу <b>[https://www.rilheva.com/rilheva-modbus-poll-desktop-edition/ Rilheva Modbus Poll]</b>. Эта программа бесплатна, не требует установки, имеет понятный интерфейс и возможность сохранения настроек обмена и конфигурации регистров.  
[[File:rilheva-modbus-poll-interface.png|450px|thumb|right|Интерфейс программы Rilheva Modbus Poll]]
Мы рекомендуем использовать программу <b>[https://www.rilheva.com/rilheva-modbus-poll-desktop-edition/ Rilheva Modbus Poll]</b>. Она бесплатна, не требует установки, имеет понятный интерфейс и возможность сохранения настроек обмена и конфигурации регистров.  


Программа написана для ОС Windows. Однако ОС Linux программа может быть запущена с помощью эмулятора [https://www.winehq.org/ wine] и указанием пути к исполняемому файлу:
Программа написана для ОС Windows. На ОС Linux программа может быть запущена с помощью эмулятора [https://www.winehq.org/ wine] (проверено на wine 7.0) и указанием пути к исполняемому файлу:
<syntaxhighlight lang="console">
<syntaxhighlight lang="console">
wine ~/RilhevaModbusPoll_1.0.7/RilhevaModbusPoll.exe
wine ~/RilhevaModbusPoll_1.0.7/RilhevaModbusPoll.exe
</syntaxhighlight>
</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.
Также можно использовать утилиты [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.


== Выбор порта ==
== Выбор порта ==
Строка 34: Строка 39:
</syntaxhighlight>
</syntaxhighlight>
В данном примере был назначен порт /dev/ttyUSB0.  
В данном примере был назначен порт /dev/ttyUSB0.  
В интерфейсе программы '''Rilheva Modbus Poll''' для адаптера обычно нужно выбрать COM-порт с самым большим номером. Чтобы проверить правильность выбора порта в Linux, нужно в пользовательской директории со списком портов эмулятора wine (<code>~/.wine/dosdevices</code>) найти файл, который является символической ссылкой на реальный USB-порт, к которому подключен адаптер.
В интерфейсе программы '''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">
Строка 41: Строка 47:


== Работа с программой Rilheva Modbus Poll ==
== Работа с программой Rilheva Modbus Poll ==
=== Использование готовых конфигураций регистров для модулей Wiren Board ===
Для упрощения настройки наших устройств без контроллера Wiren Board, мы написали готовые шаблоны для программы Rilheva Modbus Poll, лежат в [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates репозитории wb-community].
Использование:
# Скачайте файл конфигурации с расширением ''.rilmp'' к себе на компьютер.
# Запустите программу Rilheva Modbus Poll и загрузите в неё файл конфигурации.
# Настройки обмена будут заполнены значениями по умолчанию, при необходимости, измените их.
# Укажите modbus-адрес устройства и выберите используемый последовательный порт.
# Запустите опрос устройства, для этого нажмите кнопку '''Connect'''. Значения регистров из будут показаны в таблице.
# Установите нужные значения в поле '''Current value''', они будут сразу отправлены в устройство.
# Остановите опрос кнопкой '''Disconnect'''.


<gallery mode="packed" heights="150px">
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>


 
Шаблоны для некоторых Modbus-устройств Wiren Board:
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/common-registers-wb-device.rilmp Универсальный шаблон общих регистров: серийный номер и параметры подключения]
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/wb-mr6xx-with-inputs.rilmp WB-MR6C v.2, WB-MR6LV/x, WB-MR6HV/x, WB-MR6C/NC (6-канальный модуль реле)]
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/wb-mr3xx-with-inputs.rilmp WB-MR3LV/x, WB-MR3HV/x, WB-MRWL3  (3-канальный модуль реле)]
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/wb-mr6xx-without-inputs.rilmp WB-MR6CU v.2, WB-MRPS6 (6-канальный модуль реле)]
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/wb-mrgbw-d-fw3-registers.rilmp WB-MRGBW-D fw3 (4-канальный диммер светодиодных лент c прошивкой 3.x)]
* [https://github.com/wirenboard/wb-community/tree/main/templates/rilheva-modbus-poll/templates/wb-mdm3.rilmp WB-MDM3 (3-канальный диммер)]
* [https://github.com/wirenboard/wb-community/blob/main/templates/rilheva-modbus-poll/templates/wb-mai6.rilmp WB-MAI6]


=== Создание собственной конфигурации ===
=== Создание собственной конфигурации ===
Для начала работы с modbus-модулем нужно настроить параметры обмена: выбрать порт, а также скорость, четность и количество стопбитов в соответствии с настройками модуля, таймаут ответа и частоту запросов. Затем требуется добавить регистры устройства, которые необходимо опрашивать. Нажмите кнопку <b>Add register</b> и в появившемся диалоговом окне заполните поля в соответствии с картой регистров используемого модуля. Для регистров, значения которых нужно изменить снимите галочку <b>Read only</b>. Подтвердите правильность ввода, нажав на кнопку <b>OK</b>. Можно добавлять в список опроса сразу несколько регистров одного типа, а также задавать множитель, сдвиг и количество десятичных знаков для значения регистра.
# Выберите в главном окне программы Rilheva Modbus Poll подключение к последовательному порту и укажите номер порта.
# Настройте параметры обмена: скорость, четность, количество стопбитов в соответствии с настройками модуля, а также таймаут ответа и частоту повторения запросов.  
# Добавьте регистры устройства, которые необходимо опрашивать. Нажмите кнопку '''Add register''' и в появившемся диалоговом окне заполните поля в соответствии с картой регистров используемого модуля:
#* Address — адрес регистра в десятичном формате.
#* Alias — понятное описание регистра.
#* Read only — запрет на запись значений в регистр. Для регистров, значения которых нужно изменять снимите галочку.
#* Read function — выбор типа регистра и соответствующей modbus-функции для его опроса.
#* Type — задает формат данных.
#* Multiplier — коэффициент, на который умножается значение регистра для удобного отображения.
#* Offset — значение, которое прибавляется к значению регистра для удобного отображения.
#* Decimal places — количество десятичных знаков при отображении.
#* Add further registers with the same kind — опция позволяет добавить сразу несколько регистров одного типа в список опроса.
# Запустите опрос устройства, для этого нажмите кнопку '''Connect'''.
# Установите нужные значения в поле '''Current value''', они будут сразу отправлены в устройство.
# Остановите опрос кнопкой '''Disconnect'''.


Для начала опроса регистров нужно нажать кнопку <b>Connect</b>. Состояния регистров примут актуальные значения. При необходимости изменения значения регистров типа <code>holding</code> или <code>coil</code> задайте его в поле <code>Current value</code>. Для прекращения опроса регистров нужно нажать <b>Disconnect</b>.
Рассмотрим работу с устройством по протоколу Modbus RTU на примере модуля реле [[WB-MR6C_v.2_Modbus_Relay_Modules | WB-MR6C v.2]]. Считаем состояние выхода 1, счетчик срабатываний входа 1 и серийный номер модуля:
# В [[Relay_Module_Modbus_Management | таблице регистров модуля реле]] найдите описание этих регистров:
#* состояние выхода 1 реле: адрес регистра 0, тип coil, формат bool
#* счетчик срабатываний входа 1: адрес регистра 32, тип input, формат u16
#* серийный номер модуля: адреса регистров 270, 271, тип input, формат u32
# Впишите эти параметры в настройках опроса регистров и включите опрос.  
# Если параметры обмена и конфигурация регистров корректны, то в поле '''Current value''' отобразится содержимое регистров.  
# Внесите изменения и остановите опрос.


Рассмотрим работу с устройством по протоколу Modbus RTU на примере модуля реле [[WB-MR6C_v.2_Modbus_Relay_Modules | WB-MR6C v.2]]. Считаем состояние выхода 1, счетчик срабатываний входа 1 и серийный номер модуля. Для этого в [[Relay_Module_Modbus_Management | таблице регистров модуля реле]] находим данные этих регистров:
Конфигурацию можно сохранить и использовать её для настройки таких же устройcтв.


* состояние выхода 1 реле: адрес регистра 0, тип coil, формат bool
<gallery mode="packed" heights="150px" caption="Пример опроса устройства">
* счетчик срабатываний входа 1: адрес регистра 32, тип input, формат u16
* серийный номер модуля: адреса регистров 270, 271, тип input, формат u32
 
Задаем эти параметры в настройках регистров опроса программы и включаем опрос. Если параметры обмена и конфигурация регистров корректны, то в поле <code>Current value</code> отобразится содержимое регистров.
 
<gallery mode="traditional" widths ="350px" heights="200px">
Image: Rilheva-modbus-poll-register1-config.png | Конфигурирование опроса регистра состояния выхода 1 реле
Image: Rilheva-modbus-poll-register1-config.png | Конфигурирование опроса регистра состояния выхода 1 реле
Image: Rilheva-modbus-poll-register2-config.png | Конфигурирование опроса регистра счетчика срабатываний входа 1
Image: Rilheva-modbus-poll-register2-config.png | Конфигурирование опроса регистра счетчика срабатываний входа 1
Image: Rilheva-modbus-poll-register3-config.png | Конфигурирование опроса регистра серийного номер модуля
Image: Rilheva-modbus-poll-register3-config.png | Конфигурирование опроса регистра серийного номера модуля
Image: Rilheva-modbus-poll-register-polling.png | Опрос регистров устройства Wirenboard
Image: Rilheva-modbus-poll-register-polling.png | Опрос регистров устройства Wirenboard
</gallery>
</gallery>
=== Использование готовых конфигураций регистров для модулей 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>.
<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>
==== Файлы конфигураций регистров модулей Wirenboard ====
Файл с общими для всех Modbus-устройств Wiren Board регистрами:<br>
[[Media:Common-registers-wb-device.zip | Общие для всех Modbus-устройств Wiren Board регистры ]]
Файлы регистров и настроек для Modbus-модулей Wirenboard по типам: <br>
[[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>


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


Для этого скачайте [https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb пакет для настольных компьютеров с Linux].
Для этого скачайте [https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb пакет для настольных компьютеров с Linux].
Строка 99: Строка 120:
Также автоматически должен установиться пакет <code>libmodbus</code>, если этого не произошло — установите его из репозитория apt.
Также автоматически должен установиться пакет <code>libmodbus</code>, если этого не произошло — установите его из репозитория apt.


Как работать и примеры использования смотрите в статье[[Modbus-client| modbus_client]].
Как работать и примеры использования смотрите в статье [[Modbus-client| modbus_client]].

Версия 14:49, 2 марта 2023

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

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

Большинство устройств Wiren Board могут работать без управления контроллером, но для их настройки потребуется подключиться к ним по протоколу Modbus. Для этого вы можете использовать компьютер с ОС Windows или Linux и преобразователь интерфейса USB-RS-485, например, WB-USB485 .

Для начала работы надо клеммы A, B и GND устройства подключить к входам адаптера, подать на устройство питание и настроить программное обеспечение на компьютере.

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

Перед настройкой устройства вам нужно знать:

  1. modbus-адрес устройства,
  2. коды функций чтения и записи регистров,
  3. адреса регистров устройства.

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

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

Интерфейс программы Rilheva Modbus Poll

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

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

wine ~/RilhevaModbusPoll_1.0.7/RilhevaModbusPoll.exe

Также можно использовать утилиты 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

Использование готовых конфигураций регистров для модулей Wiren Board

Для упрощения настройки наших устройств без контроллера Wiren Board, мы написали готовые шаблоны для программы Rilheva Modbus Poll, лежат в репозитории wb-community. Использование:

  1. Скачайте файл конфигурации с расширением .rilmp к себе на компьютер.
  2. Запустите программу Rilheva Modbus Poll и загрузите в неё файл конфигурации.
  3. Настройки обмена будут заполнены значениями по умолчанию, при необходимости, измените их.
  4. Укажите modbus-адрес устройства и выберите используемый последовательный порт.
  5. Запустите опрос устройства, для этого нажмите кнопку Connect. Значения регистров из будут показаны в таблице.
  6. Установите нужные значения в поле Current value, они будут сразу отправлены в устройство.
  7. Остановите опрос кнопкой Disconnect.

Шаблоны для некоторых Modbus-устройств Wiren Board:

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

  1. Выберите в главном окне программы Rilheva Modbus Poll подключение к последовательному порту и укажите номер порта.
  2. Настройте параметры обмена: скорость, четность, количество стопбитов в соответствии с настройками модуля, а также таймаут ответа и частоту повторения запросов.
  3. Добавьте регистры устройства, которые необходимо опрашивать. Нажмите кнопку Add register и в появившемся диалоговом окне заполните поля в соответствии с картой регистров используемого модуля:
    • Address — адрес регистра в десятичном формате.
    • Alias — понятное описание регистра.
    • Read only — запрет на запись значений в регистр. Для регистров, значения которых нужно изменять снимите галочку.
    • Read function — выбор типа регистра и соответствующей modbus-функции для его опроса.
    • Type — задает формат данных.
    • Multiplier — коэффициент, на который умножается значение регистра для удобного отображения.
    • Offset — значение, которое прибавляется к значению регистра для удобного отображения.
    • Decimal places — количество десятичных знаков при отображении.
    • Add further registers with the same kind — опция позволяет добавить сразу несколько регистров одного типа в список опроса.
  4. Запустите опрос устройства, для этого нажмите кнопку Connect.
  5. Установите нужные значения в поле Current value, они будут сразу отправлены в устройство.
  6. Остановите опрос кнопкой Disconnect.

Рассмотрим работу с устройством по протоколу Modbus RTU на примере модуля реле WB-MR6C v.2. Считаем состояние выхода 1, счетчик срабатываний входа 1 и серийный номер модуля:

  1. В таблице регистров модуля реле найдите описание этих регистров:
    • состояние выхода 1 реле: адрес регистра 0, тип coil, формат bool
    • счетчик срабатываний входа 1: адрес регистра 32, тип input, формат u16
    • серийный номер модуля: адреса регистров 270, 271, тип input, формат u32
  2. Впишите эти параметры в настройках опроса регистров и включите опрос.
  3. Если параметры обмена и конфигурация регистров корректны, то в поле Current value отобразится содержимое регистров.
  4. Внесите изменения и остановите опрос.

Конфигурацию можно сохранить и использовать её для настройки таких же устройcтв.

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

Для работы с modbus-утройством в ОС Linux также можно использовать консольную утилиту modbus_client.

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

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

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

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

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