Перейти к содержанию

Навигация

Modbus-client: различия между версиями

17 470 байт добавлено ,  3 месяца назад
 
(не показано 19 промежуточных версий 3 участников)
Строка 2: Строка 2:
== Описание ==
== Описание ==
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
{{Wbincludes:Modbus client preparing for work}}
== Подготовка к работе ==
===Контроллер Wiren Board ===
{{note|note| С релиза wb-2310 на контроллеры предустановлена улучшенная утилита [https://github.com/wirenboard/modbus-utils-rpc modbus_client_rpc] — синтаксис идентичен ''modbus_client'', но работает через драйвер wb-mqtt-serial, поэтому можно читать и писать регистры устройств не останавливая драйвер.}}
 
Утилита modbus_client из пакета [https://github.com/wirenboard/modbus-utils modbus-utils] предустановлена на все контроллеры Wiren Board. Для использования утилиты нужно подключиться к контроллеру по протоколу [[SSH]].
 
Обычно порт RS-485 занят [[Драйвер wb-mqtt-serial | драйвером wb-mqtt-serial]], поэтому перед запуском <code>modbus_client</code> этот драйвер надо остановить:
 
<syntaxhighlight lang="bash">
systemctl stop wb-mqtt-serial # для Wiren Board 5 и позднее
systemctl stop wb-homa-modbus # для Wiren Board 4
 
</syntaxhighlight> После завершения работы с <code>modbus_client</code> запустите драйвер обратно: <source lang="bash">
systemctl start wb-mqtt-serial # для Wiren Board 5 и позднее
systemctl start wb-homa-modbus # для Wiren Board 4
</source>
 
=== Настольный компьютер с Linux ===
 
Скачайте [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.
 
Альтернативный способ собрать пакет из исходников, [https://support.wirenboard.com/t/nedostupno-redaktirovanie-nekotoryh-razdelov-v-wiki/14716/8 инструкция по сборке на портале поддержки].


== Аргументы командной строки ==
== Аргументы командной строки ==
{{note|info|Значения параметров (адрес устройства или регистра, таймаут, тип функции, значение для записи в регистр и т.д.) можно указывать как в шестнадцатеричном <code>0x**</code>, так и в десятичном виде}}
Значения параметров (адрес устройства или регистра, таймаут, тип функции, значение для записи в регистр и т.д.) можно указывать как в шестнадцатеричном <code>0x**</code>, так и в десятичном виде.


Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды:
Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды:
Строка 60: Строка 88:
| -r
| -r
| Задает начальный адрес для чтения или записи.
| Задает начальный адрес для чтения или записи.
| не
| нет
| 100
| 100
|-
|-
Строка 170: Строка 198:
Записываем новый адреса устройства в регистр <code>128</code>, используя функцию <code>0x06 (Write Single Register)</code>.
Записываем новый адреса устройства в регистр <code>128</code>, используя функцию <code>0x06 (Write Single Register)</code>.


{{note|warn|В примере используется широковещательный адрес <code>0</code>. Использование примера в таком виде ''изменит адрес на всех устройствах Wiren Board'', подключенных к порту <code>/dev/ttyRS485-1</code>. Чтобы этого не произошло — отключите другие устройства от шины.}}
{{note|warn|В примере используется широковещательный адрес <code>0</code>. Использование примера в таком виде ''изменит адрес на всех устройствах Wiren Board'', подключенных к порту <code>/dev/ttyRS485-1</code>. Чтобы этого не произошло — отсоедините другие устройства от шины.}}
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0 -t0x06 -r128 2
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a0 -t0x06 -r128 2
</syntaxhighlight>
</syntaxhighlight>
Где <code>0</code> — широковещательный адрес, а <code>2</code> — адрес, который нужно задать.
Где <code>0</code> — широковещательный адрес, а <code>2</code> — адрес, который нужно задать.
Строка 190: Строка 218:
Пример '''неправильного''' использования команды:
Пример '''неправильного''' использования команды:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0 -t0x06 -r128
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a0 -t0x06 -r128
</syntaxhighlight>
</syntaxhighlight>


Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестное значение.
Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестное значение.


===Чтение сигнатуры устройства===
===Чтение модели устройства===
 
Модель устройства занимает 6 регистров начиная с 200. В прошивках с [[Modbus#Поддержка_быстрого_Modbus_в_прошивках | быстрым Modbus]] добавлены дополнительные регистры с 206 по 219.
Прочтем регистры релейного модуля WB-MR14 с адресом <code>1</code>, содержащие сигнатуру (модель) устройства: WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров.


====Чтение модели на старых прошивках====
Прочтем регистры релейного модуля WB-MR6C с адресом <code>1</code>, содержащие модель устройства: WBMR6C.
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6
</syntaxhighlight>
</syntaxhighlight>
Ответ:
Ответ:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Opening /dev/ttyAPP1 at 9600 bauds (N, 8, 2)
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[01][03][00][C8][00][06][44][36]
[87][03][00][C8][00][06][5B][90]
Waiting for a confirmation...
Waiting for a confirmation...
<01><03><0C><00><57><00><42><00><4D><00><52><00><31><00><34><D4><76>
<87><03><0C><00><57><00><42><00><4D><00><52><00><36><00><43><23><F3>
SUCCESS: read 6 of elements:
SUCCESS: read 6 of elements:
         Data: 0x0057 0x0042 0x004d 0x0052 0x0031 0x0034
         Data: 0x0057 0x0042 0x004d 0x0052 0x0036 0x0043
</syntaxhighlight>
</syntaxhighlight>


В ответе мы получили шесть 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их:
В ответе мы получили шесть 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
echo -e $(modbus_client -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6 | grep Data | sed -e 's/.*Data://' -e 's/ 0x00/\\x/g')
echo -e $(modbus_client -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6 | grep Data | sed -e 's/.*Data://' -e 's/ 0x00/\\x/g')
</syntaxhighlight>
Ответ:
<syntaxhighlight lang="bash">
WBMR6C
</syntaxhighlight>
 
====Чтение модели на прошивках с быстрым Modbus====
В прошивках с [[Modbus#Поддержка_быстрого_Modbus_в_прошивках | быстрым Modbus]] нужно считать 20 регистров (200-219).
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 20
</syntaxhighlight>
Ответ:
<syntaxhighlight lang="bash">
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[87][03][00][C8][00][14][DB][9D]
Waiting for a confirmation...
<87><03><28><00><57><00><42><00><4D><00><52><00><36><00><43><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><00><94><A3>
SUCCESS: read 20 of elements:
        Data: 0x0057 0x0042 0x004d 0x0052 0x0036 0x0043 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000 0x0000
</syntaxhighlight>
Или сразу преобразованный вид:
<syntaxhighlight lang="bash">
echo -e $(modbus_client -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 20 | grep Data | sed -e 's/.*Data://' -e 's/ 0x00/\\x/g')
</syntaxhighlight>
</syntaxhighlight>
Ответ:
Ответ:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
WBMR14
WBMR6C
</syntaxhighlight>
</syntaxhighlight>


Строка 225: Строка 277:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
echo -e $(modbus_client -mrtu -pnone -s2 /dev/ttyRS485-1 -a189 -t0x03 -r250 -c 16 | grep Data | sed -e 's/.*Data://' -e 's/ 0x00/\\x/g')
echo -e $(modbus_client -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a189 -t0x03 -r250 -c 16 | grep Data | sed -e 's/.*Data://' -e 's/ 0x00/\\x/g')
</syntaxhighlight>
</syntaxhighlight>


В результате выполнения команды получаем строку, например '''1.3.1'''.
В результате выполнения команды получаем строку, например '''1.3.1'''.
=== Настройка параметров трансформаторов ===
Для настройки трансформаторов запишите нужные значения в регистры счётчика. Номера регистров смотрите в карте регистров счётчика.
В примере задаются параметры трёх трансформаторов, подключенных к первому каналу счётчика WB-MAP12E(H).
{| class="wikitable" style="text-align: center;"
!Трансформатор на фазе
!Коэффициент трансформации
!Фазовый сдвиг
|-
|L1
|3001
|501
|-
|L2
|3002
|502
|-
|L3
|3003
|503
|}
Настройки записываются в память конкретного WB-MAP один раз:
<syntaxhighlight lang="bash">
$ modbus_client --debug -mrtu -pnone -b9600 -s2 /dev/ttyRS485-2 -a1 -t0x10 -r0x1460 3001 3002 3003 501 502 503
</syntaxhighlight>


===Включение реле релейного модуля===
===Включение реле релейного модуля===
Строка 234: Строка 313:
На модуле WB-MR14 включим реле с номером 6 (адреса регистров флагов начинаются с нуля, помним об этом!). Используем для этого команду <code>0x05 (Write Single Coil)</code>:
На модуле WB-MR14 включим реле с номером 6 (адреса регистров флагов начинаются с нуля, помним об этом!). Используем для этого команду <code>0x05 (Write Single Coil)</code>:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x05 -r5 1
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x05 -r5 1
</syntaxhighlight>
</syntaxhighlight>


Строка 254: Строка 333:


<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x0F -r0 -c 14 255 0 255 0 255 0 255 0 255 0 255 0 255 0
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x0F -r0 -c 14 255 0 255 0 255 0 255 0 255 0 255 0 255 0
</syntaxhighlight>
</syntaxhighlight>
Ответ:
Ответ:
Строка 283: Строка 362:


Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]].
Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]].
== Настройка взаимодействия входов и выходов реле ==
=== Выключатели с фиксацией ===
Чтобы перевести входы в режим «Выключатель с фиксацией», запишите в регистры настройки входов значение 1.
В примере мы изменим режим входов с 1 по 6 и аварийного входа 0 в устройстве с адресом <code>1</code>:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r9 1 1 1 1 1 1 1</syntaxhighlight>
Теперь входы функционируют в режиме «Выключатель с фиксацией», а активация выключателя, подключенного ко входу 0, выключит все реле.
=== Выключатели без фиксации ===
Чтобы перевести все входы в режим «Выключатель без фиксации», запишите в регистры настройки входов значение 0.
В примере мы изменим режим входов с 1 по 6 и аварийного входа 0 в устройстве с адресом <code>1</code>:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r9 0 0 0 0 0 0 0</syntaxhighlight>
Теперь входы функционируют в режиме «Выключатель без фиксации», а кратковременное нажатие на кнопку, подключенную ко входу 0, выключит все реле.
=== Отключить взаимодействие входов и реле ===
Для отключения взаимодействия входов и реле (например, если мы хотим управлять реле только через движок правил контроллера) запишем в регистры 9, 10, 11, 12, 13, 14 значение 3:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r9 3 3 3 3 3 3</syntaxhighlight>
Теперь нажатия на кнопки или переключение выключателей не будет изменять состояние реле: ими можно управлять только программно, по Modbus.
При этом функция аварийного входа 0 сохраняется: кратковременное нажатие на кнопку, подключенную ко входу 0, выключит все реле.
Если мы хотим отключить и вход 0, то запишем значение 3 в регистр 16 устройства с адресом <code>1</code>:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r16 3</syntaxhighlight>
=== Использование Mapping-матрицы ===
Более сложные сценарии взаимодействия входов с реле можно реализовать с помощью '''[[I/O_Mapping_Matrix|Mapping-матрицы]]'''.
Для этого запишем в регистры настройки взаимодействия входов/выходов — значение 4:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r9 4 4 4 4 4 4 </syntaxhighlight>
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r16 4</syntaxhighlight>
Для настройки Mapping-матрицы нужно знать номер регистра, который отвечает за взаимодействие входа и выхода, и код, который нужно записать в этот регистр. Эту информацию можно найти на странице описания [[I/O_Mapping_Matrix|Mapping-матриц]].
В заводской поставке Mapping-матрица заполнена нулями. Если вы не уверены в этом и хотите стереть всю матрицу, запишите 0 в каждый из 64 holding-регистров, начиная с 384:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r384 $(printf ' 0%.0s' {1..64})</syntaxhighlight>
=== Вход 0 включает и выключает все реле ===
Запрограммируем матрицу таким образом, чтобы вход 0, работая в режиме выключателя без фиксации включал и отключал все реле модуля при замыкании.
Для этого обратимся к карте регистров mapping-матрицы и увидим, что входу 0 соответствуют регистры 440 — 447. Причем за взаимодействие со входами 1 — 6 отвечают регистры 440 — 445.
Мы хотим, чтобы вход работал, как выключатель без фиксации и срабатывал при нажатии, а при размыкании ничего бы не происходило. При каждом нажатии состояние всех реле должно инвертироваться. Это соответствует комбинации 11 00: (12, 0x0C) — Изменить состояние выхода при замыкании:
[[File:Mm_1100.png|frameless|270px]]<br>
Запишем в регистры 440 — 445 значение 12:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r440 12 12 12 12 12 12</syntaxhighlight>
Проверим работу: при первом замыкании входа 0 все реле включаются, при втором — все реле выключаются.
=== Инвертированный выключатель с фиксацией === <!--T:39-->
Настроим входы таким образом, чтобы при замкнутых входах реле были бы выключены, а при разомкнутых -- включены.
Для этого при замыкании входа (передний фронт) соответствующий выход должен выключаться (01), а при размыкании входа (задний фронт) — включаться (10). Это соответствует значению 6: [[File:Mm_0110.png|frameless|270px]]<br>
В матрице нужные регистры взаимодействия вход 1 — выход 1, вход 2 — выход 2 и т.д. расположены по диагонали. Это регистры 384, 393, 402, 411, 420, 429. В них надо записать значение 6:
<syntaxhighlight lang="bash">for i in 384 393 402 411 420 429; do modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r$i 6; done</syntaxhighlight>
Обратите внимание: изменение состояния реле происходят только при изменении состояния ввода.
=== Обработка типов нажатий ===
Матрицы типов нажатий можно посмотреть на странице [[I/O Mapping Matrix | Mapping-матрица]].
Чтобы понять принцип, рассмотрим пример. К '''входу 2''' реле подключена кнопка и нам нужно настроить так, чтобы при двойном нажатии на эту кнопку включалось '''реле 5''', а при коротком переключалось '''реле 3'''.
Запишем в регистр настройки взаимодействия входов/выходов входа '''2''' значение '''6''':
<syntaxhighlight lang="bash">
modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r10 6 </syntaxhighlight>
Теперь запишем в соответствующий входу '''2''' и выходу '''5''' регистр из матрицы двойных нажатий действие «10 — включить» (dec = 2), а в соответствующий входу '''2''' и выходу '''3''' регистр из матрицы коротких нажатий действие «11 — инвертировать значение» (dec = 3):
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r684 2</syntaxhighlight>
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x06 -r554 3</syntaxhighlight>
Аналогично настраиваются другие типы нажатий.
== Датчик протечки ==
'''ВНИМАНИЕ:''' используемый в примере '''режим 5''' — восстановление состояния выхода через 20 минут, '''доступен только для''' [[WB-MWAC]].
Пусть датчик протечки подключен ко '''входу 1''', а '''реле 1 и 2''' управляют приводами шаровых кранов. '''Реле 3''' управляет сигнальной лампой или зуммером. При смачивании датчика протечки '''реле 1 и реле 2''' замыкаются и приводы закрывают шаровые краны. '''Реле 3''' замыкается и включает зуммер. '''Вход 2''' запрограммируем для сброса тревоги и открытия шаровых кранов.
Очистим mapping-матрицу:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r384 $(printf ' 0%.0s' {1..64})</syntaxhighlight>
Применим в нашем случае режим, когда состояние входа повторяется каждые 20 минут, для этого запишем в регистр 9 значение 5 (управлять в соответствии с mapping-матрицей, через 20 минут повторно имитировать состояние ввода), а в остальные — значение 4 (управлять в соответствии с mapping-матрицей).
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r9 5 4 4 4 4 4</syntaxhighlight>
Для входа датчика протечки (вход 1) используем режим 1000 (8) — включать при замыкании. [[File:Mm_1000.png|frameless|270px]]<br> Для входа кнопки сброса (вход 2) используем режим 0100 (4) — выключить при замыкании. [[File:Mm_0100.png|frameless|270px]]<br>
По карте mapping-регистров определяем, что для входа 1 надо записать значение 8 в регистры 384, 385, 386, а для входа 2 — записать значение 4 в регистры 392, 393, 394:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r384 8 8 8</syntaxhighlight>
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -b9600 -pnone -s2 /dev/ttyRS485-1 -a1 -t0x10 -r392 4 4 4</syntaxhighlight>
Проверка: замкнем вход 1 и iGND и оставим его замкнутым. Должны включиться реле 1, 2 и 3. Затем замкнем и разомкнем вход 2 — все три реле выключились. Ждем 20 минут. Поскольку вход 1 остается замкнутым (протечка не устранена), через 20 минут реле 1, 2 и 3 снова включатся.
Оставляя вход 1 замкнутым, выключим и включим питание реле: через 20 минут реле 1, 2 и 3 снова включатся.