modpoll 0.7.0__tar.gz → 0.7.2__tar.gz

{modpoll-0.7.0 → modpoll-0.7.2}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: modpoll
-Version: 0.7.0
-Summary: A New Command Line Tool for Modbus
+Version: 0.7.2
+Summary: A New Command-line Tool for Modbus and MQTT
 Home-page: https://helloysd.gitlab.io/modpoll
 License: MIT
 Author: Ying Shaodong
@@ -21,7 +21,7 @@ Requires-Dist: requests (>=2.28.1,<3.0.0)
 Project-URL: Repository, https://github.com/gavinying/modpoll
 Description-Content-Type: text/markdown
 
-# modpoll - A New Command-line Tool for Modbus
+# modpoll - A New Command-line Tool for Modbus and MQTT
 
 [![pipeline status](https://gitlab.com/helloysd/modpoll/badges/master/pipeline.svg)](https://gitlab.com/helloysd/modpoll/-/commits/master)
 [![License](https://img.shields.io/pypi/l/modpoll)](https://gitlab.com/helloysd/modpoll/-/blob/master/LICENSE)
@@ -107,8 +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">
@@ -181,23 +182,30 @@ The configuration can be either a local file or a remote public URL resource.
 If you are blocked by company firewall for online device or prefer a local test, you can launch your own device simulator by running *modsim* locally,
 
 ```bash
-docker run -p 5020:5020 helloysd/modsim
+docker run --rm -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,
+It will create a virtual Modbus TCP device running at `localhost:5020`, and you can open a new terminal, poll the virtual device 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
+sudo docker run --rm -p 502:5020 helloysd/modsim
+```
+
+In a new terminal,
+
+```
+modpoll \
+  --tcp localhost \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 ### Publish data to MQTT broker
@@ -207,9 +215,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 \
-        --mqtt-host mqtt.eclipseprojects.io \
-        --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+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.
@@ -247,27 +256,33 @@ 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,
 
   ```bash
-  docker run helloysd/modpoll
+  docker run --rm helloysd/modpoll
   ```
 
 It shows the version of the program by default.
 
-Similar to the above *modsim* test, we can poll data 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 -d --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  docker run --rm 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 -d --tcp modsim.topmaker.net --config /app/examples/modsim.csv
+  docker run --rm -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -276,34 +291,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 \
-          --mqtt-host mqtt.eclipseprojects.io \
-          --config examples/modsim.csv
+  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 \
-          --export data.csv \
-          --config examples/modsim.csv
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --export data.csv \
+    --config examples/modsim.csv
   ```
 
 

{modpoll-0.7.0 → modpoll-0.7.2}/README.md

@@ -1,4 +1,4 @@
-# modpoll - A New Command-line Tool for Modbus
+# modpoll - A New Command-line Tool for Modbus and MQTT
 
 [![pipeline status](https://gitlab.com/helloysd/modpoll/badges/master/pipeline.svg)](https://gitlab.com/helloysd/modpoll/-/commits/master)
 [![License](https://img.shields.io/pypi/l/modpoll)](https://gitlab.com/helloysd/modpoll/-/blob/master/LICENSE)
@@ -84,8 +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">
@@ -158,23 +159,30 @@ The configuration can be either a local file or a remote public URL resource.
 If you are blocked by company firewall for online device or prefer a local test, you can launch your own device simulator by running *modsim* locally,
 
 ```bash
-docker run -p 5020:5020 helloysd/modsim
+docker run --rm -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,
+It will create a virtual Modbus TCP device running at `localhost:5020`, and you can open a new terminal, poll the virtual device 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
+sudo docker run --rm -p 502:5020 helloysd/modsim
+```
+
+In a new terminal,
+
+```
+modpoll \
+  --tcp localhost \
+  --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
 ```
 
 ### Publish data to MQTT broker
@@ -184,9 +192,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 \
-        --mqtt-host mqtt.eclipseprojects.io \
-        --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+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.
@@ -224,27 +233,33 @@ 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,
 
   ```bash
-  docker run helloysd/modpoll
+  docker run --rm helloysd/modpoll
   ```
 
 It shows the version of the program by default.
 
-Similar to the above *modsim* test, we can poll data 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 -d --tcp modsim.topmaker.net --config https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv
+  docker run --rm 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 -d --tcp modsim.topmaker.net --config /app/examples/modsim.csv
+  docker run --rm -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -253,34 +268,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 \
-          --mqtt-host mqtt.eclipseprojects.io \
-          --config examples/modsim.csv
+  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 \
-          --export data.csv \
-          --config examples/modsim.csv
+  modpoll \
+    --tcp modsim.topmaker.net \
+    --tcp-port 5020 \
+    --export data.csv \
+    --config examples/modsim.csv
   ```
 
 

{modpoll-0.7.0 → modpoll-0.7.2}/modpoll/arg_parser.py

@@ -5,7 +5,7 @@ from . import __version__
 
 def get_parser():
     parser = argparse.ArgumentParser(
-        description=f"modpoll v{__version__} - A New Command Line Tool for Modbus"
+        description=f"modpoll v{__version__} - A New Command-line Tool for Modbus and MQTT"
     )
     parser.add_argument(
         "-v",

{modpoll-0.7.0 → modpoll-0.7.2}/modpoll/main.py

@@ -37,7 +37,7 @@ def get_utc_time():
 
 
 def app(name="modpoll"):
-    print("\nmodpoll - A New Command Line Tool for Modbus\n", flush=True)
+    print("\nmodpoll - A New Command-line Tool for Modbus and MQTT\n", flush=True)
 
     signal.signal(signal.SIGINT, _signal_handler)
 

{modpoll-0.7.0 → modpoll-0.7.2}/modpoll/modbus_task.py

@@ -155,6 +155,9 @@ class Poller:
                 elif "int64" == ref.dtype:
                     ref.update_value(decoder.decode_64bit_int())
                     cur_ref += ref.ref_width
+                elif "float16" == ref.dtype:
+                    ref.update_value(decoder.decode_16bit_float())
+                    cur_ref += ref.ref_width
                 elif "float32" == ref.dtype:
                     ref.update_value(decoder.decode_32bit_float())
                     cur_ref += ref.ref_width
@@ -231,6 +234,8 @@ class Reference:
             self.ref_width = 4
         elif "uint64" == dtype:
             self.ref_width = 4
+        elif "float16" == dtype:
+            self.ref_width = 1
         elif "float32" == dtype:
             self.ref_width = 2
         elif "float64" == dtype:

{modpoll-0.7.0 → modpoll-0.7.2}/modpoll/mqtt_task.py

@@ -26,7 +26,8 @@ def _on_connect(client, userdata, flags, rc, properties=None):
         log.info("Connection successful")
         # Subscribing in on_connect() means that if we lose the connection and
         # reconnect then subscriptions will be renewed.
-        client.subscribe(f"{args.mqtt_topic_prefix}+/set")
+        qos = userdata.get("qos", 0)  # Default to QoS 0 if not provided
+        client.subscribe(f"{args.mqtt_topic_prefix}+/set", qos)
     elif rc == 1:
         log.warning("Connection refused - incorrect protocol version")
     elif rc == 2:
@@ -83,7 +84,11 @@ def mqttc_setup(config):
         else:
             clientid = args.mqtt_clientid
         global mqttc
-        mqttc = mqtt.Client(clientid, clean_session=(args.mqtt_qos == 0))
+        mqttc = mqtt.Client(
+            clientid,
+            clean_session=(args.mqtt_qos == 0),
+            userdata={"qos": args.mqtt_qos},
+        )
         if args.mqtt_use_tls:
             if args.mqtt_tls_version == "tlsv1.2":
                 tlsVersion = ssl.PROTOCOL_TLSv1_2

{modpoll-0.7.0 → modpoll-0.7.2}/pyproject.toml

@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "modpoll"
-version = "0.7.0"
-description = "A New Command Line Tool for Modbus"
+version = "0.7.2"
+description = "A New Command-line Tool for Modbus and MQTT"
 authors = ["Ying Shaodong <helloysd@gmail.com>"]
 readme = "README.md"
 homepage = "https://helloysd.gitlab.io/modpoll"