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

Материал из Wiren Board
м (→‎Примеры использования с оборудованием Wiren Board: Вынес примеры в отдельную статью.)
(не показано 6 промежуточных версий 2 участников)
Строка 1: Строка 1:
<languages/>
{{DISPLAYTITLE:Утилита «modbus_client»}}
<translate>
{{DISPLAYTITLE:modbus_client}}
__FORCETOC__
__FORCETOC__
<!--T:2-->
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.
== Подготовка к работе ==
{{Wbincludes:Modbus: Preparing for work}}


Предустановлена на контроллерах 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: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-->
Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды:
Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды:
<syntaxhighlight lang="bash">
<syntaxhighlight lang="bash">
Строка 43: Строка 28:
</syntaxhighlight>
</syntaxhighlight>


<!--T:7-->
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде.  
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. Функции аргументов:


<!--T:8-->
Функции аргументов:
* '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных.
* '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных.
* '''-m''' - определяет тип используемого протокола '''-mrtu''' — Modbus RTU, '''-mtcp''' — Modbus TCP. Он должен указываться первым в командной строке, или вторым, если первый аргумент — '''--debug''' или имя файла порта RS-485.
* '''-m''' — определяет тип используемого протокола '''-mrtu''' — Modbus RTU, '''-mtcp''' — Modbus TCP. Он должен указываться первым в командной строке, или вторым, если первый аргумент — '''--debug''' или имя файла порта RS-485.
* '''-a''' задает Modbus-адрес устройства, к которому мы обращаемся. Если аргумент не используется, то по умолчанию выбирается адрес 0x01.  
* '''-a''' — задает Modbus-адрес устройства, к которому мы обращаемся. Если аргумент не используется, то по умолчанию выбирается адрес 0x01.  
* '''-с''' определяет, какое количество элементов мы запрашиваем. По умолчанию — один.
* '''-с''' — определяет, какое количество элементов мы запрашиваем. По умолчанию — один.
* '''-r''' задает начальный адрес для чтения или записи. По умолчанию используется значение 100 (0x64).
* '''-r''' — задает начальный адрес для чтения или записи. По умолчанию используется значение 100 (0x64).
* '''-t''' указывает код функции Modbus. Кратко они перечислены в выводе modbus_client, подробнее значения кодов описаны на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]].
* '''-t''' — указывает код функции Modbus. Кратко они перечислены в выводе modbus_client, подробнее значения кодов описаны на странице «[[Special:MyLanguage/Протокол Modbus|Протокол Modbus]]».
* '''-o''' задает таймаут в миллисекундах (по умолчанию 1000).
* '''-o''' — задает таймаут в миллисекундах (по умолчанию 1000).
* '''-0''' (ноль) уменьшает на единицу адрес, задаваемый аргументом -r. Это может быть полезным при работе с устройствами с нестандартной адресацией, например, с диапазоном адресов 1 — 65536 вместо привычного 0 — 65535.
* '''-0''' — (ноль) уменьшает на единицу адрес, задаваемый аргументом -r. Это может быть полезным при работе с устройствами с нестандартной адресацией, например, с диапазоном адресов 1 — 65536 вместо привычного 0 — 65535.


<!--T:9-->
Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака '-' (минус).
Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака '-' (минус).


<!--T:10-->
Для Modbus RTU:
Для Modbus RTU:
<!--T:11-->
* '''-b''' — скорость передачи данных по последовательной линии (по умолчанию — 9600).
* '''-b''' — скорость передачи данных по последовательной линии (по умолчанию — 9600).
* '''-d''' — количество передаваемых бит данных (7 или 8, по умолчанию — 8).
* '''-d''' — количество передаваемых бит данных (7 или 8, по умолчанию — 8).
Строка 68: Строка 48:
* '''-p''' — контроль четности ('''-p none''' — нет проверки, '''-p even''' — передается бит контроля на четность, '''-p odd''' — передается бит контроля на нечетность). По умолчанию передается бит контроля на четность(E).
* '''-p''' — контроль четности ('''-p none''' — нет проверки, '''-p even''' — передается бит контроля на четность, '''-p odd''' — передается бит контроля на нечетность). По умолчанию передается бит контроля на четность(E).


<!--T:12-->
Для Modbus TCP:
Для Modbus TCP:
<!--T:13-->
* '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер.
* '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер.


<!--T:14-->
Далее следует имя файла порта RS-485 или адрес хоста, а в конце необязательный параметр — данные для функций записи.
Далее следует имя файла порта RS-485 или адрес хоста, а в конце (факультативно, только для функций записи) — данные.
 
== Примеры использования с оборудованием Wiren Board == <!--T:15-->
 
===Проверка подключения к устройству и считывание адреса===
 
<!--T:21-->
Все устройства Wiren Board с протоколом Modbus RTU хранят адрес в регистре 0x80, поэтому для проверки подключения удобно считывать именно его.
 
Читаем содержимое регистра 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-->
Записываем новый адреса устройства в регистр 0x80, используя функцию 0x06 (Write Single Register):
 
<!--T:18-->
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02</syntaxhighlight>
Где 0x02 - адрес, который нужно задать.
Ответ:
<syntaxhighlight lang="bash">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!</syntaxhighlight>
 
<!--T:19-->
Сообщение об ошибке возникает всегда, когда запись производится на специальный адрес 0 (-a0x00). Теперь к устройству нужно обращаться по адресу 0x02.
 
<!--T:20-->
Пример '''неправильного''' использования команды:
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80</syntaxhighlight>
Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестный адрес.
 
===Чтение сигнатуры устройства===
 
<!--T:23-->
Прочтем регистры релейного модуля WB-MR14 с адресом 0x01, содержащие сигнатуру устройства, WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров.
 
<!--T:24-->
<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)
[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 </syntaxhighlight>
 
<!--T:25-->
В ответе мы получили 6 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их, заменив начальные '''0x00''' на '''/x''' и удалив пробелы, к виду \x57 и т.д., который понятен команде echo, и выведем на экран получившееся:
<syntaxhighlight lang="bash">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 </syntaxhighlight>
Ответ:
<syntaxhighlight lang="bash">WBMR14</syntaxhighlight>
 
<!--T:26-->
В старых версиях прошивки <syntaxhighlight lang="bash">| xxd -r -p</syntaxhighlight> не было нужно.
 
===Включение реле релейного модуля===
<!--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">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!</syntaxhighlight>
 
<!--T:29-->
Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте.
 
===Одновременное включение нескольких реле===
 
<!--T:30-->
Включим все нечетные реле и выключим все четные. Для этого используем функцию 15 (Write Multiple Coils). В модуле всего 14 реле, так что мы должны передать значения для 14 регистров с 0 по 13.
 
<!--T:31-->
<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
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!</syntaxhighlight>
 
<!--T:32-->
Обратите внимание на структуру данных запроса:
 
<!--T:33-->
*[01] — адрес
*[0F] — код функции Write Multiple Coils
*[00][00] — адрес первого регистра флагов для записи
*[00][0E] — количество элементов для записи (14)
*[02] — количество байт данных (14 бит помещаются в 2 байтах)
*[55][15] — 01010101 00010101 (первое реле — младший бит первого байта, 8 реле — старший бит первого байта, 9 реле — младший бит второго байта)
*[1A][97] — CRC16
 
<!--T:34-->
А так же на структуру ответа:
 
<!--T:35-->
*<01> — адрес
*<0F> — код функции Write Multiple Coils
*<00><00> — адрес первого регистра флагов для записи
*<00><0E> — количество записанных регистров флагов
*<D4><0F> — CRC16


<!--T:36-->
== Примеры использования с оборудованием Wiren Board ==
Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]].
Примеры использования утилиты смотрите в статье [[Working with WB devices without a controller#Работа из ОС Linux с помощью modbus_client |Работа с устройствами Wiren Board без контроллера]].
</translate>

Версия 22:01, 11 января 2021


modbus_client — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки.

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

Wbincludes:Modbus: Preparing for work

Аргументы командной строки

Вызов 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 без контроллера.

Источник — https://wirenboard.com/wiki/index.php?title=Modbus-client&oldid=44401