Modbus-client: различия между версиями
Fizikdaos (обсуждение | вклад) |
м (→Аргументы командной строки: Вынес описание аргументов в таблицу) |
||
Строка 54: | Строка 54: | ||
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | ||
'''Общие аргументы''' | |||
{| class="wikitable" | |||
! Параметр | |||
! Описание | |||
! Обязателен | |||
! Значение по умолчанию | |||
|- | |||
| --debug | |||
| Может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. | |||
| нет | |||
| | |||
|- | |||
| -m | |||
| Определяет тип используемого протокола: | |||
*'''-mrtu''' — Modbus RTU, | |||
*'''-mtcp''' — Modbus TCP. | |||
Он должен указываться первым в командной строке, или вторым, если первый аргумент — <code>--debug</code> или имя файла порта RS-485. | |||
| да | |||
| | |||
|- | |||
| -a | |||
| Задает Modbus-адрес устройства, к которому мы обращаемся. | |||
| нет | |||
| 1 | |||
|- | |||
| -с | |||
| Определяет, какое количество элементов мы запрашиваем. | |||
| нет | |||
| 1 | |||
|- | |||
| -r | |||
| Задает начальный адрес для чтения или записи. | |||
| не | |||
| 100 | |||
|- | |||
| -t | |||
| Указывает код функции Modbus. Кратко они перечислены в выводе modbus_client, подробнее значения кодов описаны на странице [[Протокол Modbus]]. | |||
| да | |||
| | |||
|- | |||
| -o | |||
| Задает таймаут в миллисекундах. | |||
| нет | |||
| 1000 | |||
|- | |||
| -0 | |||
| Ноль. Уменьшает на единицу адрес, задаваемый аргументом '''-r'''. <br>Это может быть полезным при работе с устройствами с нестандартной адресацией, например, с диапазоном адресов 1 — 65536 вместо привычного 0 — 65535. | |||
| нет | |||
| | |||
|} | |||
Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака | Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака <code>-</code> (минус,дефис). | ||
Для Modbus RTU | '''Для Modbus RTU''' | ||
{| class="wikitable" | |||
! Параметр | |||
! Описание | |||
! Значение по умолчанию | |||
|- | |||
| -b | |||
| Скорость передачи данных по последовательной линии | |||
| 9600 | |||
|- | |||
| -d | |||
| Количество передаваемых бит данных, 7 или 8 | |||
| 8 | |||
|- | |||
| -s | |||
| Количество стоповых битов, 1 или 2 | |||
| 1 | |||
|- | |||
| -p | |||
| Контроль четности: | |||
*'''-p none''' — нет проверки, | |||
*'''-p even''' — передается бит контроля на четность, | |||
*'''-p odd'''— передается бит контроля на нечетность. | |||
| even | |||
|} | |||
Для Modbus TCP | '''Для Modbus TCP''' | ||
{| class="wikitable" | |||
! Параметр | |||
! Описание | |||
|- | |||
| -p | |||
| Номер TCP-порта устройства, с которым взаимодействует контроллер. | |||
|} | |||
Далее следует имя файла порта RS-485 или адрес хоста, а в конце необязательный параметр — данные для функций записи. | Далее следует имя файла порта RS-485 или адрес хоста, а в конце необязательный параметр — данные для функций записи. | ||
== Примеры использования с оборудованием Wiren Board== | == Примеры использования с оборудованием Wiren Board== | ||
===Проверка подключения к устройству и считывание адреса=== | ===Проверка подключения к устройству и считывание адреса=== |
Версия 21:36, 26 марта 2021
modbus_client — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
Подготовка к работе
Контроллер Wiren Board
Утилита modbus_client
предустановлена на все контроллеры Wiren Board. Для использования утилиты нужно подключиться к контроллеру по протоколу SSH.
Обычно порт 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
Настольный компьютер с Linux
Скачайте пакет для настольных компьютеров с Linux.
Перейдите в папку со скаченным пакетом и установите его командой:
sudo apt install ./modbus-utils_1.2_amd64.deb
Также автоматически должен установиться пакет libmodbus
, если этого не произошло — установите его из репозитория apt.
Аргументы командной строки
Вызов 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 | Определяет тип используемого протокола:
Он должен указываться первым в командной строке, или вторым, если первый аргумент — |
да | |
-a | Задает Modbus-адрес устройства, к которому мы обращаемся. | нет | 1 |
-с | Определяет, какое количество элементов мы запрашиваем. | нет | 1 |
-r | Задает начальный адрес для чтения или записи. | не | 100 |
-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 | Контроль четности:
|
even |
Для 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)
.
ВНИМАНИЕ: в примере используется широковещательный адрес 0x00
. Использование примера в таком виде изменит адрес на всех устройствах Wiren Board, подключенных к порту /dev/ttyRS485-1
. Чтобы этого не произошло — отключите другие устройства от шины.
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02
Где 0x00
— широковещательный адрес, а 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
В ответе мы получили шесть 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
не было нужно.
Чтение версии прошивки
Прочтем версию прошивки из модуля с modbus-адресом 189. По адресу 250 хранится null-termitated строка максимальной длиной в 16 регистров. Прочтем 16 регистров, начиная с адреса 250, и преобразуем полученный шестнадцатеричный ответ в символьную строку:
export DEV_PORT=/dev/ttyRS485-1 #Correct this!
export DEV_ADDR=189 #Correct this!
echo -e `modbus_client --debug -mrtu -pnone -s2 $DEV_PORT \
-a$DEV_ADDR -t0x03 -r250 -c 16 | \
grep Data | sed -e 's/0x00/\\\x/g' -e 's/Data://' -e 's/\s//g'`
В результате выполнения команды получаем строку, например 1.3.1.
Включение реле релейного модуля
На модуле 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.