|
|
(не показаны 22 промежуточные версии 3 участников) |
Строка 1: |
Строка 1: |
| <languages/>
| | {{DISPLAYTITLE:Утилита «modbus_client»}} |
| <translate>
| | __FORCETOC__ |
| {{DISPLAYTITLE:modbus_client}} | |
| <!--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-->
| | Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды: |
| | |
| * На контроллерах 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> После завершения работы с modbus_client запустите драйвер обратно: <source lang="console">
| |
| 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-->
| |
| Вызов modbus_client без аргументов выдает краткое описание возможных аргументов команды:
| |
| <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: |
Строка 28: |
| </syntaxhighlight> | | </syntaxhighlight> |
|
| |
|
| <!--T:7-->
| | Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. |
| Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | |
|
| |
|
| <!--T:8-->
| | Функции аргументов: |
| * Первый аргумент '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. | | * '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. |
| * Следующий аргумент '''-m'''. Он должен указываться первым в командной строке, или вторым, если первый аргумент — '''--debug''' или имя файла порта RS-485. Аргумент определяет тип используемого протокола '''-mrtu''' — Modbus RTU, '''-mtcp''' — Modbus TCP. | | * '''-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). |
Строка 67: |
Строка 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-порта устройства, с которым взаимодействует контроллер. |
|
| |
|
| | Далее следует имя файла порта RS-485 или адрес хоста, а в конце необязательный параметр — данные для функций записи. |
|
| |
|
| <!--T:14-->
| | == Примеры использования с оборудованием Wiren Board == |
| Далее следует имя файла порта RS-485 или адрес хоста, а в конце (факультативно, только для функций записи) — данные.
| | Примеры использования утилиты смотрите в статье [[Working with WB devices without a controller#Работа из ОС Linux с помощью modbus_client |Работа с устройствами Wiren Board без контроллера]]. |
| | |
| | |
| </translate>
| |
| <span id="примеры-использования в modbus rtu"></span>
| |
| <translate>
| |
| == Примеры использования в Modbus RTU == <!--T:15--> | |
| | |
| <!--T:16-->
| |
| Приведем несколько примеров, иллюстрирующих возможности данной утилиты.
| |
| | |
| | |
| <!--T:17-->
| |
| ----
| |
| 1. Запись нового адреса устройства WB-MR14 в регистр 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>
| |
| Здесь не указан адрес, который нужно задать устройству и устройство получит неизвестный адрес. Для исправления, нужно обратиться к устройству по специальному адресу 0x00 (см. первую команду).
| |
| | |
| <!--T:21-->
| |
| ----
| |
| 2. Проверка: читаем содержимое регистра 0x80 (теперь уже с устройства с адресом 0x02) с помощью функции 0x03 (Read Holding Registers). Заметим, что в устройствах Wiren Board функции 0x03 и 0x04 взаимозаменяемы и приводят к одному и тому же результату.
| |
| | |
| <!--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:23-->
| |
| ----
| |
| 3. Прочтем регистры релейного модуля 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:27-->
| |
| ----
| |
| 4. Определим текущий адрес устройства, подключенного к Wiren Board. Адрес нам неизвестен и мы не хотим его менять.
| |
| Для этого в командной строке выполним циклическую команду опроса регистра 0x80 устройств с адресами с 1 по 247:
| |
| <syntaxhighlight lang="bash">root@wirenboard:~# for i in {1..247}; do modbus_client -mrtu /dev/ttyRS485-1 --debug -a$i -t3 -r0x80 -s2 -pnone; done 2>/dev/null | grep Data: </syntaxhighlight>
| |
| Ответ:
| |
| <syntaxhighlight lang="bash"> Data: 0x0072</syntaxhighlight>
| |
| Результат: адрес подключенного устройства — 0x0072, то есть 114. Перебор всех адресов от 1 до 247 занимает чуть больше 2 минут.
| |
| | |
| <!--T:28-->
| |
| ----
| |
| 5. На модуле 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-->
| |
| ----
| |
| 6. Включим все нечетные реле и выключим все четные. Для этого используем функцию 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-->
| |
| Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]].
| |
| </translate>
| |