16 233
правки
Admin (обсуждение | вклад) |
м (Добавил раздел «Подготовка к работе») |
||
Строка 1: | Строка 1: | ||
{{DISPLAYTITLE:Утилита «modbus_client»}} | |||
{{DISPLAYTITLE: | |||
__FORCETOC__ | __FORCETOC__ | ||
'''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки. | '''modbus_client''' — утилита для опроса устройств по протоколам Modbus RTU и Modbus TCP из командной строки. | ||
== Подготовка к работе == | |||
=== Контроллер Wiren Board === | |||
Утилита <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-mqtt-serial stop # для Wiren Board 5 и позднее | ||
service wb-homa-modbus stop # для Wiren Board 4 | service wb-homa-modbus stop # для Wiren Board 4 | ||
</syntaxhighlight> После завершения работы с <code>modbus_client</code> запустите драйвер обратно: <source lang="bash"> | </syntaxhighlight> После завершения работы с <code>modbus_client</code> запустите драйвер обратно: <source lang="bash"> | ||
service wb-mqtt-serial start # для Wiren Board 5 и позднее | service wb-mqtt-serial start # для Wiren Board 5 и позднее | ||
service wb-homa-modbus start # для Wiren Board 4 | service wb-homa-modbus start # для Wiren Board 4 | ||
</source> | </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. | |||
== Аргументы командной строки == | |||
Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды: | Вызов <code>modbus_client</code> без аргументов выдает краткое описание возможных аргументов команды: | ||
<syntaxhighlight lang="bash"> | <syntaxhighlight lang="bash"> | ||
Строка 43: | Строка 55: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | |||
Значения параметров (адрес, таймаут, тип функции и т.д.) можно указывать как в шестнадцатеричном (0x**), так и в десятичном виде. | |||
Функции аргументов: | |||
* '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. | * '''--debug''' — произвольный. Он может указываться в любой позиции и включает отладку, выводя на экран шестнадцатеричные коды отправляемых и принимаемых данных. | ||
* '''-m''' | * '''-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. | ||
Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака '-' (минус). | Затем указываются специфические параметры протокола (Modbus RTU или Modbus TCP). Несмотря на информацию, выводимую в подсказке, эти параметры также начинаются со знака '-' (минус). | ||
Для Modbus RTU: | Для Modbus RTU: | ||
* '''-b''' — скорость передачи данных по последовательной линии (по умолчанию — 9600). | * '''-b''' — скорость передачи данных по последовательной линии (по умолчанию — 9600). | ||
* '''-d''' — количество передаваемых бит данных (7 или 8, по умолчанию — 8). | * '''-d''' — количество передаваемых бит данных (7 или 8, по умолчанию — 8). | ||
Строка 68: | Строка 75: | ||
* '''-p''' — контроль четности ('''-p none''' — нет проверки, '''-p even''' — передается бит контроля на четность, '''-p odd''' — передается бит контроля на нечетность). По умолчанию передается бит контроля на четность(E). | * '''-p''' — контроль четности ('''-p none''' — нет проверки, '''-p even''' — передается бит контроля на четность, '''-p odd''' — передается бит контроля на нечетность). По умолчанию передается бит контроля на четность(E). | ||
Для Modbus TCP: | Для Modbus TCP: | ||
* '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер. | * '''-p''' — номер TCP-порта устройства, с которым взаимодействует контроллер. | ||
Далее следует имя файла порта RS-485 или адрес хоста, а в конце необязательный параметр — данные для функций записи. | |||
Далее следует имя файла порта RS-485 или адрес хоста, а в конце | |||
== Примеры использования с оборудованием Wiren Board == | == Примеры использования с оборудованием Wiren Board == | ||
===Проверка подключения к устройству и считывание адреса=== | ===Проверка подключения к устройству и считывание адреса=== | ||
Все устройства Wiren Board с протоколом Modbus RTU хранят адрес в регистре 0x80 — его удобно считывать для проверки подключения. | |||
Все устройства Wiren Board с протоколом Modbus RTU хранят адрес в регистре 0x80 | |||
Читаем содержимое регистра 0x80 с устройства с адреса 2 с помощью функции 0x03 (Read Holding Registers): | Читаем содержимое регистра 0x80 с устройства с адреса 2 с помощью функции 0x03 (Read Holding Registers): | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a2 -t0x03 -r0x80</syntaxhighlight> | <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) | <syntaxhighlight lang="bash"> | ||
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | |||
[02][03][00][80][00][01][85][D1] | [02][03][00][80][00][01][85][D1] | ||
Waiting for a confirmation... | Waiting for a confirmation... | ||
<02><03><02><00><02><7D><85> | <02><03><02><00><02><7D><85> | ||
SUCCESS: read 1 of elements: | SUCCESS: read 1 of elements: | ||
Data: 0x0002</syntaxhighlight> | Data: 0x0002 | ||
</syntaxhighlight> | |||
===Запись нового адреса=== | ===Запись нового адреса=== | ||
Записываем новый адреса устройства в регистр 0x80, используя функцию 0x06 (Write Single Register): | Записываем новый адреса устройства в регистр 0x80, используя функцию 0x06 (Write Single Register): | ||
<syntaxhighlight lang="bash"> | |||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02</syntaxhighlight> | modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 0x02 | ||
Где 0x02 | </syntaxhighlight> | ||
Где 0x02 — адрес, который нужно задать. | |||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Data to write: 0x2 | <syntaxhighlight lang="bash"> | ||
Data to write: 0x2 | |||
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | 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... | ||
ERROR Connection timed out: select | ERROR Connection timed out: select | ||
ERROR occured!</syntaxhighlight> | ERROR occured! | ||
</syntaxhighlight> | |||
Сообщение об ошибке возникает всегда, когда запись производится на специальный адрес 0 (-a0x00). Теперь к устройству нужно обращаться по адресу 0x02. | Сообщение об ошибке возникает всегда, когда запись производится на специальный адрес 0 (-a0x00). Теперь к устройству нужно обращаться по адресу 0x02. | ||
Пример '''неправильного''' использования команды: | Пример '''неправильного''' использования команды: | ||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80</syntaxhighlight> | <syntaxhighlight lang="bash"> | ||
modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a0x00 -t0x06 -r0x80 | |||
</syntaxhighlight> | |||
Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестный адрес. | Здесь не указано значение, которое нужно записать в регистр адреса, поэтому устройство получит неизвестный адрес. | ||
===Чтение сигнатуры устройства=== | ===Чтение сигнатуры устройства=== | ||
Прочтем регистры релейного модуля WB-MR14 с адресом 0x01, содержащие сигнатуру устройства, WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров. | Прочтем регистры релейного модуля WB-MR14 с адресом 0x01, содержащие сигнатуру устройства, WBMR14. Известно, что сигнатура хранится по адресу 200 и занимает 6 регистров. | ||
<syntaxhighlight lang="bash"> | |||
<syntaxhighlight lang="bash">modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 -a1 -t0x03 -r200 -c 6</syntaxhighlight> | 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) | |||
[01][03][00][C8][00][06][44][36] | [01][03][00][C8][00][06][44][36] | ||
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> | <01><03><0C><00><57><00><42><00><4D><00><52><00><31><00><34><D4><76> | ||
SUCCESS: read 6 of elements: | SUCCESS: read 6 of elements: | ||
Data: 0x0057 0x0042 0x004d 0x0052 0x0031 0x0034 </syntaxhighlight> | Data: 0x0057 0x0042 0x004d 0x0052 0x0031 0x0034 | ||
</syntaxhighlight> | |||
В ответе мы получили шесть 16-битных значений, в каждом из которых содержится код одного ASCII-символа. Преобразуем их, заменив начальные '''0x00''' на '''/x''' и удалив пробелы, к виду \x57 и т.д., который понятен команде echo, и выведем на экран получившееся: | |||
В ответе мы получили | <syntaxhighlight lang="bash"> | ||
<syntaxhighlight lang="bash">echo -e `modbus_client --debug -mrtu -pnone -s2 /dev/ttyRS485-1 \ | 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> | |||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">WBMR14</syntaxhighlight> | <syntaxhighlight lang="bash"> | ||
WBMR14 | |||
</syntaxhighlight> | |||
В старых версиях прошивки | |||
В старых версиях прошивки <syntaxhighlight lang="bash">| xxd -r -p</syntaxhighlight> не было нужно. | <syntaxhighlight lang="bash"> | ||
| xxd -r -p | |||
</syntaxhighlight> не было нужно. | |||
===Включение реле релейного модуля=== | ===Включение реле релейного модуля=== | ||
На модуле WB-MR14 включим реле с номером 6 (адреса регистрв флагов начинаются с нуля, помним об этом!). Используем для этого команду 0x05 (Write Single Coil): | На модуле 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/ttyRS485-1 -a1 -t0x05 -r0x05 0x01 | |||
</syntaxhighlight> | |||
Ответ: | Ответ: | ||
<syntaxhighlight lang="bash">Data to write: 0x1 | <syntaxhighlight lang="bash"> | ||
Data to write: 0x1 | |||
Opening /dev/ttyRS485-1 at 9600 bauds (N, 8, 2) | 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... | ||
<01><05><00><05><FF><00><9C><3B> | <01><05><00><05><FF><00><9C><3B> | ||
SUCCESS: written 1 elements!</syntaxhighlight> | SUCCESS: written 1 elements! | ||
</syntaxhighlight> | |||
Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте. | Обратите внимание, утилита modbus_client при записи заменила 1 на 0x00FF, поскольку именно это значение служит для включения реле. Любое ненулевое значение будет заменено на 0x00FF, поэкспериментируйте. | ||
===Одновременное включение нескольких реле=== | ===Одновременное включение нескольких реле=== | ||
Включим все нечетные реле и выключим все четные. Для этого используем функцию 15 (Write Multiple Coils). В модуле всего 14 реле, так что мы должны передать значения для 14 регистров с 0 по 13. | Включим все нечетные реле и выключим все четные. Для этого используем функцию 15 (Write Multiple Coils). В модуле всего 14 реле, так что мы должны передать значения для 14 регистров с 0 по 13. | ||
<syntaxhighlight lang="bash"> | |||
<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> | 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/ttyRS485-1 at 9600 bauds (N, 8, 2) | 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> | |||
Обратите внимание на структуру данных запроса: | Обратите внимание на структуру данных запроса: | ||
*[01] — адрес | *[01] — адрес | ||
*[0F] — код функции Write Multiple Coils | *[0F] — код функции Write Multiple Coils | ||
Строка 187: | Строка 206: | ||
*[1A][97] — CRC16 | *[1A][97] — CRC16 | ||
А так же на структуру ответа: | А так же на структуру ответа: | ||
*<01> — адрес | *<01> — адрес | ||
*<0F> — код функции Write Multiple Coils | *<0F> — код функции Write Multiple Coils | ||
Строка 197: | Строка 214: | ||
*<D4><0F> — CRC16 | *<D4><0F> — CRC16 | ||
Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]]. | Подробнее описание структуры данных запросов и ответов можно найти на странице [[Special:MyLanguage/Протокол Modbus|Протокол Modbus]]. | ||