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

Data exchange with Modbus devices takes place via registers. The Modbus Protocol defines four types of registers shown in the table:

Table	Size	Access
Coils	1 bit	read and write
Discrete Inputs	1 bit	read only
Holding Registers	16-bit word	read and write
Input Registers	16-bit word	read only

Coils store single-bit values - they can be in the 0 or 1 state. These registers can indicate the current state of the output (whether the relay is off or on). The name "coil" literally means the winding-actuator of an electromechanical relay. Flag registers allow both reading and writing.

Discrete inputs are also single-bit registers that describe the state of the device input (for example, voltage — 1). These registers are read-only.

Holding Registers and Input Registers are represented by a two-byte word and can store values from 0 to 65535 (0x0000 — 0xFFFFF). Input registers are read-only (e.g. current temperature). Storage registers support both read and write (to store settings). Currently, in many devices, particularly Wiren Board devices, these registers are not separated. Commands to read the storage register N and the input register N will access the same value in the address space of the device.

Registers addresses and numbers

In the Modbus standard for each of the four types of registers are used in different tables with the numbers 0,1,3,4. Thus, a register of a certain type with a certain number (otherwise it is called a physical address) has its own address in the corresponding table.

Table	Table number	Initial logical address	Register number (physical address)	Logical address range
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

This misleads how to access the register with the desired number. Moreover, the terms "address" and "register" can be used by the manufacturer arbitrarily. Most often register numbers are specified, such as for Wiren Board devices.In some devices a shorter logical address is applied (.0001 — .9999), and the address uses 5, not 6 digits.

Sometimes the description of a device shall contain only logical addresses. For example, coil register 0 has the address 000001, input register 4 — 400005, etc.

The ready-made device templates of the Wiren Board 5 controller have a template for a single-phase electricity meter SDM220 (/usr/share/wb-mqtt-serial/templates/config-sdm220.json). In the documentation "Eastron SDM 220 Modbus Smart Meter Modbus Protocol Implementation V1.0" from the manufacturer the registers and the corresponding measured parameters are listed, for example:

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
...	...	...	... ...

The manufacturer provides both logical and physical addresses of the registers in the table, which allows us to easily create a device template and illustrate the connection between the logical and physical addresses of the Modbus registers.

Template Fragment for SDM220 meter

Register reading and writing function codes

The following table shows the most common Modbus function codes:

Function code	HEX	Name
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 считается индикатором успешного обмена данными.

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