modpoll 0.7.0__tar.gz → 0.7.1__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: modpoll
-Version: 0.7.0
+Version: 0.7.1
 Summary: A New Command Line Tool for Modbus
 Home-page: https://helloysd.gitlab.io/modpoll
 License: MIT
@@ -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">
@@ -187,17 +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
@@ -207,9 +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 \
-        --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,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,
 
@@ -257,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 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 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 -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -276,34 +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 \
-          --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.1}/README.md

@@ -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">
@@ -164,17 +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
@@ -184,9 +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 \
-        --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,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,
 
@@ -234,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 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 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 -v $(pwd)/examples:/app/examples helloysd/modpoll \
+    modpoll -d \
+      --tcp modsim.topmaker.net \
+      --config /app/examples/modsim.csv
   ```
 
 
@@ -253,34 +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 \
-          --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.1}/pyproject.toml

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