 |
modbuspp
1.1.40
C++ wrapper for the libmodbus library
|
|
modbuspp
1.1.40
C++ wrapper for the libmodbus library
|
The libmodbuspp library provides a C++ overlay to libmodbus, a wrapper, having no other dependency than libmodbus and libstdc++. libmodbuspp is a free software library to send/receive data according to the MODBUS protocol. This library supports RTU (serial) and TCP (Ethernet) communications. libmodbussp allows you to implement MODBUS servers and clients. libmodbussp will be used in version 2 of the utility mbpoll. Like libmodbus, libmodbuspp is cross-platform and can be compiled on Gnu/Linux and other Unix, Windows™ and macOS™.
The Modbus::Master class allows you to design clients (also called masters), who communicate with servers (also called slaves). That is, Modbus::Master can read or write data to slaves. To do this, Modbus::Master is associated with the Modbus::Slave class which allows to perform the read and write operations, here are an example of use:
uint16_t values[2]; // array to store the values of the input registers
Master mb (Rtu, "COM1", "19200E1"); // new master on RTU
Slave & slv = mb.addSlave (33); // to the slave at address 33
mb.open(); // open a connection
slv.readInputRegisters (1, values, 2);
cout << values[0] << endl;
cout << values[1] << endl;This example reads the input registers number 1 and 2 of the MODBUS slave (server) at address 33. The source code of this program is searchable in the examples folder read-input-registers
The Modbus::Server class is used to design servers. An object of the class Modbus::Server allows to implement one or more slaves that can be dissociated by the use of a different address. The Modbus::Server class is associated with the Modbus::BufferedSlave class to implement slaves. Modbus::BufferedSlave used by Modbus::Server is derived from Modbus::Slave used by Modbus::Master, it allows to define data blocks corresponding to each MODBUS entity: input registers, discrete inputs, holding registers and coils.
Here is an example of use:
// ModBus Data
bool daylight;// daylight saving time, true = summer time
Data<int32_t> gmtoff; // GMT offset, +/- minutes
uint16_t mb_time[8]; // date and time
Server srv (Tcp, "127.0.0.1", "1502"); // new Modbus Server on TCP/IP
BufferedSlave & slv = srv.addSlave (10); // Adding a new slave to the server
defines the data blocks of our slave slv
slv.setBlock (InputRegister, 8); // date and time
slv.setBlock (HoldingRegister, 2); // GMT offset, +/- minutes
slv.setBlock (Coil, 1); // daylight saving time, ON = summer time
...
slv.writeCoil (1, daylight);
slv.writeRegister (1, gmtoff);
if (srv.open ()) { // open a connection
for (;;) {
now = time (nullptr);
if (now > before) {
before = now;
update daylight saving time from holding register
slv.readCoil (1, daylight);
update GMT offset from holding register
slv.readRegister (1, gmtoff);
calculate the epoch time
now += (daylight ? 3600 : 0) + gmtoff;
t = gmtime (&now);
mb_time[0] = t->tm_sec;
mb_time[1] = t->tm_min;
mb_time[2] = t->tm_hour;
mb_time[3] = t->tm_mday;
mb_time[4] = t->tm_mon + 1;
mb_time[5] = t->tm_year + 1900;
mb_time[6] = t->tm_wday;
mb_time[7] = t->tm_yday + 1;
update the input registers
slv.writeInputRegisters (1, mb_time, 8);
}
srv.poll (100);
}
}This example realizes a MODBUS time server which has the slave address 10. The source code of this program is searchable in the examples folder clock-server.
As can be seen in this example libmodbuspp also has a template class Modbus::Data that allows to easily manage registers of a size greater than or equal to 16 bits. This class allows you to manipulate all arithmetic types int, long, float, double... in the form of MODBUS registers in a transparent manner for the user. The default storage order of bytes and words is the big Indian but can be chosen when declaring the variable using enumeration Modbus::Endian, for example:
Data<float,EndianBigLittle> voltage;allows to define a floating number (32-bit) with a byte order in big Endian and a word organization in little Endian (CDAB).
A Modbus::BufferedSlave object is also able to relay the requests it receives to:
The processing of messages by the callback functions is simplified thanks to the Modbus::Request and Modbus::Response classes (derived from the Modbus::Message class).
The Server class is used to intercept received messages.
The installation of the callback function is performed by Server::setMessageCallback().
The function thus installed will be called if the slave address (unit identifier) does not correspond to any slave registered by Server::addSlave().
This will make it possible to process MODBUS messages not supported by libmodbus or, to route the messages to links not supported by libmodbus.
Here is an example of a callback function:
int messageHandler (Message * req, Device * dev) {
cout << "Receive message, size : " << req->aduSize() << endl;
if (req->function() == ReadInputRegisters) {
the dummy word will be the returned value, incremented after each reading
static uint16_t dummy = 1;
get request parameters
uint16_t N = req->quantity();
uint16_t index = req->startingAddress();
build response, see page 16 of MODBUS Application Protocol Specification
Response rsp (*req); // uses copy constructor to keep transaction id
rsp.setSize(1); // keep until function code
rsp.setByteCount (N * 2);
for (uint16_t i = 0; i < N; i++) {
rsp.setRegisterValue (index + i, dummy++);
}
return dev->sendRawMessage (rsp, true);
}
return 0;
}The virtual-server example illustrates this functionality.
The Modbus::Router class performs a MODBUS message routing using the additional address which is a byte which precedes the byte of the function code. This additional address is also called "Unit Identifier" in MODBUS-TCP and address fields or slave address in MODBUS-OSL.
A Router object is in permanent listening on its link from the outside, it is seen by the remote client as a server which groups all the slaves connected on the link or links from the inside.
As the Router class is derived from the Server class, it also makes it possible to create slaves consisting only of primary tables (discrete inputs, input registers, etc.) in memory.
Whether outside or inside, the links can be over TCP-IP or serial link (RTU).
The connection from the outside is configured either with setBackend() or with setConfig() (or the corresponding variants of the Router constructor).
Inside bindings are added using addMaster() methods. This makes sense because these links control slaves. As the MODBUS masters do not have an address on the bus, they are identified by a name.
Here is a diagram showing an example of use:
The routing elements are BufferedSlave which are added using addSlave(). The master parameter indicates the route to take to communicate with this slave. If this parameter is zero, the slave is made up only of primary tables. The slaves are naturally identified by the identifiers (additional address).
All this can be described in a JSON file, which allows you to simply modify the routing structure without having to recompile.
The json file below corresponds to the description of a router listening on TCP-IP (port 1502 of localhost). It has two routing links to a hardware serial link (/dev/ttyUSB0) where slave 33 is located (SolarPi pressure sensor) and a virtual serial link (/dev/tnt0) where slave 10 is located (clock-server-json):
{
"modbuspp-router": {
"mode": "tcp",
"connection": "localhost",
"settings": "1502",
"recovery-link": true,
"debug": true,
"response-timeout": 500,
"byte-timeout": 500,
"masters": [
{
"name": "rs232",
"mode": "rtu",
"connection": "/dev/ttyUSB0",
"settings": "38400E1",
"debug": true,
"response-timeout": 500,
"byte-timeout": 500,
"slaves": [
{
"id": 33,
"blocks": [
{
"table": "input-register",
"quantity": 6
},
{
"table": "holding-register",
"quantity": 8
}
]
}
]
},
{
"name": "virtual-clock",
"mode": "rtu",
"connection": "/dev/tnt0",
"settings": "38400E1",
"debug": true,
"response-timeout": 3000,
"byte-timeout": 500,
"slaves": [
{
"id": 10,
"blocks": [
{
"table": "input-register",
"quantity": 8
},
{
"table": "holding-register",
"quantity": 2
},
{
"table": "coil",
"quantity": 1
}
]
}
]
}
]
}
}The program to perform this routing is very simple :
string jsonfile = argv[1];
Router router (jsonfile, "modbuspp-router");if (router.open ()) { router.run();
while (router.isOpen()) { std::this_thread::sleep_for (std::chrono::milliseconds (200));
}
}How beautiful is that ? :-)
The source code of this program is searchable in the examples folder router-json.
libmodbus does not support routing in RTU, in fact, only messages intended for a single slave (that of the context) or broadcast are processed.
The author of libmodbus, Stéphane, justifies this choice in his terms:
"Filter on the Modbus unit identifier (slave) in RTU mode to avoid useless CRC computing."
To benefit from the routing capacity of the Router and Server classes in RTU, you must therefore use the fork of libmodbus named libmodbusepsi. In this fork released from the piduino repository, filtering can be disabled (with modbus_rtu_set_recv_filter()).
Thus, it is the Server class which performs this filtering (after checking the CRC therefore). Effectively, this has the effect of loading the microprocessor, but, at present, the computing power of our machines is such that it does not pose a problem.
libmodbuspp comes with full documentation in manual and html format.
The fastest and safest way to install libmodbuspp on Debian, Armbian, Raspbian ... is to use the APT repository from piduino.org, so you should do the following :
wget -O- http://www.piduino.org/piduino-key.asc | sudo apt-key add -
sudo add-apt-repository 'deb http://apt.piduino.org stretch piduino'
sudo apt update
sudo apt install libmodbuspp-dev libmodbuspp-doc This repository provides Piduino packages for i386, amd64, armhf and arm64 architectures.
In the above commands, the repository is a Debian Stretch distribution, but you can also choose Buster, Ubuntu Xenial or Bionic by replacing stretch with bsuter, xenial or bionic. It may be necessary to install the software-properties-common package for add-apt-repository.
For Raspbian you have to do a little different :
wget -O- http://www.piduino.org/piduino-key.asc | sudo apt-key add -
echo 'deb http://raspbian.piduino.org stretch piduino' | sudo tee /etc/apt/sources.list.d/piduino.list
sudo apt update
sudo apt install libmodbuspp-dev libmodbuspp-docThe Raspbian repository provides Piduino packages for armhf architecture for Stretch only.
If you want to build from sources, you can follow the Wiki.
Here is a complete example that can be compiled without error:
#include <iostream>
#include <string>
#include <modbuspp.h>using namespace std;
using namespace Modbus;int main (int argc, char **argv) {
string port ("/dev/ttyUSB0"); Master mb (Rtu, port , "38400E1"); // new master on RTU
Slave & slv = mb.addSlave (33); // to the slave at address 33 if (mb.open ()) { // open a connection
success, do what you want here
uint16_t values[2]; if (slv.readInputRegisters (1, values, 2) == 2) { cout << "R0=" << values[0] << endl;
cout << "R1=" << values[1] << endl;
}
else {
cerr << "Unable to read input registers !" << endl;
exit (EXIT_FAILURE);
}
mb.close();
}
else {
cerr << "Unable to open MODBUS connection to " << port << endl;
exit (EXIT_FAILURE);
} return 0;
}Enter the text of this program with your favorite text editor and save the file in main.cpp
To build, you must type the command:
g++ -o read-input-registers main.cpp $(pkg-config --cflags --libs modbuspp)You can then run it :
./read-input-registers
R0=9964
R1=10029With Codelite it's easier and funny, right ?
You will find several examples in the folder /usr/share/doc/modbuspp/examples
The libmodbuspp-doc package provides documentation.
The classes provided by the library are documented by man pages:
Modbus::Master class Modbus::Slave class Modbus::Server class Modbus::Router class Modbus::BufferedSlave class Modbus::Data class Modbus::Request class Modbus::Response class Modbus::RtuLayer class Modbus::TcpLayer class Modbus::Timeout class The complete API is documented in the folder /usr/share/doc/modbuspp/api-manual
MODBUS is considered an application layer messaging protocol, providing Master/Slave communication between devices connected together through buses or networks. On the OSI model, MODBUS is positioned at level 7. MODBUS is intended to be a request/reply protocol and delivers services specified by function codes. The function codes of MODBUS are elements of MODBUS’ request/reply PDUs (Protocol Data Unit).
In order to build the MODBUS application data unit, the client must initiate a MODBUS transaction. It is the function which informs the server as to which type of action to perform. The format of a request initiated by a Master is established by the MODBUS application protocol. The function code field is then coded into one byte. Only codes within the range of 1 through 255 are considered valid, with 128-255 being reserved for exception responses. When the Master sends a message to the Slave, it is the function code field which informs the server of what type of action to perform.
To define multiple actions, some functions will have sub-function codes added to them. For instance, the Master is able to read the ON/OFF states of a group of discreet outputs or inputs. It could also read/write the data contents of a group of MODBUS registers. When the Master receives the Slave response, the function code field is used by the Slave to indicate either an error-free response or an exception response. The Slave echoes to the request of the initial function code in the case of a normal response.
1.8.13