modpoll 0.6.4__tar.gz → 0.7.1__tar.gz

{modpoll-0.6.4 → modpoll-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modpoll
-Version: 0.6.4
+Version: 0.7.1
 Summary: A New Command Line Tool for Modbus
 Home-page: https://helloysd.gitlab.io/modpoll
 License: MIT
@@ -75,7 +75,7 @@ pip install modpoll
 Optionally, pyserial library can be installed for Modbus-RTU communication,
 
 ```bash
-pip install modpoll[serial]
+pip install 'modpoll[serial]'
 ```
 
 Upgrade the tool via the following command,
@@ -107,7 +107,9 @@ pipx upgrade modpoll
 Let's start exploring *modpoll* with *modsim* device, run the following command to get a first glimpse,
 
 ```bash
-modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp modsim.topmaker.net \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 <p align="center">
@@ -186,14 +188,19 @@ docker run -p 5020:5020 helloysd/modsim
 It will create a virtual Modbus TCP device running at `localhost:5020`, and then you can poll it using *modpoll* tool,
 
 ```bash
-modpoll --tcp localhost --tcp-port 5020 --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp localhost \
+  --tcp-port 5020 \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 > Use `sudo` before the docker command if you want to use the standard port `502`.
 
 ```bash
 sudo docker run -p 502:5020 helloysd/modsim
-modpoll --tcp localhost --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp localhost \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 ### Publish data to MQTT broker
@@ -203,7 +210,10 @@ This is a useful function of this new *modpoll* tool, which provides a simple wa
 The following example uses a public MQTT broker `mqtt.eclipseprojects.io` for test purpose. You can also set up your own MQTT broker locally using [mosquitto](https://mosquitto.org/download/).
 
 ```bash
-modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv --mqtt-host mqtt.eclipseprojects.io
+modpoll \
+  --tcp modsim.topmaker.net \
+  --mqtt-host mqtt.eclipseprojects.io \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 With successful data polling and publishing, you can subscribe the topic `modpoll/modsim` on the same MQTT broker `mqtt.eclipseprojects.io` to view the collected data.
@@ -241,7 +251,7 @@ The *modpoll* tool will subscribe to the topic `<mqtt_topic_prefix>/<deviceid>/s
   ```
 
 
-## Run in docker
+## Run with docker
 
 A docker image has been provided for user to directly run the program without local installation,
 
@@ -251,17 +261,23 @@ A docker image has been provided for user to directly run the program without lo
 
 It shows the version of the program by default.
 
-Similar to the above *modsim* test, we can poll the first 5 holding registers with `docker run`,
+Similar to the above *modsim* test, we can poll data with `docker run`, in order to avoid printing out received data, the argument `--daemon` or `-d` is recommended to use with docker.
 
   ```bash
-  docker run helloysd/modpoll modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  docker run helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
   ```
 
 If you want to load a local configure file, you need to mount a local folder onto container volume,
 for example, if the child folder `examples` contains the config file `modsim.csv`, we can use it via the following command,
 
   ```bash
-  docker run -v $(pwd)/examples:/app/examples helloysd/modpoll modpoll --tcp modsim.topmaker.net --config /app/examples/modsim.csv
+  docker run -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -270,25 +286,38 @@ for example, if the child folder `examples` contains the config file `modsim.csv
 - Connect to Modbus TCP device
 
   ```bash
-  modpoll --tcp 192.168.1.10 --config examples/modsim.csv
+  modpoll \
+    --tcp 192.168.1.10 \
+    --config examples/modsim.csv
   ```
 
 - Connect to Modbus RTU device
 
   ```bash
-  modpoll --rtu /dev/ttyUSB0 --rtu-baud 9600 --config contrib/eniwise/scpms6.csv
+  modpoll \
+    --rtu /dev/ttyUSB0 \
+    --rtu-baud 9600 \
+    --config contrib/eniwise/scpms6.csv
   ```
 
 - Connect to Modbus TCP device and publish data to MQTT broker
 
   ```bash
-  modpoll --tcp modsim.topmaker.net --tcp-port 5020 --config examples/modsim.csv --mqtt-host mqtt.eclipseprojects.io
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --mqtt-host mqtt.eclipseprojects.io \
+    --config examples/modsim.csv
   ```
 
 - Connect to Modbus TCP device and export data to local csv file
 
   ```bash
-  modpoll --tcp modsim.topmaker.net --tcp-port 5020 --config examples/modsim.csv --export data.csv
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --export data.csv \
+    --config examples/modsim.csv
   ```
 
 

{modpoll-0.6.4 → modpoll-0.7.1}/README.md

@@ -52,7 +52,7 @@ pip install modpoll
 Optionally, pyserial library can be installed for Modbus-RTU communication,
 
 ```bash
-pip install modpoll[serial]
+pip install 'modpoll[serial]'
 ```
 
 Upgrade the tool via the following command,
@@ -84,7 +84,9 @@ pipx upgrade modpoll
 Let's start exploring *modpoll* with *modsim* device, run the following command to get a first glimpse,
 
 ```bash
-modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp modsim.topmaker.net \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 <p align="center">
@@ -163,14 +165,19 @@ docker run -p 5020:5020 helloysd/modsim
 It will create a virtual Modbus TCP device running at `localhost:5020`, and then you can poll it using *modpoll* tool,
 
 ```bash
-modpoll --tcp localhost --tcp-port 5020 --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp localhost \
+  --tcp-port 5020 \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 > Use `sudo` before the docker command if you want to use the standard port `502`.
 
 ```bash
 sudo docker run -p 502:5020 helloysd/modsim
-modpoll --tcp localhost --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+modpoll \
+  --tcp localhost \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 ### Publish data to MQTT broker
@@ -180,7 +187,10 @@ This is a useful function of this new *modpoll* tool, which provides a simple wa
 The following example uses a public MQTT broker `mqtt.eclipseprojects.io` for test purpose. You can also set up your own MQTT broker locally using [mosquitto](https://mosquitto.org/download/).
 
 ```bash
-modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv --mqtt-host mqtt.eclipseprojects.io
+modpoll \
+  --tcp modsim.topmaker.net \
+  --mqtt-host mqtt.eclipseprojects.io \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 With successful data polling and publishing, you can subscribe the topic `modpoll/modsim` on the same MQTT broker `mqtt.eclipseprojects.io` to view the collected data.
@@ -218,7 +228,7 @@ The *modpoll* tool will subscribe to the topic `<mqtt_topic_prefix>/<deviceid>/s
   ```
 
 
-## Run in docker
+## Run with docker
 
 A docker image has been provided for user to directly run the program without local installation,
 
@@ -228,17 +238,23 @@ A docker image has been provided for user to directly run the program without lo
 
 It shows the version of the program by default.
 
-Similar to the above *modsim* test, we can poll the first 5 holding registers with `docker run`,
+Similar to the above *modsim* test, we can poll data with `docker run`, in order to avoid printing out received data, the argument `--daemon` or `-d` is recommended to use with docker.
 
   ```bash
-  docker run helloysd/modpoll modpoll --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  docker run helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
   ```
 
 If you want to load a local configure file, you need to mount a local folder onto container volume,
 for example, if the child folder `examples` contains the config file `modsim.csv`, we can use it via the following command,
 
   ```bash
-  docker run -v $(pwd)/examples:/app/examples helloysd/modpoll modpoll --tcp modsim.topmaker.net --config /app/examples/modsim.csv
+  docker run -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -247,25 +263,38 @@ for example, if the child folder `examples` contains the config file `modsim.csv
 - Connect to Modbus TCP device
 
   ```bash
-  modpoll --tcp 192.168.1.10 --config examples/modsim.csv
+  modpoll \
+    --tcp 192.168.1.10 \
+    --config examples/modsim.csv
   ```
 
 - Connect to Modbus RTU device
 
   ```bash
-  modpoll --rtu /dev/ttyUSB0 --rtu-baud 9600 --config contrib/eniwise/scpms6.csv
+  modpoll \
+    --rtu /dev/ttyUSB0 \
+    --rtu-baud 9600 \
+    --config contrib/eniwise/scpms6.csv
   ```
 
 - Connect to Modbus TCP device and publish data to MQTT broker
 
   ```bash
-  modpoll --tcp modsim.topmaker.net --tcp-port 5020 --config examples/modsim.csv --mqtt-host mqtt.eclipseprojects.io
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --mqtt-host mqtt.eclipseprojects.io \
+    --config examples/modsim.csv
   ```
 
 - Connect to Modbus TCP device and export data to local csv file
 
   ```bash
-  modpoll --tcp modsim.topmaker.net --tcp-port 5020 --config examples/modsim.csv --export data.csv
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --export data.csv \
+    --config examples/modsim.csv
   ```
 
 

{modpoll-0.6.4 → modpoll-0.7.1}/modpoll/arg_parser.py

@@ -8,7 +8,10 @@ def get_parser():
         description=f"modpoll v{__version__} - A New Command Line Tool for Modbus"
     )
     parser.add_argument(
-        "-v", "--version", action="version", version=f"modpoll v{__version__}"
+        "-v",
+        "--version",
+        action="version",
+        version=f"modpoll v{__version__}",
     )
     parser.add_argument(
         "-f",
@@ -16,51 +19,57 @@ def get_parser():
         required=True,
         help="A local path or URL of Modbus configuration file. Required!",
     )
+    parser.add_argument(
+        "-d",
+        "--daemon",
+        action="store_true",
+        help="Run in daemon mode without printing result. Recommended to use with docker",
+    )
     parser.add_argument(
         "-r",
         "--rate",
-        default=5.0,
         type=float,
-        help="The sampling rate (s) to poll modbus device, Defaults to 5.0",
+        default=10.0,
+        help="The sampling rate (s) to poll modbus device, Defaults to 10.0",
     )
     parser.add_argument(
         "-1", "--once", action="store_true", help="Only run polling at one time"
     )
     parser.add_argument(
         "--interval",
-        default=1.0,
         type=float,
+        default=1.0,
         help="The time interval in seconds between two polling, Defaults to 1.0",
     )
     parser.add_argument(
         "--tcp", help="Act as a Modbus TCP master, connecting to host TCP"
     )
     parser.add_argument(
-        "--tcp-port", default=502, type=int, help="Port for MODBUS TCP. Defaults to 502"
+        "--tcp-port", type=int, default=502, help="Port for MODBUS TCP. Defaults to 502"
     )
     parser.add_argument(
         "--udp", help="Act as a Modbus UDP master, connecting to host UDP"
     )
     parser.add_argument(
-        "--udp-port", default=502, type=int, help="Port for MODBUS UDP. Defaults to 502"
+        "--udp-port", type=int, default=502, help="Port for MODBUS UDP. Defaults to 502"
     )
     parser.add_argument("--rtu", help="pyserial URL (or port name) for RTU serial port")
     parser.add_argument(
         "--rtu-baud",
-        default=9600,
         type=int,
+        default=9600,
         help="Baud rate for serial port. Defaults to 9600",
     )
     parser.add_argument(
         "--rtu-parity",
-        default="none",
         choices=["none", "odd", "even"],
+        default="none",
         help="Parity for serial port. Defaults to none",
     )
     parser.add_argument(
         "--timeout",
-        default=3.0,
         type=float,
+        default=3.0,
         help="Response time-out seconds for MODBUS devices, Defaults to 3.0",
     )
     parser.add_argument(
@@ -69,9 +78,6 @@ def get_parser():
         default=None,
         help="The file name to export references/registers",
     )
-    parser.add_argument(
-        "-p", "--print-result", action="store_true", help="Print received data."
-    )
     parser.add_argument(
         "--mqtt-host",
         default=None,
@@ -79,8 +85,8 @@ def get_parser():
     )
     parser.add_argument(
         "--mqtt-port",
-        default=1883,
         type=int,
+        default=1883,
         help="1883 for non-TLS or 8883 for TLS, Defaults to 1883",
     )
     parser.add_argument(
@@ -95,9 +101,8 @@ def get_parser():
     )
     parser.add_argument(
         "--mqtt-qos",
-        default=0,
-        type=int,
         choices=[0, 1, 2],
+        default=0,
         help="MQTT QoS value. Defaults to 0",
     )
     parser.add_argument(
@@ -115,8 +120,8 @@ def get_parser():
     parser.add_argument("--mqtt-cacerts", default=None, help="Path to ca keychain")
     parser.add_argument(
         "--mqtt-tls-version",
-        default=None,
         choices=["tlsv1.2", "tlsv1.1", "tlsv1"],
+        default="tlsv1.2",
         help="TLS protocol version, can be one of tlsv1.2 tlsv1.1 or tlsv1",
     )
     parser.add_argument(
@@ -126,8 +131,8 @@ def get_parser():
     )
     parser.add_argument(
         "--diagnostics-rate",
-        default=0,
         type=float,
+        default=0,
         help="Time in seconds as publishing period for each device diagnostics",
     )
     parser.add_argument(
@@ -137,8 +142,8 @@ def get_parser():
     )
     parser.add_argument(
         "--loglevel",
-        default="INFO",
         choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="INFO",
         help="Set log level, Defaults to INFO",
     )
     parser.add_argument(
@@ -146,8 +151,14 @@ def get_parser():
     )
     parser.add_argument(
         "--delay",
-        default=0,
         type=int,
+        default=0,
         help="Time to delay sending first request in seconds after connecting. Default to 0",
     )
+    parser.add_argument(
+        "--framer",
+        default="default",
+        choices=["default", "ascii", "binary", "rtu", "socket"],
+        help="The type of framer for modbus message. Use default framer if not specified.",
+    )
     return parser

{modpoll-0.6.4 → modpoll-0.7.1}/modpoll/modbus_task.py

@@ -418,24 +418,39 @@ def modbus_setup(config, event):
             parity = "E"
         else:
             parity = "N"
-        master = ModbusSerialClient(
-            method="rtu",
-            port=args.rtu,
-            stopbits=1,
-            bytesize=8,
-            parity=parity,
-            baudrate=int(args.rtu_baud),
-            timeout=args.timeout,
-            reset_socket=True,
-        )
+        if args.framer == "default":
+            master = ModbusSerialClient(
+                args.rtu,
+                baudrate=int(args.rtu_baud),
+                bytesize=8,
+                parity=parity,
+                stopbits=1,
+                timeout=args.timeout,
+            )
+        else:
+            master = ModbusSerialClient(
+                args.rtu,
+                baudrate=int(args.rtu_baud),
+                bytesize=8,
+                parity=parity,
+                stopbits=1,
+                framer=args.framer,
+                timeout=args.timeout,
+            )
     elif args.tcp:
-        master = ModbusTcpClient(
-            args.tcp, args.tcp_port, timeout=args.timeout, reset_socket=True
-        )
+        if args.framer == "default":
+            master = ModbusTcpClient(args.tcp, port=args.tcp_port, timeout=args.timeout)
+        else:
+            master = ModbusTcpClient(
+                args.tcp, port=args.tcp_port, framer=args.framer, timeout=args.timeout
+            )
     elif args.udp:
-        master = ModbusUdpClient(
-            args.udp, args.udp_port, timeout=args.timeout, reset_socket=True
-        )
+        if args.framer == "default":
+            master = ModbusUdpClient(args.udp, port=args.udp_port, timeout=args.timeout)
+        else:
+            master = ModbusUdpClient(
+                args.udp, port=args.udp_port, framer=args.framer, timeout=args.timeout
+            )
     else:
         log.error(
             "You must specify a modbus access method, either --rtu, --tcp or --udp"
@@ -460,8 +475,8 @@ def modbus_poll():
                     return
                 event_exit.wait(timeout=args.interval)
     master.close()
-    # printout result, if -p or --print-result are set
-    if args.print_result:
+    # print out result, if not in daemon mode
+    if not args.daemon:
         modbus_print()
 
 

{modpoll-0.6.4 → modpoll-0.7.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "modpoll"
-version = "0.6.4"
+version = "0.7.1"
 description = "A New Command Line Tool for Modbus"
 authors = ["Ying Shaodong <helloysd@gmail.com>"]
 readme = "README.md"