Modbus
Modbus is a serial communications protocol originally published by Modicon (now Schneider Electric) in 1979 for use with its programmable logic controllers (PLCs). Simple and robust, it has since become a de facto standard communication protocol, and it is now a commonly available means of connecting industrial electronic devices.[1] The main reasons for the use of Modbus in the industrial environment are:
- developed with industrial applications in mind
- openly published and royalty-free
- easy to deploy and maintain
- moves raw bits or words without placing many restrictions on vendors
Modbus enables communication among many devices connected to the same network, for example a system that measures temperature and humidity and communicates the results to a computer. Modbus is often used to connect a supervisory computer with a remote terminal unit (RTU) in supervisory control and data acquisition (SCADA) systems. Many of the data types are named from its use in driving relays: a single-bit physical output is called a coil, and a single-bit physical input is called a discrete input or a contact.
The development and update of Modbus protocols has been managed by the Modbus Organization[2] since April 2004, when Schneider Electric transferred rights to that organization.[3] The Modbus Organization is an association of users and suppliers of Modbus compliant devices that seeks to drive the adoption and evolution of Modbus.[4]
Modbus object types
The following is a table of object types provided by a modbus slave device to a modbus master device:
Object Type | Access | Size |
---|---|---|
Coil | Read-Write | 1-bit |
Discrete Input | Read-Only | 1-bit |
Input Register | Read-Only | 16-bits |
Holding Register | Read-Write | 16-bits |
Protocol versions
Versions of the Modbus protocol exist for serial port and for Ethernet and other protocols that support the Internet protocol suite. There are many variants of Modbus protocols:
- Modbus RTU — This is used in serial communication & makes use of a compact, binary representation of the data for protocol communication. The RTU format follows the commands/data with a cyclic redundancy check checksum as an error check mechanism to ensure the reliability of data. Modbus RTU is the most common implementation available for Modbus. A Modbus RTU message must be transmitted continuously without inter-character hesitations. Modbus messages are framed (separated) by idle (silent) periods.
- Modbus ASCII — This is used in serial communication & makes use of ASCII characters for protocol communication. The ASCII format uses a longitudinal redundancy check checksum. Modbus ASCII messages are framed by leading colon (':') and trailing newline (CR/LF).
- Modbus TCP/IP or Modbus TCP — This is a Modbus variant used for communications over TCP/IP networks, connecting over port 502.[5] It does not require a checksum calculation as lower layers already provide checksum protection.
- Modbus over TCP/IP or Modbus over TCP or Modbus RTU/IP — This is a Modbus variant that differs from Modbus TCP in that a checksum is included in the payload as with Modbus RTU.[6]
- Modbus over UDP — Some have experimented with using Modbus over UDP on IP networks, which removes the overheads required for TCP [7]
- Modbus Plus (Modbus+, MB+ or MBP) Modbus over Fieldbus (Modbus+ or MB+), also exists, but remains proprietary to Schneider Electric. requires a dedicated co-processor to handle fast HDLC-like token rotation. It uses twisted pair at 1 Mbit/s and includes transformer isolation at each node, which makes it transition/edge triggered instead of voltage/level triggered. Special interfaces are required to connect Modbus Plus to a computer, typically a card made for the ISA (SA85), PCI or PCMCIA bus.
- Modbus PEMEX- This variant is an extension of standard Modbus with support for historical and flow data. It was designed for process control and never gained widespread adoption [8]
- Enron Modbus- This variant is an extension of standard Modbus with support for 32-bit Integer and Floating Point variables, and historical and flow data. Data types are mapped using standard addresses.[9] The historical data serves to meet an American Petroleum Institute (API) industry standard for how data should be stored[10]
Data model and function calls are identical for the first 4 variants of protocols; only the encapsulation is different. However the variants are not interoperable as are the frame formats.
Communication and devices
Each device intended to communicate using Modbus is given a unique address. In serial and MB+ networks, only the node assigned as the Master may initiate a command. On Ethernet, any device can send out a Modbus command, although usually only one master device does so. A Modbus command contains the Modbus address of the device it is intended for (1 to 247). Only the intended device will act on the command, even though other devices might receive it (an exception is specific broadcastable commands sent to node 0 which are acted on but not acknowledged). All Modbus commands contain checksum information, to allow the recipient to detect transmission errors. The basic Modbus commands can instruct an RTU to change the value in one of its registers, control or read an I/O port, and command the device to send back one or more values contained in its registers.
There are many modems and gateways that support Modbus, as it is a very simple protocol and often copied. Some of them were specifically designed for this protocol. Different implementations use wireline, wireless communication, such as in the ISM band, and even Short Message Service (SMS) or General Packet Radio Service (GPRS). One of the more common designs of wireless networks makes use of mesh networking. Typical problems that designers have to overcome include high latency and timing issues.
Frame format
A Modbus frame is composed of an Application Data Unit (ADU) which encloses a Protocol Data Unit (PDU):[11]
- ADU = Address + PDU + Error check
- PDU = Function code + Data
All Modbus variants choose one of the following frame formats.[1]
Name | Length (bits) | Function |
---|---|---|
Start | 28 | At least 3 1⁄2 character times of silence (mark condition) |
Address | 8 | Station address |
Function | 8 | Indicates the function code; e.g., read coils/holding registers |
Data | n × 8 | Data + length will be filled depending on the message type |
CRC | 16 bits | Cyclic redundancy check |
End | 28 | At least 3 1⁄2 character times of silence between frames |
Note about the CRC:
- Polynomial: x16 + x15 + x2 + 1 (CRC-16-ANSI also known as CRC-16-IBM, normal hexadecimal algebraic polynomial being
8005
and reversedA001
) - Initial value: 65,535
- Example of frame in hexadecimal:
01 04 02 FF FF B8 80
(CRC-16-ANSI calculation from01
toFF
gives80B8
which is transmitted least significant byte first)
Name | Length (bytes) | Function |
---|---|---|
Start | 1 | Starts with colon : (ASCII hex value is 0x3a ) |
Address | 2 | Station address |
Function | 2 | Indicates the function codes like read coils / inputs |
Data | n × 2 | Data + length will be filled depending on the message type |
LRC | 2 | Checksum (Longitudinal redundancy check) |
End | 2 | Carriage return – line feed (CR/LF) pair (ASCII values of 0x0d & 0x0a) |
Address, function, data, and LRC are all capital hexadecimal readable pairs of characters representing 8-bit values (0–255). For example, 122 (7x16+10) will be represented as 7A
.
LRC is calculated as the sum of 8-bit values, negated (two's complement) and encoded as an 8-bit value. Example: if address, function, and data encode as 247, 3, 19, 137, 0, and 10, their sum is 416. Two's complement (-416) trimmed to 8-bit is 96 (e.g. 256x2-416) which will be represented as 60
in hexadecimal. Hence the following frame :F7031389000A60<CR><LF>
Name | Length (bytes) | Function |
---|---|---|
Transaction identifier | 2 | For synchronization between messages of server & client |
Protocol identifier | 2 | Zero for Modbus/TCP |
Length field | 2 | Number of remaining bytes in this frame |
Unit identifier | 1 | Slave address (255 if not used) |
Function code | 1 | Function codes as in other variants |
Data bytes | n | Data as response or commands |
Unit identifier is used with Modbus/TCP devices that are composites of several Modbus devices, e.g. on Modbus/TCP to Modbus RTU gateways. In such case, the unit identifier tells the Slave Address of the device behind the gateway. Natively Modbus/TCP-capable devices usually ignore the Unit Identifier.
The byte order for values in Modbus data frames is big-endian (MSB, Most Significant Byte of a value received first).
Supported function codes
The various reading, writing and other operations are categorised as follows.[12] The most primitive reads and writes are shown in bold. A number of sources use alternative terminology, for example Force Single Coil where the standard uses Write Single Coil.[13]
Prominent entities within a Modbus slave are:
- Coils: readable and writable, 1 bit (off/on)
- Discrete Inputs: readable, 1 bit (off/on)
- Input Registers: readable, 16 bits (0 to 65,535), essentially measurements and statuses
- Holding Registers: readable and writable, 16 bits (0 to 65,535), essentially configuration values
Function type | Function name | Function code | ||
---|---|---|---|---|
Data Access | Bit access | Physical Discrete Inputs | Read Discrete Inputs | 2 |
Internal Bits or Physical Coils | Read Coils | 1 | ||
Write Single Coil | 5 | |||
Write Multiple Coils | 15 | |||
16-bit access | Physical Input Registers | Read Input Registers | 4 | |
Internal Registers or Physical Output Registers | Read Multiple Holding Registers | 3 | ||
Write Single Holding Register | 6 | |||
Write Multiple Holding Registers | 16 | |||
Read/Write Multiple Registers | 23 | |||
Mask Write Register | 22 | |||
Read FIFO Queue | 24 | |||
File Record Access | Read File Record | 20 | ||
Write File Record | 21 | |||
Diagnostics | Read Exception Status | 7 | ||
Diagnostic | 8 | |||
Get Com Event Counter | 11 | |||
Get Com Event Log | 12 | |||
Report Slave ID | 17 | |||
Read Device Identification | 43 | |||
Other | Encapsulated Interface Transport | 43 |
Format of data of requests and responses for main function codes
Requests and responses follow frame formats described above. This section gives details of data formats of most used function codes.
Function code 1 (read coils) and function code 2 (read discrete inputs)
Request:
- Address of first coil/discrete input to read (16-bit)
- Number of coils/discrete inputs to read (16-bit)
Normal response:
- Number of bytes of coil/discrete input values to follow (8-bit)
- Coil/discrete input values (8 coils/discrete inputs per byte)
Value of each coil/discrete input is binary (0 for off, 1 for on). First requested coil/discrete input is stored as least significant bit of first byte in reply.
If number of coils/discrete inputs is not a multiple of 8, most significant bit(s) of last byte will be stuffed with zeros.
For example, if eleven coils are requested, two bytes of values are needed. Suppose states of those successive coils are on, off, on, off, off, on, on, on, off, on, on, then data part of the response will be 06E5
in hexadecimal.
Function code 5 (force/write single coil)
Request:
- Address of coil (16-bit)
- Value to force/write: 0 for off and 65,280 (FF00 in hexadecimal) for on
Normal response: same as request.
Function code 15 (force/write multiple coils)
Request:
- Address of first coil to force/write (16-bit)
- Number of coils to force/write (16-bit)
- Number of bytes of coil values to follow (8-bit)
- Coil values (8 coil values per byte)
Value of each coil is binary (0 for off, 1 for on). First requested coil is stored as least significant bit of first byte in request.
If number of coils is not a multiple of 8, most significant bit(s) of last byte should be stuffed with zeros. See example for function codes 1 and 2.
Normal response:
- Address of first coil (16-bit)
- number of coils (16-bit)
Function code 4 (read input registers) and function code 3 (read holding registers)
Request:
- Address of first register to read (16-bit)
- Number of registers to read (16-bit)
Normal response:
- Number of bytes of register values to follow (8-bit)
- Register values (16 bits per register)
Because the number of bytes for register values is 8-bit wide, only 127 registers can be read at once.
Function code 6 (preset/write single holding register)
Request:
- Address of holding register to preset/write (16-bit)
- New value of the holding register (16-bit)
Normal response: same as request.
Function code 16 (preset/write multiple holding registers)
Request:
- Address of first holding register to preset/write (16-bit)
- Number of holding registers to preset/write (16-bit)
- Number of bytes of register values to follow (8-bit)
- New values of holding registers (16 bits per register)
Because the number of bytes for register values is 8-bit wide, only 127 holding registers can be preset/written at once.
Normal response:
- Address of first preset/written holding register (16-bit)
- number of preset/written holding registers (16-bit)
Exception responses
For a normal response, slave repeats the function code. Should a slave want to report an error, it will reply with the requested function code plus 128 (3 becomes 131 or 83
in hexadecimal), and will only include one byte of data, known as the exception code.
Main Modbus exception codes
Code | Text | Details |
---|---|---|
1 | Illegal Function | Function code received in the query is not recognized or allowed by slave |
2 | Illegal Data Address | Data address of some or all the required entities are not allowed or do not exist in slave |
3 | Illegal Data Value | Value is not accepted by slave |
4 | Slave Device Failure | Unrecoverable error occurred while slave was attempting to perform requested action |
5 | Acknowledge | Slave has accepted request and is processing it, but a long duration of time is required. This response is returned to prevent a timeout error from occurring in the master. Master can next issue a Poll Program Complete message to determine if processing is completed |
6 | Slave Device Busy | Slave is engaged in processing a long-duration command. Master should retry later |
7 | Negative Acknowledge | Slave cannot perform the programming functions. Master should request diagnostic or error information from slave |
8 | Memory Parity Error | Slave detected a parity error in memory. Master can retry the request, but service may be required on the slave device |
10 | Gateway Path Unavailable | Specialized for Modbus gateways. Indicates a misconfigured gateway |
11 | Gateway Target Device Failed to Respond | Specialized for Modbus gateways. Sent when slave fails to respond |
Coil, discrete input, input register, holding register numbers and addresses
Some conventions govern how access to Modbus entities (coils, discrete inputs, input registers, holding registers) are referenced.
It is important to make a distinction between entity number and entity address:
- Entity numbers combine entity type and entity location within their description table
- Entity address is the starting address, a 16-bit value in the data part of the Modbus frame. As such its range goes from 0 to 65,535
In the traditional standard, numbers for those entities start with a digit, followed by a number of four digits in range 1–9,999:
- coils numbers start with a zero and then span from 00001 to 09999
- discrete input numbers start with a one and then span from 10001 to 19999
- input register numbers start with a three and then span from 30001 to 39999
- holding register numbers start with a four and then span from 40001 to 49999
This translates into addresses between 0 and 9,998 in data frames.
For example, in order to read holding registers starting at number 40001, corresponding address in the data frame will be 0 with a function code of 3 (as seen above). For holding registers starting at number 40100, address will be 99. Etc.
This limits the number of addresses to 9,999 for each entity. A de facto referencing extends this to the maximum of 65,536.[14]
It simply consists of adding one digit to the previous list:
- coil numbers span from 000001 to 065536
- discrete input numbers span from 100001 to 165536
- input register numbers span from 300001 to 365536
- holding register numbers span from 400001 to 465536
When using the extended referencing, all number references must be exactly six digits. This avoids confusion between coils and other entities. For example, to know the difference between holding register #40001 and coil #40001, if coil #40001 is the target, it must appear as #040001.
JBUS mapping
Another de facto protocol tightly related with Modbus[15] appeared after it and was defined by PLC brand April Automates, resulting of a collaborative effort of French companies Renault Automation and Merlin Gerin et Cie in 1985:[16] JBUS. Differences between Modbus and JBUS at that time (number of entities, slave stations) are now irrelevant as this protocol almost disappeared with April PLC series which AEG Schneider Automation bought in 1994 and then made them obsolete. However the name JBUS survived to some extent.
JBUS supports function codes 1, 2, 3, 4, 5, 6, 15, and 16 and thus all the entities described above. However numbering is different with JBUS:[17]
- Number and address coincide: entity #x has address x in the data frame
- Consequently, entity number does not include the entity type. For example, holding register #40010 in Modbus will be holding register #9, located at address 9 in JBUS
- Number 0 (and thus address 0) is not supported. Slave should not implement any real data at this number and address and it can return a null value or throw an error when requested
Implementations
Almost all implementations have variations from the official standard. Different varieties might not communicate correctly between equipment of different suppliers. Some of the most common variations are:
- Data types
- Floating point IEEE
- 32-bit integer
- 8-bit data
- Mixed data types
- Bit fields in integers
- Multipliers to change data to/from integer. 10, 100, 1000, 256 ...
- Protocol extensions
- 16-bit slave addresses
- 32-bit data size (1 address = 32 bits of data returned)
- Word swapped data
Limitations
- Since Modbus was designed in the late 1970s to communicate to programmable logic controllers, the number of data types is limited to those understood by PLCs at the time. Large binary objects are not supported.
- No standard way exists for a node to find the description of a data object, for example, to determine if a register value represents a temperature between 30 and 175 degrees.
- Since Modbus is a master/slave protocol, there is no way for a field device to "report by exception" (except over Ethernet TCP/IP, called open-mbus)- the master node must routinely poll each field device, and look for changes in the data. This consumes bandwidth and network time in applications where bandwidth may be expensive, such as over a low-bit-rate radio link.
- Modbus is restricted to addressing 254 devices on one data link, which limits the number of field devices that may be connected to a master station (once again Ethernet TCP/IP being an exception).
- Modbus transmissions must be contiguous which limits the types of remote communications devices to those that can buffer data to avoid gaps in the transmission.
- Modbus protocol itself provides no security against unauthorized commands or interception of data.[18]
Trade group
Modbus Organization, Inc. is a trade association for the promotion and development of Modbus protocol.[2]
Modbus Plus
Despite the name, Modbus Plus[19] is not a variant of Modbus. It is a different protocol, involving token passing.
It is a proprietary specification of Schneider Electric, though it is unpublished rather than patented. It is normally implemented using a custom chipset available only to partners of Schneider.
References
- 1 2 Drury, Bill (2009). Control Techniques Drives and Controls Handbook (PDF) (2nd ed.). Institution of Engineering and Technology. pp. 508–. (subscription required (help)).
- 1 2 "Modbus home page". Modbus. Modbus Organization, Inc. Retrieved 2 August 2013.
- ↑ "Modbus FAQ". Modbus. Modbus Organization, Inc. Retrieved 1 November 2012.
- ↑ "About Modbus Organization". Modbus. Modbus Organization, Inc. Retrieved 8 November 2012.
- ↑ Modbus Messaging on TCP/IP Implementation Guide V1.0b, s3.1.3
- ↑ Remote Modbus Network Monitoring
- ↑ Java implementation
- ↑ http://www.rtaautomation.com/modbus/
- ↑ http://www.simplymodbus.ca/Enron.htm
- ↑ http://www.calscan.net/pdf/ModBus%20Driver%20Development%20Guide%201v13.pdf
- ↑ "Modbus Messaging On TCP/IP Implementation Guide" (PDF). Modbus Organization. Modbus-IDA.
- ↑ "Modbus Application Protocol V1.1b3" (PDF). Modbus. Modbus Organization, Inc. Retrieved 2 August 2013.
- ↑ Clarke, Gordon; Reynders, Deon (2004). Practical Modern Scada Protocols: Dnp3, 60870.5 and Related Systems. Newnes. pp. 47–51. ISBN 0-7506-5799-5.
- ↑ "Modbus 101 - Introduction to Modbus". Control Solutions, Inc.
- ↑ "Differences between JBUS and MODBUS protocols". Schneider Electric.
- ↑ "RENAULT AUTOMATION MERLIN GERIN ET CIE". French Corporate.
- ↑ "900 Series JBUS and MODBUS Digital Communications Handbook". Eurotherm Control.
- ↑ Palmer; Shenoi, Sujeet, eds. (23–25 March 2009). Critical Infrastructure Protection III. Third IFIP WG 11. 10 International Conference. Hanover, New Hampshire: Springer. p. 87. ISBN 3-642-04797-1.
- ↑ "Modbus Plus - Modbus Plus Network - Products overview - Schneider Electric United States". Schneider-electric.com. Retrieved 2014-01-03.
External links
- Official
- Modbus Organization with protocol specifications
- Modbus Protocol; Modicon; 74 pages; 2000.
- Other
- Free Modbus Guide for Field Technician
- Cost free Modbus RTU Device Testing Software
- Perl module for Modbus/TCP
- Pymodbus: Full Modbus protocol implementation in Python, free software
- MinimalModbus: Light RTU only Modbus implementation in Python
- modbus-tk: Fast Modbus Implementation in Python
- Interesting Performance comparison of the 3 above mentioned python modules
- Tcl based Modbus RTU driver
- Open Source C library of Modbus protocol for Linux, Mac OS X, FreeBSD, QNX and Win32
- Freeware Modbus Slave Simulator Application
- Free PeakHMI RTU, TCP/IP and ACSII slave simulators
- Jamod - Java library of Modbus protocol
- ModSlave - Modbus TCP Slave Device written in Python, Free Software
- digitalpetri Modbus - A modern, asynchronous Modbus implementation for Java
- Ananas - Modbus/TCP - server/client
|