Merge pull request #8 from NikolasK-source/development

Development

Author: NikolasK-source

.github/workflows/flatpak_release.yml

@@ -1,7 +1,6 @@
 on:
   push:
     branches: [release]
-  pull_request:
 name: Flatpak_release
 jobs:
   flatpak:

CMakeLists.txt

@@ -7,7 +7,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 project(Modbus_RTU_client_shm LANGUAGES CXX VERSION 0.1.3)
 
 # settings
-set(Target "Modbus_RTU_client_shm")    # Executable name (without file extension!)
+set(Target "modbus-rtu-client-shm")    # Executable name (without file extension!)
 set(STANDARD 17)                  # C++ Standard
 set(ARCHITECTURE "native")        # CPU architecture to optimize for (only relevant if OPTIMIZE_FOR_ARCHITECTURE is ON)
 
@@ -41,6 +41,7 @@ endif()
 
 # add executable
 add_executable(${Target})
+install(TARGETS ${Target})
 
 # set source and libraries directory
 add_subdirectory("src")
@@ -53,9 +54,11 @@ set_target_properties(${Target} PROPERTIES
         CXX_EXTENSIONS ${COMPILER_EXTENSIONS}
     )
 
-# project version and name
+# compiler definitions
 target_compile_definitions(${Target} PUBLIC "PROJECT_VERSION=\"${CMAKE_PROJECT_VERSION}\"")
 target_compile_definitions(${Target} PUBLIC "PROJECT_NAME=\"${CMAKE_PROJECT_NAME}\"")
+target_compile_definitions(${Target} PUBLIC "COMPILER_INFO=\"${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}\"")
+target_compile_definitions(${Target} PUBLIC "SYSTEM_INFO=\"${CMAKE_SYSTEM_NAME} ${CMAKE_SYSTEM_VERSION} ${CMAKE_HOST_SYSTEM_PROCESSOR}\"")
 
 # options that are valid for gcc and clang
 function(commonopts)

network.koesling.modbus-rtu-client-shm.yml

@@ -2,7 +2,7 @@ id: network.koesling.modbus-rtu-client-shm
 runtime: org.freedesktop.Platform
 runtime-version: '21.08'
 sdk: org.freedesktop.Sdk
-command: Modbus_RTU_client_shm
+command: modbus-rtu-client-shm
 finish-args:
   - --device=shm
   - --share=network
@@ -17,9 +17,7 @@ modules:
     - cmake --build build
 
     # install
-    - mkdir -p "${FLATPAK_DEST}/bin"
-    - cp build/Modbus_RTU_client_shm ${FLATPAK_DEST}/bin
-    - ls -lah ${FLATPAK_DEST}
+    - install -D -m 755 -t ${FLATPAK_DEST}/bin build/modbus-rtu-client-shm
     sources:
       - type: git
         branch: release

network.koesling.test-modbus-rtu-client-shm.yml

@@ -2,7 +2,7 @@ id: network.koesling.test-modbus-rtu-client-shm
 runtime: org.freedesktop.Platform
 runtime-version: '21.08'
 sdk: org.freedesktop.Sdk
-command: Modbus_RTU_client_shm
+command: modbus-rtu-client-shm
 finish-args:
   - --device=shm
   - --share=network
@@ -16,9 +16,7 @@ modules:
     - cmake --build build
 
     # install
-    - mkdir -p "${FLATPAK_DEST}/bin"
-    - cp build/Modbus_RTU_client_shm ${FLATPAK_DEST}/bin
-    - ls -lah ${FLATPAK_DEST}
+    - install -D -m 755 -t ${FLATPAK_DEST}/bin build/modbus-rtu-client-shm
     sources:
       - type: dir
         path: .

src/Modbus_RTU_Slave.cpp

@@ -62,6 +62,13 @@ Slave::Slave(const std::string &device,
         const std::string error_msg = modbus_strerror(errno);
         throw std::runtime_error("Failed to set modbus rtu mode to RS232: " + error_msg);
     }
+
+    // get socket
+    socket = modbus_get_socket(modbus);
+    if (socket == -1) {
+        const std::string error_msg = modbus_strerror(errno);
+        throw std::runtime_error("Failed to get socket: " + error_msg);
+    }
 }
 
 Slave::~Slave() {
@@ -97,5 +104,67 @@ bool Slave::handle_request() {
     return false;
 }
 
+struct timeout_t {
+    uint32_t sec;
+    uint32_t usec;
+};
+
+static inline timeout_t double_to_timeout_t(double timeout) {
+    timeout_t ret {};
+
+    ret.sec = static_cast<uint32_t>(timeout);
+
+    double fractional = timeout - static_cast<double>(ret.sec);
+    ret.usec          = static_cast<uint32_t>(fractional * 1000.0 * 1000.0);
+
+    return ret;
+}
+
+void Slave::set_byte_timeout(double timeout) {
+    const auto T   = double_to_timeout_t(timeout);
+    auto       ret = modbus_set_byte_timeout(modbus, T.sec, T.usec);
+
+    if (ret != 0) {
+        const std::string error_msg = modbus_strerror(errno);
+        throw std::runtime_error("modbus_receive failed: " + error_msg + ' ' + std::to_string(errno));
+    }
+}
+
+void Slave::set_response_timeout(double timeout) {
+    const auto T   = double_to_timeout_t(timeout);
+    auto       ret = modbus_set_response_timeout(modbus, T.sec, T.usec);
+
+    if (ret != 0) {
+        const std::string error_msg = modbus_strerror(errno);
+        throw std::runtime_error("modbus_receive failed: " + error_msg + ' ' + std::to_string(errno));
+    }
+}
+
+double Slave::get_byte_timeout() {
+    timeout_t timeout {};
+
+    auto ret = modbus_get_byte_timeout(modbus, &timeout.sec, &timeout.usec);
+
+    if (ret != 0) {
+        const std::string error_msg = modbus_strerror(errno);
+        throw std::runtime_error("modbus_receive failed: " + error_msg + ' ' + std::to_string(errno));
+    }
+
+    return static_cast<double>(timeout.sec) + (static_cast<double>(timeout.usec) / (1000.0 * 1000.0));
+}
+
+double Slave::get_response_timeout() {
+    timeout_t timeout {};
+
+    auto ret = modbus_get_response_timeout(modbus, &timeout.sec, &timeout.usec);
+
+    if (ret != 0) {
+        const std::string error_msg = modbus_strerror(errno);
+        throw std::runtime_error("modbus_receive failed: " + error_msg + ' ' + std::to_string(errno));
+    }
+
+    return static_cast<double>(timeout.sec) + (static_cast<double>(timeout.usec) / (1000.0 * 1000.0));
+}
+
 }  // namespace RTU
 }  // namespace Modbus

src/Modbus_RTU_Slave.hpp

@@ -17,6 +17,7 @@ class Slave {
     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)
@@ -57,6 +58,42 @@ class Slave {
      * @return true: connection closed
      */
     bool handle_request();
+
+    /*!
+     * \brief set byte timeout
+     *
+     * @details see https://libmodbus.org/docs/v3.1.7/modbus_set_byte_timeout.html
+     *
+     * @param timeout byte timeout in seconds
+     */
+    void set_byte_timeout(double timeout);
+
+    /*!
+     * \brief set byte timeout
+     *
+     * @details see https://libmodbus.org/docs/v3.1.7/modbus_set_response_timeout.html
+     *
+     * @param timeout byte response in seconds
+     */
+    void set_response_timeout(double timeout);
+
+    /**
+     * \brief get byte timeout in seconds
+     * @return byte timeout
+     */
+    double get_byte_timeout();
+
+    /**
+     * \brief get response timeout in seconds
+     * @return response timeout
+     */
+    double get_response_timeout();
+
+    /*! \brief get the modbus socket
+     *
+     * @return socket of the modbus connection
+     */
+    [[nodiscard]] int get_socket() const noexcept { return socket; }
 };
 
 }  // namespace RTU