Merge pull request #11 from NikolasK-source/main

Release 1.1.1

Author: NikolasK-source

CMakeLists.txt

@@ -4,7 +4,7 @@ cmake_minimum_required(VERSION 3.13.4 FATAL_ERROR)
 # ======================================================================================================================
 
 # project
-project(stdin-to-modbus-shm LANGUAGES CXX VERSION 1.1.0)
+project(stdin-to-modbus-shm LANGUAGES CXX VERSION 1.1.1)
 
 # settings
 set(Target "stdin-to-modbus-shm") # Executable name (without file extension!)

README.md

@@ -16,21 +16,35 @@ As an alternative to the ```git submodule``` commands, the ```--recursive``` opt
 
 ## Use
 ```
-stdin_to_modbus_shm [OPTION...]
+stdin-to-modbus-shm [OPTION...]
 
   -n, --name-prefix arg   name prefix of the shared memory objects (default: modbus_)
       --address-base arg  Numerical base (radix) that is used for the addresses (see 
                           https://en.cppreference.com/w/cpp/string/basic_string/stoul) (default: 0)
       --value-base arg    Numerical base (radix) that is used for the values (see 
                           https://en.cppreference.com/w/cpp/string/basic_string/stoul) (default: 0)
+  -p, --passthrough       write passthrough all executed commands to stdout
+      --bash              passthrough as bash script. No effect i '--passthrough' is not set
+      --valid-hist        add only valid commands to command history
   -h, --help              print usage
-
-
-Data input format: reg_type:address:value
-    reg_type: modbus register type:                         [do|di|ao|ai]
-    address : address of the target register:               [0-65535]
-    value   : value that is written to the target register: [0-65535]
-              For the registers do and di all numerical values different from 0 are interpreted as 1.
+  -v, --verbose           print what is written to the registers
+      --version           print version information
+      --license           show licenses
+      --data-types        show list of supported data type identifiers
+      --constants         list string constants that can be used as value
+
+
+Data input format: reg_type:address:value[:data_type]
+    reg_type : modbus register type:           [do|di|ao|ai]
+    address  : address of the target register: [0-65535]
+               The actual maximum register depends on the size of the modbus shared memory.
+    value    : value that is written to the target register
+               Some string constants are available. The input format depends on the type of register and data type.
+               Type 'help constants' for more details 
+               For the registers do and di all numerical values different from 0 are interpreted as 1.
+    data_type: an optional data type specifier
+               If no data type is specified, exactly one register is written in host byte order.
+               Type 'help types' to get a list of supported data type identifiers.
 ```
 
 ## Libraries

docs/index.md

@@ -123,17 +123,22 @@ The following data types are possible:
       - u64_badcfehg, u64_little_rev, **u64lr**  
         64-Bit unsigned integer, little endian, reversed register order
 
-**Note:  
-The endianness refers to the layout of the data in the shared memory and may differ from the Modbus master's 
-definition of the endianness.**
+> **Note**:  
+The endianness refers to the layout of the data in the shared memory and may differ from the Modbus Server's 
+definition of the endianness.
 
 ### Command Passthrough
 By using the option ```--passthrough```, all valid inputs are written to stdout.
 By additionally enabling the option ```--bash```, the output is created as a bash script that reproduces the inputs
 (including the timing).
 
+## 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/stdin_to_modbus_shm/releases):
 
@@ -150,7 +155,7 @@ To enable calling with ```stdin-to-modbus-shm``` [this script](https://gist.gith
 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

src/main.cpp

@@ -248,7 +248,7 @@ int main(int argc, char **argv) {
                   << std::endl;
         std::cout << std::endl;
         std::cout << "Note: The endianness refers to the layout of the data in the shared memory and may differ from "
-                     "the Modbus master's"
+                     "the definition of the Modbus Server"
                   << std::endl;
         std::cout << "      definition of the endianness." << std::endl;
     };