Modbus/en

Basics

Basic concept Modbus is a Protocol of the applied (seventh) level of the OSI model for data exchange, most often between automation devices and is implemented in the form of "request-reply protocol".

In Wirenboard devices, Modbus data is transmitted over RS-485 serial communication lines. In serial lines RS-485 Protocol is half-duplex and works on the principle of "client-server". Each device on the network (except the master, see below) has an address from 1 to 247, address 0 is used for broadcasting to all devices, and addresses 248-255 are considered reserved according to the Modbus specification, their use is not recommended.

There are two protocol specifications: Modbus RTU and Modbus ASCII. An 11-bit character consisting of 1 start bit, 8 data bits (starting with the lower bit), a parity bit (optional), and 2 stop bits if no parity bit is transmitted, or 1 stop bit if no parity bit is transmitted, is transmitted to the Modbus RTU. This character allows you to transfer 1 byte of data. In Wiren Board devices, the parity bit is not transmitted and 2 stop bits are used. In Modbus ASCII, each byte is transmitted in two characters representing the ASCII codes of the lower and upper four-bit byte groups (пример). The Modbus RTU allows you to transmit more information at the same serial line speed and it is used in the Wiren Board devices. All further description applies to Modbus RTU.

The master device periodically polls the slave or server. The master has no address, the transmission of messages from the device server to the host without asking the host in the protocol is not provided.

Modbus datagram in general

The Modbus data package looks as shown in the figure. A PDU (Protocol Data Unit) is a common part of a MODBUS package that includes the function code and data of the package. ADU (Application Data Unit) is a complete Modbus package. Includes a physical layer-specific part of the package and PDU. For serial lines, the device address is passed in the ADU header, and the CRC16 checksum is passed at the end. The maximum ADU size in serial communication lines is 253 bytes (1 byte of the address and two bytes of the checksum are subtracted from the maximum 256 bytes allowed by the specification). For reference — in Modbus TCP, the maximum packet length is 260 bytes.

The function is encoded in one byte and determines what action the server device should perform. Function codes range from 1 to 255, with codes 128 to 255 reserved for error messages from the server device. Code 0 is not used. The size of the data block can vary from zero to the maximum allowed. If the request is processed correctly, the server device returns an ADU containing the requested data.

700px|thumb|center|Modbus-transaction without errors

---

If an error occurs, the device returns an error code. In the case of a normal transaction, the function code in the response is returned unchanged; in the case of an error, the highest bit of the function code is set to one (that is, the function code + 0x80)

Modbus-transaction with errors

---

It is necessary to determine the timeout waiting for a response from the slave — it is pointless to wait a long time for an answer, which, perhaps, due to some error will never come.

Modbus data structures

In Modbus it is customary to encode addresses and data in the big-endian format, when bytes are starting with the high: for example, when transmitting the hexadecimal number 0x1234, the device will first accept the byte 0x12, and then — 0x34. To transfer data of another type, for example, float numbers, text strings, date and time of day, etc. the manufacturer can choose its own method of encoding — for data decrypting it is important to get acquainted with the specification of the device manufacturer.

Modbus data model

Обмен данными с Modbus-устройствами происходит через регистры. В протоколе Modbus определяется четыре типа регистров, показанных в таблице:

Таблица	Размер	Доступ
Регистры флагов (Coils)	1 бит	чтение и запись
Дискретные входы (Discrete Inputs)	1 бит	только чтение
Регистры хранения (Holding Registers)	16-битное слово	чтение и запись
Регистры ввода (Input Registers)	16-битное слово	только чтение

Регистры флагов (Coils) хранят однобитные значения - то есть могут находится в состоянии 0 или 1. Такие регистры могут обозначать текущее состояние выхода (включено реле). Название "coil" буквально и означает обмотку-актюатор электромеханического реле. Регистры флагов допускают как чтение, так и запись.

Дискретные входы (Discrete Inputs) также являются однобитными регистрами, описывающими состояние входа устройства (например подано напряжение — 1). Эти регистры поддерживают только чтение.

Регистры хранения (Holding Registers) и регистры ввода (Input Registers) представлены двухбайтовым словом и могут хранить значения от 0 до 65535 (0x0000 — 0xFFFFF). Регистры ввода допускают только чтение (например, текущее значение температуры). Регистры хранения поддерживают как чтение, так и запись (для хранения настроек). В настоящее время во многих устройствах, в частности в устройствах Wiren Board, эти регистры не разделяются. Команды на чтение регистра хранения N и регистра ввода N обратятся к одному и тому же значению в адресном пространстве устройства.

Адреса и номера регистров

В стандарте Modbus для каждого из четырех типов регистров используются разные таблицы с номерами 0,1,3,4. Таким образом, регистр определенного типа с определенным номером (иначе его называют физическим адресом) имеет свой адрес в соответствующей таблице.

Таблица	Номер таблицы	Начальный логический адрес	Номер регистра (физический адрес)	Диапазон логических адресов
Регистры флагов (Coils)	0	000001	0	000001 — 065535
Дискретные входы (Discrete Inputs)	1	100001	0	100001 — 165535
Регистры хранения (Holding Registers)	3	300001	0	300001 — 365535
Регистры ввода (Input Registers)	4	400001	0	400001 — 465535

Это вносит некоторую путаницу в понимание, по какому же адресу обратиться к регистру с нужным номером. Более того, понятия "адрес" и "регистр" могут применяться производителем произвольно. Чаще всего указываются номера регистров, как, например для устройств Wiren Board.В некоторых устройствах применяются более короткие логические адреса (.0001 — .9999), и для адреса используется 5, а не 6 цифр.

Иногда в описаниях устройства указываются только логические адреса. Например, coil-регистр 0 имеет адрес 000001, регистр ввода 4 — 400005 и т.д.

В готовых шаблонах устройств контроллера Wiren Board 5 есть шаблон для однофазного счетчика электроэнергии SDM220 (/usr/share/wb-mqtt-serial/templates/config-sdm220.json). В документации от производителя "Eastron SDM 220 Modbus Smart Meter Modbus Protocol Implementation V1.0" перечислены регистры и соответствующие им измеряемые параметры, например:

Address (Register)	Description	Units	Modbus Protocol Start Address Hex (Hi Byte Lo Byte)
30001	Line to neutral volts.	Volts	00 00
30007	Current.	Amps.	00 06
30013	Active power	Whatts	00 0C
30019	Apparent power	VoltAmps	00 12
...	...	...	... ...

Производитель в таблице приводит и логические, и физические адреса регистров, что позволяет нам с легкостью создать шаблон устройства и проиллюстрировать связь между логическими и физическими адресами Modbus-регистров.

700px|thumb|center|Фрагмент шаблона счетчика SDM220

Коды функций чтения и записи регистров

В следующей таблице приведены наиболее распространенные коды функций Modbus:

Код функции	HEX	Название	Действие
1	0x01	Read Coils	Чтение значений нескольких регистров флагов
2	0x02	Read Discrete Inputs	Чтение значений нескольких дискретных входов
3	0x03	Read Holding Registers	Чтение значений нескольких регистров хранения
4	0x04	Read Input Registers	Чтение значений нескольких регистров ввода
5	0x05	Write Single Coil	Запись одного регистра флагов
6	0x06	Write Single Register	Запись одного регистра (ввода или хранения)
15	0x0F	Write Multiple Coils	Запись нескольких регистров флагов
16	0x10	Write Multiple Register	Запись нескольких регистров (ввода или хранения)

Команды условно можно разделить по типам: чтение значений — запись значений; операция с одним значением — операция с несколькими значениями.

Формат данных запросов и ответов Modbus

Рассмотрим подробнее, как происходит обмен данными между устройством-клиентом, отправляющим запрос, и устройством-сервером, отвечающим ему. На следующем рисунке показан обмен данными контроллера с устройством с адресом 0x01. Мы хотим прочесть 8 coil-регистров, начиная с первого. 600px|thumb|center|Обмен данными в Modbus

В качестве данных мы получили шестнадцатеричное число 0x2D, то есть состояние восьми coil-регистров в двоичном виде такое: 0b10110100.

---

В следующей таблице приведены структуры данных запросов и ответов для основных функций Modbus.

Код функции	Запрос	Ответ
1 (Read Coils) и 2 (Read Discrete Inputs)	Адрес первого регистра флагов или входного регистра (16 бит) Количество данных (8 значений на байт) (16 бит)	Число передаваемых байт (8 бит) Значения регистров флагов или входных регистров (8 значений на байт)
3 (Read Holding Registers) и 4 (Read Input Registers)	Адрес первого регистра (16 бит) Количество регистров, которые нужно прочесть	Число передаваемых байт (8 бит) Значения регистров (16 бит на 1 регистр)
5 (Write Single Coil)	Адрес регистра (16 бит) Значение, которое нужно записать (0 — выключить, 0xFF00 — включить)	Ответ аналогичен запросу
6 (WriteSingle Register)	Адрес регистра(16 бит) Новое значение регистра (16 бит)	Ответ аналогичен запросу
15 (WriteMultipleCoils)	Адрес первого регистра флагов для записи (16 бит) Количество регистров флагов для записи (16 бит) Количество передаваемых байт данных для регистров флагов (8 бит) Данные (8 регистров флагов на байт)	Адрес первого coil-регистра (16 бит) Количество записанных coil-регистров(16 бит)
16 (Write Multiple register )	Адрес первого регистра хранения для записи (16 бит) Количество регистров хранения для записи (16 бит) Количество передаваемых байт данных для регистров (8 бит) Данные (16 байт на регистр)	Адрес первого регистра хранения (16 бит) Количество записанных регистров хранения(16 бит)

Коды исключений (ошибки) Modbus

В случае, если запрос не может по той или иной причине быть обработан устройством-сервером, то в ответ он отправляет сообщение об ошибке. Соообщение об ошибке содержит адрес Modbus-устройства, код функции, при выполнении которой произошла ошибка, увеличенный на 0x80, код ошибки и контрольную сумму:

600px|thumb|center|Транзакция завершилась с ошибкой В этом случае мы попытались обратиться к несуществующему адресу регистра 0xFFFF и попытались прочесть 8 регистров флагов. В результате мы получили код ошибки 0x03 — "В поле данных передано неверное значение".

Наиболее распространенные коды ошибок Modbus приведены в следующей таблице:

Код ошибки	Название ошибки	Что означает
1	Illegal Function	В запросе был передан недопустимый код функции
2	Illegal Data Address	Указанный в запросе адрес не существует
3	Illegal Data Value	В поле данных передано неверное значение
4	Slave Device Failure	Произошла невосстановимая ошибка на устройстве при выполнении запрошенной операции
5	Acknowledge	Запрос принят, выполняется, но выполнение потребует много времени; необходимо увеличить таймаут.
6	Slave Device Busy	Устройство занято обработкой предыдущего запроса.
7	Negative Acknowledge	Устройство не может выполнить запрос, необходимо получить от устройства дополнительную диагностическую информацию. Возможно, требуется тех. обслуживание.
8	Memory Parity Error	Ошибка четности при обращении к внутренней памяти устройства.

Вычисление контрольной суммы Modbus

Для протокола Modbus RTU 16-битная контрольная сумма (CRC) вычисляется по алгоритму, описанному в спецификации Modbus, в документе "Modbus Serial Line Protocol and Implementation Guide", раздел "CRC-generation". Передающее устройство формирует два байта контрольной суммы на основе данных сообщения, а принимающее устройство заново вычисляет контрольную сумму и сравнивает с полученной. Совпадение принятой и вычисленной контрольной суммы Modbud RTU считается индикатором успешного обмена данными.

В случае ограниченных вычислительных ресурсов для вычисления контрольной суммы существует функция, использующая табличные значения (так же приведена в спецификации).