openenergysolutions/modbus-cpp

Modbus TCP master library in modern C++

modbus-cpp

Modbus TCP master library in modern C++.

Requirements

• CMake 3.8 and higher
• A modern C++ compiler supporting at least C++14

Building

1. Clone the repository recursively with git clone https://github.com/aegis4ics/modbus-cpp.git --recursive

2. Create a build directory inside the project (all folders starting with build are ignored by git)

3. Inside the build directory, configure the project using cmake .. or the interactive ccmake .. The default options should work out of the box.

4. Build the project with cmake --build .

5. Execute the example with ./example/modbus_example

Tests

To run the tests, simply execute ctest . in your build directory.

Note: AsioClientTcpConnectionTest and AsioServerTest requires that the port 8888 is available. If for any reason this port is not available, either skip the tests by appending ~AsioClientTcpConnection ~AsioServer to the command line arguments, or change the test_port variable in AsioClientTcpConnectionTest and AsioServerTest.

To run performance tests, simply build and run target modbus_perf_tests. It will create 100 servers (from port 8000 to 8199), with 20 clients connected to each server. Each client will send a random request at a random interval (between 1 and 10 seconds). Each server is configured to accept only 16 connections at a time, therefore the servers will be closing connections and the clients will re-open others. This test requires 2200 file descriptors to work.

Documentation

The documentation of the master branch is available online here: https://aegis4ics.github.io/modbus-cpp/

To build the basic Doxygen documentation, simply run doxygen in the root directory of the repository. The documentation will be generated in the build/doc folder.

To build the documentation with the custom theme, the following dependencies are needed:

• Doxygen 1.8.14 or higher
• Python 3.6
• Jinja2 (installable by pip)
• Pygments (installable by pip)
• m.css submodule (available in this repository)

A Docker image with all the required dependency is available here: https://hub.docker.com/r/emgre/circleci-doxygen/

To build the documentation with the theme, simply run deps/m.css/doxygen/dox2html5.py Doxyfile-mcss. The documentation will be generated in the build/doc folder. You can also run the doc CMake target to run the command.