Modbus-client: различия между версиями
(Отметить эту версию для перевода) |
Admin (обсуждение | вклад) |
||
(не показана 21 промежуточная версия 3 участников) | |||
Строка 1: | Строка 1: | ||
<languages/> | <languages/> | ||
<translate> | <translate> | ||
{{DISPLAYTITLE:modbus_client}} | |||
__FORCETOC__ | |||
<!--T:2--> | <!--T:2--> | ||
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки. | |||
Предустановлена на контроллерах Wiren Board. Версию для настольных компьютеров с Linux можно скачать здесь: [https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb]. | |||
<!--T: | == Необходимые действия перед запуском == <!--T:1--> | ||
* На контроллерах Wiren Board порт RS-485 обычно занят [[Драйвер wb-mqtt-serial | драйвером wb-mqtt-serial]]. Поэтому перед запуском <code>modbus_client</code> этот драйвер надо остановить: <syntaxhighlight lang="bash"> | |||
service wb-mqtt-serial stop # для Wiren Board 5 и позднее | |||
service wb-homa-modbus stop # для Wiren Board 4 | |||
</syntaxhighlight> После завершения работы с <code>modbus_client</code> запустите драйвер обратно: <source lang="bash"> | |||
service wb-mqtt-serial start # для Wiren Board 5 и позднее | |||
service wb-homa-modbus start # для Wiren Board 4 | |||
</source> | |||
* Когда через <code>modbus_client</code> записываете в регистры, не забывайте указывать само значение, которое нужно записать. Иначе в регистры может попасть случайная информация. | |||
== | == Аргументы командной строки == <!--T:5--> | ||
<!--T:6--> | <!--T:6--> | ||
Вызов modbus_client без аргументов выдает краткое описание возможных аргументов команды: | Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
modbus_client [--debug] [-m {rtu|tcp}] [-a<slave-addr=1>] [-c<read-no>=1] | modbus_client [--debug] [-m {rtu|tcp}] [-a<slave-addr=1>] [-c<read-no>=1] | ||
Строка 42: | Строка 44: | ||
<!--T:7--> | <!--T:7--> | ||
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. Функции аргументов: | ||
<!--T:8--> | <!--T:8--> | ||
* | * '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. | ||
* | * '''-m''' - определяет тип используемого протокола '''-mrtu''' — Modbus RTU, '''-mtcp''' — Modbus TCP. Он должен указываться первым в командной строке, или вторым, если первый аргумент — '''--debug''' или имя файла порта RS-485. | ||
* | * '''-a''' задает Modbus-адрес устройства, к которому мы обращаемся. Если аргумент не используется, то по умолчанию выбирается адрес 0x01. | ||
* | * '''-с''' определяет, какое количество элементов мы запрашиваем. По умолчанию — один. | ||
* | * '''-r''' задает начальный адрес для чтения или записи. По умолчанию используется значение 100 (0x64). | ||
* | * '''-t''' указывает код функции Modbus. Кратко они перечислены в выводе modbus_client, подробнее значения кодов описаны на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]]. | ||
* | * '''-o''' задает таймаут в миллисекундах (по умолчанию 1000). | ||
* | * '''-0''' (ноль) уменьшает на единицу адрес, задаваемый аргументом -r. Это может быть полезным при работе с устройствами с нестандартной адресацией, например, с диапазоном адресов 1 — 65536 вместо привычного 0 — 65535. | ||
<!--T:9--> | <!--T:9--> | ||
Строка 71: | Строка 73: | ||
<!--T:13--> | <!--T:13--> | ||
* '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер. | * '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер. | ||
<!--T:14--> | <!--T:14--> | ||
Далее следует имя файла порта RS-485 или адрес хоста, а в конце (факультативно, только для функций записи) — данные. | Далее следует имя файла порта RS-485 или адрес хоста, а в конце (факультативно, только для функций записи) — данные. | ||
== Примеры использования с оборудованием Wiren Board == <!--T:15--> | |||
===Проверка подключения к устройству и считывание адреса=== | |||
<!--T:21--> | |||
Все устройства Wiren Board с протоколом Modbus RTU хранят адрес в регистре 0x80, поэтому для проверки подключения удобно считывать именно его. | |||
<!--T: | Читаем содержимое регистра 0x80 с устройства с адреса 2 с помощью функции 0x03 (Read Holding Registers): | ||
<!--T:22--> | |||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a2 -t0x03 -r0x80</syntaxhighlight> | |||
Ответ: | |||
<syntaxhighlight lang="bash">Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | |||
[02][03][00][80][00][01][85][D1] | |||
Waiting for a confirmation... | |||
<02><03><02><00><02><7D><85> | |||
SUCCESS: read 1 of elements: | |||
Data: 0x0002</syntaxhighlight> | |||
===Запись нового адреса=== | |||
<!--T:17--> | <!--T:17--> | ||
Записываем новый адреса устройства в регистр 0x80, используя функцию 0x06 (Write Single Register): | |||
<!--T:18--> | <!--T:18--> | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ | <syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02</syntaxhighlight> | ||
Где 0x02 - адрес, который нужно задать. | Где 0x02 - адрес, который нужно задать. | ||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Data to write: 0x2 | <syntaxhighlight lang="bash">Data to write: 0x2 | ||
Opening /dev/ | Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | ||
[00][06][00][80][00][02][08][32] | [00][06][00][80][00][02][08][32] | ||
Waiting for a confirmation... | Waiting for a confirmation... | ||
Строка 106: | Строка 116: | ||
<!--T:20--> | <!--T:20--> | ||
Пример '''неправильного''' использования команды: | Пример '''неправильного''' использования команды: | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ | <syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80</syntaxhighlight> | ||
Здесь не | Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестный адрес. | ||
===Чтение сигнатуры устройства=== | |||
<!--T:23--> | <!--T:23--> | ||
Прочтем регистры релейного модуля WB-MR14 с адресом 0x01, содержащие сигнатуру устройства, WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров. | |||
<!--T:24--> | <!--T:24--> | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ | <syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6</syntaxhighlight> | ||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Opening /dev/ttyAPP1 at 9600 bauds (N, 8, 2) | <syntaxhighlight lang="bash">Opening /dev/ttyAPP1 at 9600 bauds (N, 8, 2) | ||
Строка 139: | Строка 136: | ||
<!--T:25--> | <!--T:25--> | ||
В ответе мы получили 6 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их, заменив начальные '''0x00''' на '''/x''' и удалив пробелы, к виду \x57 и т.д., который понятен команде echo, и выведем на экран получившееся: | В ответе мы получили 6 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их, заменив начальные '''0x00''' на '''/x''' и удалив пробелы, к виду \x57 и т.д., который понятен команде echo, и выведем на экран получившееся: | ||
<syntaxhighlight lang="bash">echo -e `modbus_client --debug -mrtu -pnone -s2 /dev/ | <syntaxhighlight lang="bash">echo -e `modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 \ | ||
-a1 -t0x03 -r200 -c 6 | \ | -a1 -t0x03 -r200 -c 6 | \ | ||
grep Data | sed -e 's/0x00/\\\x/g' -e 's/Data://' -e 's/\s//g'`| xxd -r -p </syntaxhighlight> | grep Data | sed -e 's/0x00/\\\x/g' -e 's/Data://' -e 's/\s//g'`| xxd -r -p </syntaxhighlight> | ||
Строка 148: | Строка 145: | ||
В старых версиях прошивки <syntaxhighlight lang="bash">| xxd -r -p</syntaxhighlight> не было нужно. | В старых версиях прошивки <syntaxhighlight lang="bash">| xxd -r -p</syntaxhighlight> не было нужно. | ||
===Включение реле релейного модуля=== | |||
<!--T:28--> | <!--T:28--> | ||
На модуле WB-MR14 включим реле с номером 6 (адреса регистрв флагов начинаются с нуля, помним об этом!). Используем для этого команду 0x05 (Write Single Coil): | |||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x05 -r0x05 0x01</syntaxhighlight> | |||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ | |||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Data to write: 0x1 | <syntaxhighlight lang="bash">Data to write: 0x1 | ||
Opening /dev/ | Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | ||
[01][05][00][05][FF][00][9C][3B] | [01][05][00][05][FF][00][9C][3B] | ||
Waiting for a confirmation... | Waiting for a confirmation... | ||
Строка 172: | Строка 159: | ||
<!--T:29--> | <!--T:29--> | ||
Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте. | Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте. | ||
===Одновременное включение нескольких реле=== | |||
<!--T:30--> | <!--T:30--> | ||
Включим все нечетные реле и выключим все четные. Для этого используем функцию 15 (Write Multiple Coils). В модуле всего 14 реле, так что мы должны передать значения для 14 регистров с 0 по 13. | |||
<!--T:31--> | <!--T:31--> | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ | <syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x0f -r0x00 -c 14 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000</syntaxhighlight> | ||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Data to write: 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 | <syntaxhighlight lang="bash">Data to write: 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 | ||
Opening /dev/ | Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | ||
[01][0F][00][00][00][0E][02][55][15][1A][97] | [01][0F][00][00][00][0E][02][55][15][1A][97] | ||
Waiting for a confirmation... | Waiting for a confirmation... | ||
<01><0F><00><00><00><0E><D4><0F> | <01><0F><00><00><00><0E><D4><0F> | ||
SUCCESS: written 14 elements!</syntaxhighlight> | SUCCESS: written 14 elements!</syntaxhighlight> | ||
<!--T:32--> | <!--T:32--> |
Версия 11:09, 25 мая 2020
modbus_client — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
Предустановлена на контроллерах Wiren Board. Версию для настольных компьютеров с Linux можно скачать здесь: https://github.com/contactless/modbus-utils/releases/download/1.2/modbus-utils_1.2_amd64.deb.
Необходимые действия перед запуском
- На контроллерах Wiren Board порт RS-485 обычно занят драйвером wb-mqtt-serial. Поэтому перед запуском
modbus_client
этот драйвер надо остановить:После завершения работы сservice wb-mqtt-serial stop # для Wiren Board 5 и позднее service wb-homa-modbus stop # для Wiren Board 4
modbus_client
запустите драйвер обратно:service wb-mqtt-serial start # для Wiren Board 5 и позднее service wb-homa-modbus start # для Wiren Board 4
- Когда через
modbus_client
записываете в регистры, не забывайте указывать само значение, которое нужно записать. Иначе в регистры может попасть случайная информация.
Аргументы командной строки
Вызов modbus_client
без аргументов выдает краткое описание возможных аргументов команды:
modbus_client [--debug] [-m {rtu|tcp}] [-a<slave-addr=1>] [-c<read-no>=1]
[-r<start-addr>=100] [-t<f-type>] [-o<timeout-ms>=1000] [{rtu-params|tcp-params}] serialport|host [<write-data>]
NOTE: if first reference address starts at 0, set -0
f-type:
(0x01) Read Coils, (0x02) Read Discrete Inputs, (0x05) Write Single Coil
(0x03) Read Holding Registers, (0x04) Read Input Registers, (0x06) WriteSingle Register
(0x0F) WriteMultipleCoils, (0x10) Write Multiple register
rtu-params:
b<baud-rate>=9600
d{7|8}<data-bits>=8
s{1|2}<stop-bits>=1
p{none|even|odd}=even
tcp-params:
p<port>=502
Examples (run with default mbServer at port 1502):
Write data: modbus_client --debug -mtcp -t0x10 -r0 -p1502 127.0.0.1 0x01 0x02 0x03
Read that data: modbus_client --debug -mtcp -t0x03 -r0 -p1502 127.0.0.1 -c3
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. Функции аргументов:
- --debug — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных.
- -m - определяет тип используемого протокола -mrtu — Modbus RTU, -mtcp — Modbus TCP. Он должен указываться первым в командной строке, или вторым, если первый аргумент — --debug или имя файла порта RS-485.
- -a задает Modbus-адрес устройства, к которому мы обращаемся. Если аргумент не используется, то по умолчанию выбирается адрес 0x01.
- -с определяет, какое количество элементов мы запрашиваем. По умолчанию — один.
- -r задает начальный адрес для чтения или записи. По умолчанию используется значение 100 (0x64).
- -t указывает код функции Modbus. Кратко они перечислены в выводе modbus_client, подробнее значения кодов описаны на странице Протокол Modbus.
- -o задает таймаут в миллисекундах (по умолчанию 1000).
- -0 (ноль) уменьшает на единицу адрес, задаваемый аргументом -r. Это может быть полезным при работе с устройствами с нестандартной адресацией, например, с диапазоном адресов 1 — 65536 вместо привычного 0 — 65535.
Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака '-' (минус).
Для Modbus RTU:
- -b — скорость передачи данных по последовательной линии (по умолчанию — 9600).
- -d — количество передаваемых бит данных (7 или 8, по умолчанию — 8).
- -s — количество стоповых битов (1 или 2, по умолчанию — 1).
- -p — контроль четности (-p none — нет проверки, -p even — передается бит контроля на четность, -p odd — передается бит контроля на нечетность). По умолчанию передается бит контроля на четность(E).
Для Modbus TCP:
- -p — номер TCP-порта устройства, с которым взаимодействует контроллер.
Далее следует имя файла порта RS-485 или адрес хоста, а в конце (факультативно, только для функций записи) — данные.
Примеры использования с оборудованием Wiren Board
Проверка подключения к устройству и считывание адреса
Все устройства Wiren Board с протоколом Modbus RTU хранят адрес в регистре 0x80, поэтому для проверки подключения удобно считывать именно его.
Читаем содержимое регистра 0x80 с устройства с адреса 2 с помощью функции 0x03 (Read Holding Registers):
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a2 -t0x03 -r0x80
Ответ:
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[02][03][00][80][00][01][85][D1]
Waiting for a confirmation...
<02><03><02><00><02><7D><85>
SUCCESS: read 1 of elements:
Data: 0x0002
Запись нового адреса
Записываем новый адреса устройства в регистр 0x80, используя функцию 0x06 (Write Single Register):
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02
Где 0x02 - адрес, который нужно задать. Ответ:
Data to write: 0x2
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[00][06][00][80][00][02][08][32]
Waiting for a confirmation...
ERROR Connection timed out: select
ERROR occured!
Сообщение об ошибке возникает всегда, когда запись производится на специальный адрес 0 (-a0x00). Теперь к устройству нужно обращаться по адресу 0x02.
Пример неправильного использования команды:
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80
Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестный адрес.
Чтение сигнатуры устройства
Прочтем регистры релейного модуля WB-MR14 с адресом 0x01, содержащие сигнатуру устройства, WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров.
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6
Ответ:
Opening /dev/ttyAPP1 at 9600 bauds (N, 8, 2)
[01][03][00][C8][00][06][44][36]
Waiting for a confirmation...
<01><03><0C><00><57><00><42><00><4D><00><52><00><31><00><34><D4><76>
SUCCESS: read 6 of elements:
Data: 0x0057 0x0042 0x004d 0x0052 0x0031 0x0034
В ответе мы получили 6 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их, заменив начальные 0x00 на /x и удалив пробелы, к виду \x57 и т.д., который понятен команде echo, и выведем на экран получившееся:
echo -e `modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 \
-a1 -t0x03 -r200 -c 6 | \
grep Data | sed -e 's/0x00/\\\x/g' -e 's/Data://' -e 's/\s//g'`| xxd -r -p
Ответ:
WBMR14
В старых версиях прошивки
| xxd -r -p
не было нужно.
Включение реле релейного модуля
На модуле WB-MR14 включим реле с номером 6 (адреса регистрв флагов начинаются с нуля, помним об этом!). Используем для этого команду 0x05 (Write Single Coil):
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x05 -r0x05 0x01
Ответ:
Data to write: 0x1
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[01][05][00][05][FF][00][9C][3B]
Waiting for a confirmation...
<01><05><00><05><FF><00><9C><3B>
SUCCESS: written 1 elements!
Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте.
Одновременное включение нескольких реле
Включим все нечетные реле и выключим все четные. Для этого используем функцию 15 (Write Multiple Coils). В модуле всего 14 реле, так что мы должны передать значения для 14 регистров с 0 по 13.
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x0f -r0x00 -c 14 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000 0x00FF 0x0000
Ответ:
Data to write: 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00 0xff 0x00
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2)
[01][0F][00][00][00][0E][02][55][15][1A][97]
Waiting for a confirmation...
<01><0F><00><00><00><0E><D4><0F>
SUCCESS: written 14 elements!
Обратите внимание на структуру данных запроса:
- [01] — адрес
- [0F] — код функции Write Multiple Coils
- [00][00] — адрес первого регистра флагов для записи
- [00][0E] — количество элементов для записи (14)
- [02] — количество байт данных (14 бит помещаются в 2 байтах)
- [55][15] — 01010101 00010101 (первое реле — младший бит первого байта, 8 реле — старший бит первого байта, 9 реле — младший бит второго байта)
- [1A][97] — CRC16
А так же на структуру ответа:
- <01> — адрес
- <0F> — код функции Write Multiple Coils
- <00><00> — адрес первого регистра флагов для записи
- <00><0E> — количество записанных регистров флагов
- <D4><0F> — CRC16
Подробнее описание структуры данных запросов и ответов можно найти на странице Протокол Modbus.