Added install command for cmake

Author: serhmarch

CMakeLists.txt

@@ -26,4 +26,79 @@ set(MB_QT_ENABLED ON)
 set(MB_C_SUPPORT_DISABLE ON)
 add_subdirectory(modbus/src)
 
-add_subdirectory(src)
+add_subdirectory(src/core)
+
+add_subdirectory(src/client)
+
+add_subdirectory(src/server)
+
+# Check if Doxygen is available
+find_package(Doxygen)
+
+if (DOXYGEN_FOUND)
+    message("Doxygen found: ${DOXYGEN_EXECUTABLE}")
+    # Add a target to generate Doxygen documentation for the client
+    add_custom_target(DoxygenClient
+        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileClient
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
+        COMMENT "Generating Doxygen documentation for Client"
+        VERBATIM
+    )
+
+    # Add a target to generate Doxygen documentation for the server
+    add_custom_target(DoxygenServer
+        COMMAND ${DOXYGEN_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/DoxyfileServer
+        WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc
+        COMMENT "Generating Doxygen documentation for Server"
+        VERBATIM
+    )
+
+    # Find qhelpgenerator executable
+    find_program(QHELPGENERATOR_EXECUTABLE qhelpgenerator)
+
+    if (QHELPGENERATOR_EXECUTABLE)
+        message("qhelpgenerator found: ${QHELPGENERATOR_EXECUTABLE}")
+
+        # Add a target to generate Qt help files for the server
+        add_custom_target(QtHelpServer
+            COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusServer.qhcp
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
+            COMMENT "Generating Qt help files for Server"
+            VERBATIM
+        )
+
+        # Add a target to generate Qt help files for the client
+        add_custom_target(QtHelpClient
+            COMMAND ${QHELPGENERATOR_EXECUTABLE} ${CMAKE_SOURCE_DIR}/doc/output/ModbusClient.qhcp
+            WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/doc/output
+            COMMENT "Generating Qt help files for Client"
+            VERBATIM
+        )
+
+        # Make sure QtHelpServer runs after DoxygenServer
+        add_dependencies(QtHelpServer DoxygenServer)
+
+        # Make sure QtHelpClient runs after DoxygenClient
+        add_dependencies(QtHelpClient DoxygenClient)
+    else()
+        message(STATUS "qhelpgenerator not found. Qt help targets will not be generated.")
+    endif()
+else()
+    message(STATUS "Doxygen not found. Documentation targets will not be generated/regenerated.")
+endif()
+
+install(TARGETS ${MB_LIBRARY_NAME}         DESTINATION .)
+install(TARGETS ${MBTOOLS_CORE_LIB_NAME}   DESTINATION .)
+install(TARGETS ${MBTOOLS_CLIENT_APP_NAME} DESTINATION .)
+install(TARGETS ${MBTOOLS_SERVER_APP_NAME} DESTINATION .)
+
+# Install scripts
+# Collect Python files using GLOB
+file(GLOB MBTOOLS_SCRIPT_FILES "${CMAKE_SOURCE_DIR}/src/server/python/*.py")
+# Install Python files
+install(FILES ${MBTOOLS_SCRIPT_FILES} DESTINATION "./script/server")
+
+# Install help files
+# Collect help files using GLOB
+file(GLOB MBTOOLS_HELP_FILES "${CMAKE_SOURCE_DIR}/doc/output/*.qch" "${CMAKE_SOURCE_DIR}/doc/output/*.qhc")
+install(FILES ${MBTOOLS_HELP_FILES} DESTINATION "./help")

ModbusTools.pro

@@ -1,13 +1,11 @@
 TEMPLATE = subdirs
 
 # Specify the location where the help files should be installed
-HELPDIR = $$OUT_PWD/bin/help
+HELPDIR = $$OUT_PWD/help
 
 # List of help files to install
-help.files = $$PWD/../help/client/*.qch \
-             $$PWD/../help/client/*.qhc \
-             $$PWD/../help/server/*.qch \
-             $$PWD/../help/server/*.qhc
+help.files = $$PWD/doc/output/*.qch \
+             $$PWD/doc/output/*.qhc
 
 help.path = $$HELPDIR
 help.depends = $(first)

changelog.md

@@ -149,4 +149,7 @@ List of changes of new v0.4 version of ModbusTools:
 
 * Fixed TCP Server delay while connecting (within ModbusLib subproject)
 * Added setting 'Max Connections' for max simultanious TCP server connections
+* Added support for script modules for the ModbusTools server
+* Added install command for cmake script
+
 

doc/README.md

@@ -62,6 +62,7 @@ c:\Qt\5.15.2\msvc2019_64\bin\assistant.exe -collectionFile "output/ModbusServer.
 Assumed application dir view:
 * server.exe
 * client.exe
+* ...
 * help : <dir>
     * ModbusClient.qch
     * ModbusClient.qhc

doc/output/ModbusClient.chm

@@ -2,89 +2,9 @@
 
 This page describes the process of building a ModbusTools project from source files.
 
-## Building ModbusTools from source on Windows
-
-### Preparation
-
-The ModbusTools project requires Qt version 5.8 or later.
-
-1. Download qt-online-installer, follow the link and choose Windows version for installer:
-
-https://www.qt.io/download-qt-installer
-
-2. Run qt-online-installer and install all necessary components: Qt 5 (Qt5.15.2) framework.
-
-Qt 5.8 or higher is needed so in `Select Components` window check `Archive` checkbox and push `Filter` button.
-Then is better to check latest version of Qt5.15 framework (e.g. 5.15.2)
-
-3. Download and install git for Windows or use WSL and install git for WSL.
-
-4. Make dir for binaries, e.g. in `<user-home-dir>\bin\ModbusTools` using Windows command console:
-   ```console
-   >cd `<user-home-dir>`
-   >mkdir bin\ModbusTools
-   >cd bin\ModbusTools
-   ```
-5. Clone repository:
-   ```console
-   $ git clone --recursive https://github.com/serhmarch/ModbusTools.git
-   ```
-
-### Build using qmake
-
-This example shows how to build `ModbusTools` for MSVC compiler using `qmake`.
-
-1. Open Windows command console and initialize all MSVC compiler vars (e.g. include, lib) using `vcvarsall.bat` script.
-   This script will be configured for x64 arch (use `...\vcvarsall.bat -help` to display all options):
-   `console
-
-   > "c:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
-   > `
-
-2. Run qmake to produce `Makefile`.
-   This command will make `Release` version, for `Debug` replase with `"CONFIG+=debug"`:
-   `console
-
-   > C:\Qt\5.15.2\msvc2019_64\bin\qmake.exe path\to\ModbusTools.pro -spec win32-msvc "CONFIG+=release"
-   > `
-
-3. Produce all make files:
-
-   ```console
-   >C:\Qt\Tools\QtCreator\bin\jom\jom.exe -f Makefile qmake_all
-   ```
-
-4. Build project from Makefile's:
-   ```console
-   >C:\Qt\Tools\QtCreator\bin\jom\jom.exe
-   ```
-
-### Build using cmake
-
-1.  Run cmake to generate project (make) files.
-    `CMAKE_PREFIX_PATH` must be set to installed Qt framewrok files:
-    `console
-    > cmake -DCMAKE_PREFIX_PATH:PATH=C:/Qt/5.15.2/msvc2019_64 -S path\to\ModbusTools -B .
-    > `
-2.  Make binaries (+ debug|release config):
-    ```console
-    $ cmake --build .
-    $ cmake --build . --config Debug
-    $ cmake --build . --config Release
-    ```
-3.  Resulting bin files is located in `Debug` or `Release` directory.
-
-#### Build using CMakePresets.json
-
-```console
-cmake --preset "Win64-MSVC"
-cmake --build --preset "Win64-MSVC-Debug"
-cmake --build --preset "Win64-MSVC-Release"
-```
-
 ## Building ModbusTools from source on Linux
 
-### Preparation
+### Preparations
 
 The ModbusTools project requires Qt version 5.8 or later.
 
@@ -147,6 +67,46 @@ The ModbusTools project requires Qt version 5.8 or later.
     $ cd bin/ModbusTools
     ```
 
+### Build using cmake
+
+1.  Run cmake to generate project (make) files.
+
+    ```console
+    $ cmake -S ~/src/ModbusTools -B .
+    ```
+
+2.  Make binaries (+ debug|release config):
+    ```console
+    $ cmake --build .
+    $ cmake --build . --config Debug
+    $ cmake --build . --config Release
+    ```
+3.  Resulting bin files is located in `./bin` directory.
+
+#### Build using CMakePresets.json
+
+```console
+cmake --preset "Linux-Debug"
+cmake --build --preset "Linux-Debug"
+
+cmake --preset "Linux-Release"
+cmake --build --preset "Linux-Release"
+```
+
+### Install using cmake
+
+To install compiled binaries and other necessary files run next command:
+
+```console
+$ cmake --install <build_dir> --prefix <install_dest_dir>
+```
+
+Next command installs files from build dir into ModbusTools dir of user's home directory:
+
+```console
+$ cmake --install . --prefix "$HOME/ModbusTools"
+```
+
 ### Build using qmake
 
 1.  Run qmake to create Makefile for build:
@@ -189,30 +149,98 @@ The ModbusTools project requires Qt version 5.8 or later.
     -rwxr-xr-x 1 march march 269888 Sep 27 16:24 libmodbus.so.1.0.0
     ```
 
-### Build using cmake
+## Building ModbusTools from source on Windows
 
-1.  Run cmake to generate project (make) files.
+### Preparation
 
-    ```console
-    $ cmake -S ~/src/ModbusTools -B .
-    ```
+The ModbusTools project requires Qt version 5.8 or later.
+
+1. Download qt-online-installer, follow the link and choose Windows version for installer:
+
+https://www.qt.io/download-qt-installer
+
+2. Run qt-online-installer and install all necessary components: Qt 5 (Qt5.15.2) framework.
+
+Qt 5.8 or higher is needed so in `Select Components` window check `Archive` checkbox and push `Filter` button.
+Then is better to check latest version of Qt5.15 framework (e.g. 5.15.2)
+
+3. Download and install git for Windows or use WSL and install git for WSL.
+
+4. Make dir for binaries, e.g. in `<user-home-dir>\bin\ModbusTools` using Windows command console:
+   ```console
+   >cd `<user-home-dir>`
+   >mkdir bin\ModbusTools
+   >cd bin\ModbusTools
+   ```
+5. Clone repository:
+   ```console
+   $ git clone --recursive https://github.com/serhmarch/ModbusTools.git
+   ```
+
+### Build using qmake
+
+This example shows how to build `ModbusTools` for MSVC compiler using `qmake`.
 
+1. Open Windows command console and initialize all MSVC compiler vars (e.g. include, lib) using `vcvarsall.bat` script.
+   This script will be configured for x64 arch (use `...\vcvarsall.bat -help` to display all options):
+   `console
+
+   > "c:\Program Files\Microsoft Visual Studio\2022\Community\VC\Auxiliary\Build\vcvarsall.bat" x64
+   > `
+
+2. Run qmake to produce `Makefile`.
+   This command will make `Release` version, for `Debug` replase with `"CONFIG+=debug"`:
+   `console
+
+   > C:\Qt\5.15.2\msvc2019_64\bin\qmake.exe path\to\ModbusTools.pro -spec win32-msvc "CONFIG+=release"
+   > `
+
+3. Produce all make files:
+
+   ```console
+   >C:\Qt\Tools\QtCreator\bin\jom\jom.exe -f Makefile qmake_all
+   ```
+
+4. Build project from Makefile's:
+   ```console
+   >C:\Qt\Tools\QtCreator\bin\jom\jom.exe
+   ```
+
+### Build using cmake
+
+1.  Run cmake to generate project (make) files.
+    `CMAKE_PREFIX_PATH` must be set to installed Qt framewrok files:
+    `console
+    > cmake -DCMAKE_PREFIX_PATH:PATH=C:/Qt/5.15.2/msvc2019_64 -S path\to\ModbusTools -B .
+    > `
 2.  Make binaries (+ debug|release config):
     ```console
     $ cmake --build .
     $ cmake --build . --config Debug
     $ cmake --build . --config Release
     ```
-3.  Resulting bin files is located in `./bin` directory.
+3.  Resulting bin files is located in `Debug` or `Release` directory.
 
 #### Build using CMakePresets.json
 
 ```console
-cmake --preset "Linux-Debug"
-cmake --build --preset "Linux-Debug"
+cmake --preset "Win64-MSVC"
+cmake --build --preset "Win64-MSVC-Debug"
+cmake --build --preset "Win64-MSVC-Release"
+```
 
-cmake --preset "Linux-Release"
-cmake --build --preset "Linux-Release"
+### Install using cmake
+
+To install compiled binaries and other necessary files run next command:
+
+```console
+> cmake --install <build_dir> --prefix <install_dest_dir>
+```
+
+Next command installs files from build dir into ModbusTools dir of user's home directory:
+
+```console
+> cmake --install . --prefix "%USERPROFILE%\ModbusTools"
 ```
 
 ## Build Docker Image
@@ -232,6 +260,23 @@ The GUIs will be exposed via a web server on port 6080.
    ```
 3. Access the application at `http://localhost:6080/vnc.html`
 
+# Install ModbusTools
+
+General view of ModbusTools applications dir:
+* modbus.dll
+* core.dll
+* server.exe
+* client.exe
+* script : [dir]
+    * server : [dir]
+        * mbserver.py
+* help : [dir]
+    * ModbusClient.qch
+    * ModbusClient.qhc
+    * ModbusServer.qch
+    * ModbusServer.qhc
+
+## Install using cmake
 
 ## Arch Linux Install
 

doc/output/ModbusServer.chm

@@ -6,7 +6,7 @@ project(
   VERSION ${PROJECT_VERSION}
   LANGUAGES CXX)
 
-set(MBTOOLS_CLIENT_APP_NAME client)
+set(MBTOOLS_CLIENT_APP_NAME client CACHE INTERNAL "Name of the ModbusTools client application")
 
 message("MBTOOLS: Start configure client '${MBTOOLS_CLIENT_APP_NAME}'")