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

Материал из Wiren Board
(Часть переводимой страницы Протокол Modbus.)
(Новая страница: « 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 p…»)
(не показано 48 промежуточных версий 3 участников)
Строка 1: Строка 1:
<languages/>
<languages/>


=== Fundamentals===
===Basics===


Modbus is a protocol of the applied (seventh) level of the [https://en.wikipedia.org/wiki/OSI_model OSI] model for data exchange, most often between automation devices and is implemented in the form of "request-reply protocol".  
Basic concept
Modbus is a Protocol of the applied (seventh) level of the [https://en.wikipedia.org/wiki/OSI_model 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.
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 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 ([http://www.simplymodbus.ca/ASCII.htm пример]). 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.
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 ([http://www.simplymodbus.ca/ASCII.htm пример]). 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.
Ведущее устройство ("мастер", или "клиент") периодически опрашивает "ведомое", или "сервер". Ведущее устройство не имеет адреса, передача сообщений от устройства-сервера ведущему без запроса ведущего в протоколе не предусмотрена.


[[File:Modbus_Datagram.png|900px|thumb|left|Modbus datagram in general]]
[[Special:MyLanguage/Файл:Modbus_Datagram.png|900px|thumb|left|Датаграмма Modbus в общем виде]]


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.
Пакет данных Modbus выглядит, как это показано на рисунке. '''PDU''' (Protocol Data Unit) — общая часть пакета MODBUS, включающая код функции и данные пакета. '''ADU''' (Application Data Unit) — полный пакет MODBUS. Включает в себя специфичную для физического уровня часть пакета и PDU. Для последовательных линий в заголовке ADU передается адрес устройства, а в конце — контрольная сумма CRC16. Максимальный размер ADU в последовательных коммуникационных линиях составляет '''253 байта''' (из максимальных, разрешенных спецификацией 256 байт вычитается 1 байт адреса и два байта контрольной суммы). Для справки в Modbus TCP максимальная длина пакета составляет 260 байт.




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.
Функция кодируется одним байтом и определяет, какое действие должно выполнить устройство-сервер. Значение кодов функций лежат в диапазоне от 1 до 255, причем коды от 128 до 255 зарезервированы для сообщений об ошибках со стороны устройства-сервера. Код 0 не используется. Размер блока данных может варьироваться от нуля до максимально допустимого. Если обработка запроса прошла без ошибок, то устройство-сервер возвращает пакет ADU, содержащий запрошенные данные.


[[File:Modbus_transaction_OK.png|700px|thumb|center|Modbus-transaction without errors]]
[[Special:MyLanguage/Файл:Modbus_transaction_OK.png|700px|thumb|center|Modbus-транзакция, прошедшая без ошибок]]


----
----


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)
При возникновении ошибки устройством возвращается код ошибки. В случае обычной транзакции код функции в ответе возвращается без изменений; в случае ошибки старший бит кода функции устанавливается в единицу (то есть ''код функции'' + 0x80)


[[File:Modbus_transaction_ERR.png|700px|thumb|center|Modbus-transaction with errors]]
[[Special:MyLanguage/Файл:Modbus_transaction_ERR.png|700px|thumb|center|Modbus-транзакция с ошибками]]


----
----
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===
===Структуры данных Modbus===


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 принято кодировать адреса и данные в формате big-endian, то есть в формате, когда байты следуют, начиная со старшего: например, при передаче шестнадцатеричного числа 0x1234 сначала устройством будет принят байт 0x12, а затем — 0x34. Для передачи данных другого типа, например, чисел с плавающей запятой (float), текстовых строк, даты и времени суток и т.п. производитель может выбрать свой собственный способ кодирования для расшифровки получаемых данных важно ознакомится со спецификацией производителя устройства.




===Modbus data model===
===Модель данных Modbus===


Data exchange with Modbus devices takes place via registers. The Modbus Protocol defines four types of registers shown in the table:
Обмен данными с Modbus-устройствами происходит через регистры. В протоколе Modbus определяется четыре типа регистров, показанных в таблице:
{|class="wikitable" align="center"
{|class="wikitable" align="center"
! Table || Size || Access
! Таблица || Размер || Доступ
|-
|-
! Coils
! Регистры флагов (Coils)
| 1 bit || read and write
| 1 бит || чтение и запись
|-
|-
! Discrete Inputs
! Дискретные входы (Discrete Inputs)
| 1 bit || read only
| 1 бит || только чтение
|-
|-
! Holding Registers
! Регистры хранения (Holding Registers)
| 16-bit word || read and write
| 16-битное слово || чтение и запись
|-
|-
! Input Registers
! Регистры ввода (Input Registers)
| 16-bit word || read only
| 16-битное слово || только чтение
|}
|}


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


Discrete inputs are also single-bit registers that describe the state of the device input (for example, voltage — 1). These registers are read-only.
'''Дискретные входы''' (Discrete Inputs) также являются однобитными регистрами, описывающими состояние входа устройства (например подано напряжение — 1). Эти регистры поддерживают только чтение.


Holding Registers and Input Registers are represented by a two-byte word and can store values from 0 to 65535 (0x0000 — 0xFFFFF).
'''Регистры хранения''' (Holding Registers) и '''регистры ввода''' (Input Registers) представлены двухбайтовым словом и могут хранить значения от 0 до 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.
Регистры ввода допускают только чтение (например, текущее значение температуры). Регистры хранения поддерживают как чтение, так и запись (для хранения настроек). В настоящее время во многих устройствах, в частности в устройствах Wiren Board, эти регистры не разделяются. Команды на чтение регистра хранения N и регистра ввода N обратятся к одному и тому же значению в адресном пространстве устройства.


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


{|class="wikitable" align="center"
{|class="wikitable" align="center"
! Table || Table number || Initial logical address || Register number (physical address) || Logical address range
! Таблица || Номер таблицы || Начальный логический адрес || Номер регистра (физический адрес) || Диапазон логических адресов
|-
|-
! Coils
! Регистры флагов (Coils)
| 0 || 000001 || 0 || 000001 — 065535
| 0 || 000001 || 0 || 000001 — 065535
|-
|-
! Discrete Inputs
! Дискретные входы (Discrete Inputs)
| 1 || 100001 || 0 || 100001 — 165535
| 1 || 100001 || 0 || 100001 — 165535
|-
|-
! Holding Registers
! Регистры хранения (Holding Registers)
| 3 || 300001 || 0 || 300001 — 365535
| 3 || 300001 || 0 || 300001 — 365535
|-
|-
! Input Registers
! Регистры ввода (Input Registers)
| 4 || 400001 || 0 || 400001 — 465535
| 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.
Это вносит некоторую путаницу в понимание, по какому же адресу обратиться к регистру с нужным номером. Более того, понятия "адрес" и "регистр" могут применяться производителем произвольно. Чаще всего указываются номера регистров, как, например для устройств Wiren Board.В некоторых устройствах применяются более короткие логические адреса (.0001 — .9999), и для адреса используется 5, а не 6 цифр.


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




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


{|class="wikitable" align="center"
{|class="wikitable" align="center"
Строка 110: Строка 113:
|}
|}


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


[[File:SDM220_Template.png|700px|thumb|center|Template Fragment for SDM220 meter]]
[[Special:MyLanguage/Файл:SDM220_Template.png|700px|thumb|center|Фрагмент шаблона счетчика SDM220]]


=== Register reading and writing function codes ===


The following table shows the most common Modbus function codes:
=== Коды функций чтения и записи регистров ===
 
В следующей таблице приведены наиболее распространенные коды функций Modbus:


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


Commands can be divided by types: reading values of record values; operation with a single value operation on multiple values.
Команды условно можно разделить по типам: чтение значений — запись значений; операция с одним значением операция с несколькими значениями.
 


=== Modbus request and response data format ===


Let's take a closer look at how data is exchanged between the client device sending the request and the server device responding to it. The following figure shows how the controller communicates with a device with address 0x01. We want to read 8 coil registers starting from the first one.
=== Формат данных запросов и ответов Modbus ===


[[File:Read_8_Coils_2.png|600px|thumb|center|Data exchange in Modbus]]
Рассмотрим подробнее, как происходит обмен данными между устройством-клиентом, отправляющим запрос, и устройством-сервером, отвечающим ему.
На следующем рисунке показан обмен данными контроллера с устройством с адресом 0x01. Мы хотим прочесть 8 coil-регистров, начиная с первого.
[[Special:MyLanguage/Файл:Read_8_Coils_2.png|600px|thumb|center|Обмен данными в Modbus]]


We have received a hexadecimal number 0x2D as data, so the state of eight coil registers in binary form is: 0b10110100.
В качестве данных мы получили шестнадцатеричное число 0x2D, то есть состояние восьми coil-регистров в двоичном виде такое: 0b10110100.


----
----


The following table shows the query and response data structures for the main Modbus functions.
В следующей таблице приведены структуры данных запросов и ответов для основных функций Modbus.


{|class="wikitable" align="center"
{|class="wikitable" align="center"
!Function code || Request || Reply  
!Код функции || Запрос || Ответ  
|-
|-
!    1 (Read Coils) и 2 (Read Discrete Inputs)
!    1 (Read Coils) и 2 (Read Discrete Inputs)
|<ul><li>Address of the first flag register or input register (16 бит)</li><li>Amount of data (8 values per byte)</li><ul>||  <ul><li>The number of transmitted bytes (8 bits)</li><li>Flag register or input register values (8 values per byte)</li></ul>  
|<ul><li>Адрес первого регистра флагов или входного регистра (16 бит)</li><li>Количество данных (8 значений на байт) (16 бит)</li><ul>||  <ul><li>Число передаваемых байт (8 бит)</li><li>Значения регистров флагов или входных регистров (8 значений на байт)</li></ul>  
|-
|-
!    3  (Read Holding Registers) и 4 (Read Input Registers)
!    3  (Read Holding Registers) и 4 (Read Input Registers)
|<ul><li>The address of the first register (16 bit)</li><li>Number of registers to read</li><ul>||  <ul><li>The number of transmitted bytes (8 bits)</li><li>The values of the registers (16 bit 1 register)</li></ul>
|<ul><li>Адрес первого регистра (16 бит)</li><li>Количество регистров, которые нужно прочесть</li><ul>||  <ul><li>Число передаваемых байт (8 бит)</li><li>Значения регистров (16 бит на 1 регистр)</li></ul>
|-
|-
!    5 (Write Single Coil)   
!    5 (Write Single Coil)   
|<ul><li>Register address (16 bit)</li><li>The value to be written (0 — off, 0xFF00 — on)</li><ul>||  The answer is similar to the request
|<ul><li>Адрес регистра (16 бит)</li><li>Значение, которое нужно записать (0 — выключить, 0xFF00 — включить)</li><ul>||  Ответ аналогичен запросу
|-
|-
!    6 (WriteSingle Register)   
!    6 (WriteSingle Register)   
|<ul><li>Адрес регистра(16 бит)</li><li>The new value of the register (16-bit)</li></ul>|| The answer is similar to the request
|<ul><li>Адрес регистра(16 бит)</li><li>Новое значение регистра (16 бит)</li></ul>|| Ответ аналогичен запросу
|-
|-
!    15 (WriteMultipleCoils)  
!    15 (WriteMultipleCoils)  
| <ul><li>Address of the first flag register to write (16 bit)</li><li>Number of flag registers to write (16 bits)</li><li>Number of bytes of data transmitted for flag registers (8 bits)</li><li>Data (8 registers the flags in bytes)</li></ul> ||  <ul><li>Address of the first coil register (16 bit)</li><li>The recorded number of coil registers(16-bit)</li></ul>  
| <ul><li>Адрес первого регистра флагов для записи (16 бит)</li><li>Количество регистров флагов для записи (16 бит)</li><li>Количество передаваемых байт данных для регистров флагов (8 бит)</li><li>Данные (8 регистров флагов на байт)</li></ul> ||  <ul><li>Адрес первого coil-регистра (16 бит)</li><li>Количество записанных coil-регистров(16 бит)</li></ul>  
|-
|-
!    16 (Write Multiple register )
!    16 (Write Multiple register )
| <ul><li>The address of the first storage register for recording (16-bits)</li><li>Number of holding registers to write (16 bits)</li><li>the Number of transmitted data bytes for the registers (8-bit)</li><li>Data (16 bytes per register)</li></ul> ||  <ul><li>The address of the first storage register (16 bits)</li><li>Number of written holding registers(16 bit)</li></ul>   
| <ul><li>Адрес первого регистра хранения для записи (16 бит)</li><li>Количество регистров хранения для записи (16 бит)</li><li>Количество передаваемых байт данных для регистров (8 бит)</li><li>Данные (16 байт на регистр)</li></ul> ||  <ul><li>Адрес первого регистра хранения (16 бит)</li><li>Количество записанных регистров хранения(16 бит)</li></ul>   
|-
|-
|}
|}




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


If the request cannot be processed by the server device for one reason or another, it sends an error message in response. The error message contains the address of the Modbus device, the code of the function in which the error occurred, increased by 0x80, the error code and the checksum:
В случае, если запрос не может по той или иной причине быть обработан устройством-сервером, то в ответ он отправляет сообщение об ошибке. Соообщение об ошибке содержит адрес Modbus-устройства, код функции, при выполнении которой произошла ошибка, увеличенный на 0x80, код ошибки и контрольную сумму:


[[File:Read_8_Coils_ERR.png|600px|thumb|center|Transaction failed]]
[[Special:MyLanguage/Файл:Read_8_Coils_ERR.png|600px|thumb|center|Транзакция завершилась с ошибкой]]
In this case, we tried to access the nonexistent register address 0xFFFF and tried to read 8 flag registers. As a result, we received error code 0x03 — "an invalid value was passed in The data field".
В этом случае мы попытались обратиться к несуществующему адресу регистра 0xFFFF и попытались прочесть 8 регистров флагов. В результате мы получили код ошибки 0x03 — "В поле данных передано неверное значение".


The most common Modbus error codes are listed in the following table:
Наиболее распространенные коды ошибок Modbus приведены в следующей таблице:


{|class="wikitable" align="center"
{|class="wikitable" align="center"
!Error Code || Error name|| Meaning
!Код ошибки || Название ошибки|| Что означает
|-
|-
!    1   
!    1   
| Illegal Function ||   An invalid function code was sent in the request
| Illegal Function || В запросе был передан недопустимый код функции
|-
|-
!    2   
!    2   
| Illegal Data Address ||Illegal Data Address
| Illegal Data Address ||Указанный в запросе адрес не существует
|-
|-
!    3   
!    3   
| Illegal Data Value || Illegal Data Value
| Illegal Data Value || В поле данных передано неверное значение
|-
|-
!    4   
!    4   
| Slave Device Failure ||An unrecoverable error occurred on the device while performing the requested operation
| Slave Device Failure ||Произошла невосстановимая ошибка на устройстве при выполнении запрошенной операции
|-
|-
!    5   
!    5   
| Acknowledge ||Request is accepted, executed, but will take a long time to complete; you must increase the timeout.
| Acknowledge ||Запрос принят, выполняется, но выполнение потребует много времени; необходимо увеличить таймаут.
|-
|-
!    6   
!    6   
| Slave Device Busy || The device is busy processing the previous request.
| Slave Device Busy ||Устройство занято обработкой предыдущего запроса.  
|-
|-
!    7   
!    7   
| Negative Acknowledge || The device cannot fulfill the request, you must obtain additional diagnostic information from the device. Maintenance may be required.
| Negative Acknowledge || Устройство не может выполнить запрос, необходимо получить от устройства дополнительную диагностическую информацию. Возможно, требуется тех. обслуживание.
|-
|-
!    8   
!    8   
| Memory Parity Error || Parity Error when accessing the internal memory of the device.
| Memory Parity Error || Ошибка четности при обращении к внутренней памяти устройства.
|-
|-
|}
|}
Строка 226: Строка 230:




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


For the Modbus RTU Protocol, the 16-bit checksum (CRC) is calculated using the algorithm described in the [http://www.modbus.org/specs.php Modbus] specification in ''the Modbus Serial Line Protocol and Implementation Guide, CRC-generation section''. The sending device generates two bytes of checksum based on the message data, and the receiving device recalculates the checksum and compares it with the received one. The coincidence of the accepted and calculated modbud RTU checksum is considered an indicator of successful data exchange.
Для протокола Modbus RTU 16-битная контрольная сумма (CRC) вычисляется по алгоритму, описанному в [http://www.modbus.org/specs.php спецификации Modbus], в документе "Modbus Serial Line Protocol and Implementation Guide", раздел "CRC-generation". Передающее устройство формирует два байта контрольной суммы на основе данных сообщения, а принимающее устройство заново вычисляет контрольную сумму и сравнивает с полученной. Совпадение принятой и вычисленной контрольной суммы Modbud RTU считается индикатором успешного обмена данными.


In the case of limited computing resources for the calculation of the checksum, there is a function that uses table values (also given in the specification).
В случае ограниченных вычислительных ресурсов для вычисления контрольной суммы существует функция, использующая табличные значения (так же приведена в спецификации).

Версия 14:22, 3 июня 2019

Другие языки:

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.


Ведущее устройство ("мастер", или "клиент") периодически опрашивает "ведомое", или "сервер". Ведущее устройство не имеет адреса, передача сообщений от устройства-сервера ведущему без запроса ведущего в протоколе не предусмотрена.

900px|thumb|left|Датаграмма Modbus в общем виде

Пакет данных Modbus выглядит, как это показано на рисунке. PDU (Protocol Data Unit) — общая часть пакета MODBUS, включающая код функции и данные пакета. ADU (Application Data Unit) — полный пакет MODBUS. Включает в себя специфичную для физического уровня часть пакета и PDU. Для последовательных линий в заголовке ADU передается адрес устройства, а в конце — контрольная сумма CRC16. Максимальный размер ADU в последовательных коммуникационных линиях составляет 253 байта (из максимальных, разрешенных спецификацией 256 байт вычитается 1 байт адреса и два байта контрольной суммы). Для справки — в Modbus TCP максимальная длина пакета составляет 260 байт.


Функция кодируется одним байтом и определяет, какое действие должно выполнить устройство-сервер. Значение кодов функций лежат в диапазоне от 1 до 255, причем коды от 128 до 255 зарезервированы для сообщений об ошибках со стороны устройства-сервера. Код 0 не используется. Размер блока данных может варьироваться от нуля до максимально допустимого. Если обработка запроса прошла без ошибок, то устройство-сервер возвращает пакет ADU, содержащий запрошенные данные.

700px|thumb|center|Modbus-транзакция, прошедшая без ошибок


При возникновении ошибки устройством возвращается код ошибки. В случае обычной транзакции код функции в ответе возвращается без изменений; в случае ошибки старший бит кода функции устанавливается в единицу (то есть код функции + 0x80)

700px|thumb|center|Modbus-транзакция с ошибками


Стоит определить таймаут ожидания ответа от ведомого устройства — бессмысленно долго ждать ответ, который, возможно, из-за какой-то ошибки никогда и не придет.


Структуры данных Modbus

В Modbus принято кодировать адреса и данные в формате big-endian, то есть в формате, когда байты следуют, начиная со старшего: например, при передаче шестнадцатеричного числа 0x1234 сначала устройством будет принят байт 0x12, а затем — 0x34. Для передачи данных другого типа, например, чисел с плавающей запятой (float), текстовых строк, даты и времени суток и т.п. производитель может выбрать свой собственный способ кодирования — для расшифровки получаемых данных важно ознакомится со спецификацией производителя устройства.


Модель данных Modbus

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

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