Merge pull request #12 from NikolasK-source/main

NikolasK-source · web-flow · commit aeca250f9849 · 2022-09-02T15:08:37.000+02:00
Release 0.2.3
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.2.2)
+project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.2.3)
 
 # settings
 set(Target "modbus-rtu-client-shm")    # Executable name (without file extension!)
diff --git a/README.md b/README.md
@@ -16,32 +16,43 @@ As an alternative to the ```git submodule``` commands, the ```--recursive``` opt
 
 ## Use
 ```
-Modbus_RTU_client_shm [OPTION...]
-
-  -d, --device arg        mandatory: serial device
-  -i, --id arg            mandatory: modbus RTU slave id
-  -p, --parity arg        serial parity bit (N(one), E(ven), O(dd)) (default: N)
-      --data-bits arg     serial data bits (5-8) (default: 8)
-      --stop-bits arg     serial stop bits (1-2) (default: 1)
-  -b, --baud arg          serial baud (default: 9600)
-      --rs485             force to use rs485 mode
-      --rs232             force to use rs232 mode
-  -n, --name-prefix arg   shared memory name prefix (default: modbus_)
-      --do-registers arg  number of digital output registers (default: 65536)
-      --di-registers arg  number of digital input registers (default: 65536)
-      --ao-registers arg  number of analog output registers (default: 65536)
-      --ai-registers arg  number of analog input registers (default: 65536)
-  -m, --monitor           output all incoming and outgoing packets to stdout
-  -h, --help              print usage
+modbus-rtu-client-shm [OPTION...]
+
+  -d, --device arg            mandatory: serial device
+  -i, --id arg                mandatory: modbus RTU client id
+  -p, --parity arg            serial parity bit (N(one), E(ven), O(dd)) (default: N)
+      --data-bits arg         serial data bits (5-8) (default: 8)
+      --stop-bits arg         serial stop bits (1-2) (default: 1)
+  -b, --baud arg              serial baud (default: 9600)
+      --rs485                 force to use rs485 mode
+      --rs232                 force to use rs232 mode
+  -n, --name-prefix arg       shared memory name prefix (default: modbus_)
+      --do-registers arg      number of digital output registers (default: 65536)
+      --di-registers arg      number of digital input registers (default: 65536)
+      --ao-registers arg      number of analog output registers (default: 65536)
+      --ai-registers arg      number of analog input registers (default: 65536)
+  -m, --monitor               output all incoming and outgoing packets to stdout
+      --byte-timeout arg      timeout interval in seconds between two consecutive bytes of the same message. In most 
+                              cases it is sufficient to set the response timeout. Fractional values are possible.
+      --response-timeout arg  set the timeout interval in seconds used to wait for a response. When a byte timeout is 
+                              set, if the elapsed time for the first byte of response is longer than the given timeout, 
+                              a timeout is detected. When byte timeout is disabled, the full confirmation response must 
+                              be received before expiration of the response timeout. Fractional values are possible.
+      --force                 Force the use of the shared memory even if it already exists. Do not use this option per 
+                              default! It should only be used if the shared memory of an improperly terminated instance 
+                              continues to exist as an orphan and is no longer used.
+  -h, --help                  print usage
+      --version               print version information
+      --license               show licences
 
 
 The modbus registers are mapped to shared memory objects:
-    type | name                      | master-access   | shm name
-    -----|---------------------------|-----------------|----------------
-    DO   | Discrete Output Coils     | read-write      | <name-prefix>DO
-    DI   | Discrete Input Coils      | read-only       | <name-prefix>DI
-    AO   | Discrete Output Registers | read-write      | <name-prefix>AO
-    AI   | Discrete Input Registers  | read-only       | <name-prefix>AI
+    type | name                      | mb-server-access | shm name
+    -----|---------------------------|------------------|----------------
+    DO   | Discrete Output Coils     | read-write       | <name-prefix>DO
+    DI   | Discrete Input Coils      | read-only        | <name-prefix>DI
+    AO   | Discrete Output Registers | read-write       | <name-prefix>AO
+    AI   | Discrete Input Registers  | read-only        | <name-prefix>AI
 ```
 
 ## Libraries
diff --git a/docs/index.md b/docs/index.md
@@ -13,7 +13,7 @@ One for each register type:
 - Discrete Input Registers (AI)
 
 All registers are initialized with 0 at the beginning.
-The Modbus master reads and writes directly the values from these shared memories.
+The Modbus server reads and writes directly the values from these shared memories.
 
 The actual functionality of the client is realized by applications that read data from or write data to the shared memory.
 
@@ -24,7 +24,7 @@ The registers (AI, AO) use 10 bit per value. The user is responsible for handlin
 The application requires a serial device (```--device```) and a client id (```--id```) as arguments. All other arguments are optional.
 
 By using the command line argument ```--monitor``` all incoming and outgoing packets are printed on stdout.
-This option should be used carefully, as it generates large amounts of output depending on the masters polling cycle and the number of used registers.
+This option should be used carefully, as it generates large amounts of output depending on the Modbus servers polling cycle and the number of used registers.
 
 The client creates four shared memories and names them ```modbus_DO```, ```modbus_DI```, ```modbus_AO``` and ```modbus_AI``` by default.
 The prefix modbus_ can be changed via the argument ```--name-prefix```. 
@@ -50,8 +50,14 @@ Connect as device with id ```1``` using serial device ```/dev/ttyS0``` and enfor
 ```
 modbus-rtu-client-shm -d /dev/ttyS0 -i 1 --rs232
 ```
+## Install
 
-## Using the Flatpak package
+### Using the Modbus Collection Flapak Package: Shared Memory Modbus (recommended)
+[SHM-Modbus](https://nikolask-source.github.io/SHM_Modbus/) is a collection of the shared memory modbus tools.
+It is available as flatpak and published on flathub as ```network.koesling.shm-modbs```.
+
+
+### Using the Standalone Flatpak Package
 The flatpak package can be installed via the .flatpak file.
 This can be downloaded from the GitHub [projects release page](https://github.com/NikolasK-source/modbus_rtu_client_shm/releases):
 
@@ -68,7 +74,7 @@ To enable calling with ```modbus-rtu-client-shm``` [this script](https://gist.gi
 In order to be executable everywhere, the path in which the script is placed must be in the ```PATH``` environment variable.
 
 
-## Build from Source
+### Build from Source
 
 The following packages are required for building the application:
 - cmake
diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -3,14 +3,14 @@
 
 target_sources(${Target} PRIVATE main.cpp)
 target_sources(${Target} PRIVATE modbus_shm.cpp)
-target_sources(${Target} PRIVATE Modbus_RTU_Slave.cpp)
+target_sources(${Target} PRIVATE Modbus_RTU_Client.cpp)
 target_sources(${Target} PRIVATE license.cpp)
 
 
 # ---------------------------------------- header files (*.jpp, *.h, ...) ----------------------------------------------
 # ======================================================================================================================
 target_sources(${Target} PRIVATE modbus_shm.hpp)
-target_sources(${Target} PRIVATE Modbus_RTU_Slave.hpp)
+target_sources(${Target} PRIVATE Modbus_RTU_Client.hpp)
 target_sources(${Target} PRIVATE license.hpp)
 
 
diff --git a/src/Modbus_RTU_Client.cpp b/src/Modbus_RTU_Client.cpp
@@ -3,7 +3,7 @@
  * This program is free software. You can redistribute it and/or modify it under the terms of the MIT License.
  */
 
-#include "Modbus_RTU_Slave.hpp"
+#include "Modbus_RTU_Client.hpp"
 
 #include <stdexcept>
 
@@ -12,15 +12,15 @@ namespace RTU {
 
 static constexpr int MAX_REGS = 0x10000;
 
-Slave::Slave(const std::string &device,
-             int                id,
-             char               parity,
-             int                data_bits,
-             int                stop_bits,
-             int                baud,
-             bool               rs232,
-             bool               rs485,
-             modbus_mapping_t  *mapping) {
+Client::Client(const std::string &device,
+               int                id,
+               char               parity,
+               int                data_bits,
+               int                stop_bits,
+               int                baud,
+               bool               rs232,
+               bool               rs485,
+               modbus_mapping_t  *mapping) {
     // create modbus object
     modbus = modbus_new_rtu(device.c_str(), baud, parity, data_bits, stop_bits);
     if (modbus == nullptr) {
@@ -71,22 +71,22 @@ Slave::Slave(const std::string &device,
     }
 }
 
-Slave::~Slave() {
+Client::~Client() {
     if (modbus != nullptr) {
         modbus_close(modbus);
         modbus_free(modbus);
     }
     if (mapping != nullptr && delete_mapping) modbus_mapping_free(mapping);
 }
 
-void Slave::set_debug(bool debug) {
+void Client::set_debug(bool debug) {
     if (modbus_set_debug(modbus, debug)) {
         const std::string error_msg = modbus_strerror(errno);
         throw std::runtime_error("failed to enable modbus debugging mode: " + error_msg);
     }
 }
 
-bool Slave::handle_request() {
+bool Client::handle_request() {
     // receive modbus request
     uint8_t query[MODBUS_TCP_MAX_ADU_LENGTH];
     int     rc = modbus_receive(modbus, query);
@@ -120,7 +120,7 @@ static inline timeout_t double_to_timeout_t(double timeout) {
     return ret;
 }
 
-void Slave::set_byte_timeout(double timeout) {
+void Client::set_byte_timeout(double timeout) {
     const auto T   = double_to_timeout_t(timeout);
     auto       ret = modbus_set_byte_timeout(modbus, T.sec, T.usec);
 
@@ -130,7 +130,7 @@ void Slave::set_byte_timeout(double timeout) {
     }
 }
 
-void Slave::set_response_timeout(double timeout) {
+void Client::set_response_timeout(double timeout) {
     const auto T   = double_to_timeout_t(timeout);
     auto       ret = modbus_set_response_timeout(modbus, T.sec, T.usec);
 
@@ -140,7 +140,7 @@ void Slave::set_response_timeout(double timeout) {
     }
 }
 
-double Slave::get_byte_timeout() {
+double Client::get_byte_timeout() {
     timeout_t timeout {};
 
     auto ret = modbus_get_byte_timeout(modbus, &timeout.sec, &timeout.usec);
@@ -153,7 +153,7 @@ double Slave::get_byte_timeout() {
     return static_cast<double>(timeout.sec) + (static_cast<double>(timeout.usec) / (1000.0 * 1000.0));
 }
 
-double Slave::get_response_timeout() {
+double Client::get_response_timeout() {
     timeout_t timeout {};
 
     auto ret = modbus_get_response_timeout(modbus, &timeout.sec, &timeout.usec);
diff --git a/src/Modbus_RTU_Client.hpp b/src/Modbus_RTU_Client.hpp
@@ -11,19 +11,19 @@
 namespace Modbus {
 namespace RTU {
 
-//! Modbus RTU slave
-class Slave {
+//! Modbus RTU client
+class Client {
 private:
     modbus_t         *modbus;          //!< modbus object (see libmodbus library)
     modbus_mapping_t *mapping;         //!< modbus data object (see libmodbus library)
     bool              delete_mapping;  //!< indicates whether the mapping object was created by this instance
     int               socket = -1;     //!< internal modbus communication socket
 
 public:
-    /*! \brief create modbus slave (TCP server)
+    /*! \brief create modbus client (TCP server)
      *
      * @param device serial device
-     * @param id modbus rtu slave id
+     * @param id modbus rtu client id
      * @param parity serial parity bit (N(one), E(ven), O(dd))
      * @param data_bits number of serial data bits
      * @param stop_bits number of serial stop bits
@@ -32,28 +32,28 @@ class Slave {
      * @param rs485 connect using rs485 mode
      * @param mapping modbus mapping object (nullptr: an mapping object with maximum size is generated)
      */
-    explicit Slave(const std::string &device,
-                   int                id,
-                   char               parity,
-                   int                data_bits,
-                   int                stop_bits,
-                   int                baud,
-                   bool               rs232,
-                   bool               rs485,
-                   modbus_mapping_t  *mapping = nullptr);
+    explicit Client(const std::string &device,
+                    int                id,
+                    char               parity,
+                    int                data_bits,
+                    int                stop_bits,
+                    int                baud,
+                    bool               rs232,
+                    bool               rs485,
+                    modbus_mapping_t  *mapping = nullptr);
 
-    /*! \brief destroy the modbus slave
+    /*! \brief destroy the modbus client
      *
      */
-    ~Slave();
+    ~Client();
 
     /*! \brief enable/disable debugging output
      *
      * @param debug true: enable debug output
      */
     void set_debug(bool debug);
 
-    /*! \brief wait for request from Master and generate reply
+    /*! \brief wait for request from Modbus Server and generate reply
      *
      * @return true: connection closed
      */
diff --git a/src/main.cpp b/src/main.cpp
