automatic import of python-modpoll

3 files changed, 913 insertions, 0 deletions

diff --git a/.gitignore b/.gitignore
index e69de29..356b3b6 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/modpoll-0.5.3.tar.gz
diff --git a/python-modpoll.spec b/python-modpoll.spec
new file mode 100644
index 0000000..1d8b8a9
--- /dev/null
+++ b/python-modpoll.spec
@@ -0,0 +1,911 @@
+%global _empty_manifest_terminate_build 0
+Name:		python-modpoll
+Version:	0.5.3
+Release:	1
+Summary:	A New Command Line Tool for Modbus
+License:	MIT
+URL:		https://helloysd.gitlab.io/modpoll
+Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/50/0f/4de240b8086cece2c99585b96a5169224bf8ae109e08c10cd759614e5e3f/modpoll-0.5.3.tar.gz
+BuildArch:	noarch
+
+Requires:	python3-importlib-metadata
+Requires:	python3-pymodbus
+Requires:	python3-paho-mqtt
+Requires:	python3-prettytable
+Requires:	python3-requests
+
+%description
+# modpoll - A New Command Line Tool for Modbus
+
+[![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)
+[![Downloads](http://pepy.tech/badge/modpoll)](http://pepy.tech/project/modpoll)
+
+> Learn more about *modpoll* usage at [documentation](https://helloysd.gitlab.io/modpoll) site. 
+
+
+
+## Motivation
+
+The initial idea of creating this tool is to help myself debugging new devices during site survey. A site survey usually has limited time and space, working on-site also piles up some pressures. At that time, a portable swiss-knife toolkit is our best friend.
+
+This program can be easily deployed to Raspberry Pi or similar embedded devices, polling data from modbus devices, users can choose to log data locally or publish to a MQTT broker for further debugging. 
+
+The MQTT broker can be setup on the same Raspberry Pi or on the cloud. Once data successfully published, users can subscribe to a specific MQTT topic to view the data via a smart phone at your fingertip. 
+
+
+
+<p align="center">
+  <img src="docs/assets/modpoll-usage.png">
+</p>
+
+
+
+Moreover, you can also run this program continuously on a server as a Modbus-MQTT gateway, i.e. polling from local Modbus devices and forwarding data to a centralized cloud service. 
+
+In fact, *modpoll* helps to bridge between the traditional fieldbus world and the new IoT world. 
+
+
+> This program is designed to be a standalone tool, it works out-of-the-box on Linux/macOS/Windows. 
+
+> If you are looing for a modbus python library, please consider the following great open source projects, [pymodbus](https://github.com/riptideio/pymodbus) or [minimalmodbus](https://github.com/pyhys/minimalmodbus)
+
+
+
+## Feature
+
+- Support Modbus RTU/TCP/UDP devices
+- Show polling data for local debugging, like a typical modpoll tool
+- Publish polling data to MQTT broker for remote debugging, especially on smart phone
+- Export polling data to local storage for further investigation
+- Provide docker solution for continuous data polling use case
+
+
+
+## Installation
+
+This program tested on python 3.8+, the package is available in the Python Package Index, users can easily install it using `pip` or `pipx`.
+
+### Using PIP
+
+Python3 is supported by most popular platforms, e.g. Linux/macOS/Windows, on which you can install *modpoll* using `pip` tool, 
+
+```bash
+pip install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```bash
+pip install -U modpoll
+```
+
+### On Windows
+
+It is recommended to use `pipx` for installing *modpoll* on Windows, refer to [here](https://pypa.github.io/pipx/installation/) for more information about `pipx`. 
+
+Once `pipx` installed, you can run the following command in a Command Prompt termial. 
+
+```PowerShell
+pipx install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```PowerShell
+pipx upgrade modpoll
+```
+
+
+## Quickstart
+
+As the name tells, *modpoll* is a tool for communicating with Modbus devices, so ideally it makes more sense if you have a real Modbus device on hand for the following test, but it is OK if you don't, we provide a virtual Modbus TCP device deployed at `modsim.topmaker.net:502` for your quick testing purpose. 
+
+Let's start expoloring *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
+```
+
+<p align="center">
+  <img src="docs/assets/screenshot-modpoll.png">
+</p>
+
+
+> the modsim code is also available [here](https://github.com/gavinying/modsim)
+
+
+### Prepare Modbus configure file
+
+The reason we can magically poll data from the online device *modsim* is because we have already provided the [Modbus configure file](https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv) for *modsim* device as following, 
+
+```CSV
+device,modsim001,1,,
+poll,holding_register,40000,20,BE_BE
+ref,value1,40000,uint16,rw
+ref,value2,40001,uint16,rw
+ref,value3,40002,uint16,rw
+ref,value4,40003,uint16,rw
+ref,value5,40004,int16,rw
+ref,value6,40005,int16,rw
+ref,value7,40006,int16,rw
+ref,value8,40007,int16,rw
+ref,value9,40008,uint32,rw
+ref,value10,40010,uint32,rw
+ref,value11,40012,int32,rw
+ref,value12,40014,int32,rw
+ref,value13,40016,float32,rw
+ref,value14,40018,float32,rw
+poll,coil,0,24,BE_BE
+ref,coil1-8,0,bool,rw
+ref,coil9-16,8,bool,rw
+```
+
+This configuration tells *modpoll* to do the following for each poll,
+
+- Read `20` holding registers (register address: `40000-40019`) and parse data accordingly; 
+- Read `24` coils (coil address: `0-23`) and parse data accordingly; 
+
+
+Normally, you need to customize a Modbus configuration file for your own device before running *modpoll* tool, which defines the optimal polling patterns and register mappings according to device vendor's documents. 
+
+The configuration can be either a local file or a remote public URL resource. 
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll/configure.html) site for more details.*
+
+### Poll local device (modsim)
+
+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
+```
+
+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
+```
+
+> 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
+```
+
+
+### Publish data to MQTT broker
+
+This is a useful function of this new *modpoll* tool, which provides a simple way to publish collected modbus data to MQTT broker, so users can view data from a smart phone via a MQTT client. 
+
+The following example uses a public MQTT broker `mqtt.eclipseprojects.io` for test purpose. You can also setup 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
+```
+
+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. 
+
+> The MQTT topic uses `<mqtt_topic_prefix>/<deviceid>` pattern, <mqtt_topic_prefix> is provided by `--mqtt-topic-prefix` argument, the default value is `modpoll/`  and <deviceid> is provided by the Modbus configure file. 
+
+
+
+<p align="center">
+  <img src="docs/assets/screencast-modpoll-mqtt.gif">
+</p>
+
+
+
+### Write registers via MQTT publish
+
+The *modpoll* tool will subscribe to the topic `<mqtt_topic_prefix>/<deviceid>/set` once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish, 
+
+- To write a single holding register (address at `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": 12
+  }
+  ```
+
+- To write multiple holding registers (address starting from `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": [12, 13, 14, 15]
+  }
+  ```
+
+
+
+## Run in docker
+
+A docker image has been provided for user to directly run the program without local installation, 
+
+  ```bash
+  docker run helloysd/modpoll
+  ```
+
+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`,
+
+  ```bash
+  docker run helloysd/modpoll modpoll --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
+  ```
+
+
+
+## Basic Usage
+
+- Connect to Modbus TCP device
+
+  ```bash
+  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
+  ```
+
+- 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
+  ```
+
+- 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
+  ```
+
+
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll) site for more details about the configuration and examples.*
+
+
+
+## Credits
+
+The implementation of this project is heavily inspired by the following two projects:
+- https://github.com/owagner/modbus2mqtt (MIT license)
+- https://github.com/mbs38/spicierModbus2mqtt (MIT license)
+
+Thanks to Max Brueggemann and Oliver Wagner for their great work. 
+
+
+
+## License
+
+MIT © [helloysd](helloysd@foxmail.com)
+
+
+%package -n python3-modpoll
+Summary:	A New Command Line Tool for Modbus
+Provides:	python-modpoll
+BuildRequires:	python3-devel
+BuildRequires:	python3-setuptools
+BuildRequires:	python3-pip
+%description -n python3-modpoll
+# modpoll - A New Command Line Tool for Modbus
+
+[![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)
+[![Downloads](http://pepy.tech/badge/modpoll)](http://pepy.tech/project/modpoll)
+
+> Learn more about *modpoll* usage at [documentation](https://helloysd.gitlab.io/modpoll) site. 
+
+
+
+## Motivation
+
+The initial idea of creating this tool is to help myself debugging new devices during site survey. A site survey usually has limited time and space, working on-site also piles up some pressures. At that time, a portable swiss-knife toolkit is our best friend.
+
+This program can be easily deployed to Raspberry Pi or similar embedded devices, polling data from modbus devices, users can choose to log data locally or publish to a MQTT broker for further debugging. 
+
+The MQTT broker can be setup on the same Raspberry Pi or on the cloud. Once data successfully published, users can subscribe to a specific MQTT topic to view the data via a smart phone at your fingertip. 
+
+
+
+<p align="center">
+  <img src="docs/assets/modpoll-usage.png">
+</p>
+
+
+
+Moreover, you can also run this program continuously on a server as a Modbus-MQTT gateway, i.e. polling from local Modbus devices and forwarding data to a centralized cloud service. 
+
+In fact, *modpoll* helps to bridge between the traditional fieldbus world and the new IoT world. 
+
+
+> This program is designed to be a standalone tool, it works out-of-the-box on Linux/macOS/Windows. 
+
+> If you are looing for a modbus python library, please consider the following great open source projects, [pymodbus](https://github.com/riptideio/pymodbus) or [minimalmodbus](https://github.com/pyhys/minimalmodbus)
+
+
+
+## Feature
+
+- Support Modbus RTU/TCP/UDP devices
+- Show polling data for local debugging, like a typical modpoll tool
+- Publish polling data to MQTT broker for remote debugging, especially on smart phone
+- Export polling data to local storage for further investigation
+- Provide docker solution for continuous data polling use case
+
+
+
+## Installation
+
+This program tested on python 3.8+, the package is available in the Python Package Index, users can easily install it using `pip` or `pipx`.
+
+### Using PIP
+
+Python3 is supported by most popular platforms, e.g. Linux/macOS/Windows, on which you can install *modpoll* using `pip` tool, 
+
+```bash
+pip install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```bash
+pip install -U modpoll
+```
+
+### On Windows
+
+It is recommended to use `pipx` for installing *modpoll* on Windows, refer to [here](https://pypa.github.io/pipx/installation/) for more information about `pipx`. 
+
+Once `pipx` installed, you can run the following command in a Command Prompt termial. 
+
+```PowerShell
+pipx install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```PowerShell
+pipx upgrade modpoll
+```
+
+
+## Quickstart
+
+As the name tells, *modpoll* is a tool for communicating with Modbus devices, so ideally it makes more sense if you have a real Modbus device on hand for the following test, but it is OK if you don't, we provide a virtual Modbus TCP device deployed at `modsim.topmaker.net:502` for your quick testing purpose. 
+
+Let's start expoloring *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
+```
+
+<p align="center">
+  <img src="docs/assets/screenshot-modpoll.png">
+</p>
+
+
+> the modsim code is also available [here](https://github.com/gavinying/modsim)
+
+
+### Prepare Modbus configure file
+
+The reason we can magically poll data from the online device *modsim* is because we have already provided the [Modbus configure file](https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv) for *modsim* device as following, 
+
+```CSV
+device,modsim001,1,,
+poll,holding_register,40000,20,BE_BE
+ref,value1,40000,uint16,rw
+ref,value2,40001,uint16,rw
+ref,value3,40002,uint16,rw
+ref,value4,40003,uint16,rw
+ref,value5,40004,int16,rw
+ref,value6,40005,int16,rw
+ref,value7,40006,int16,rw
+ref,value8,40007,int16,rw
+ref,value9,40008,uint32,rw
+ref,value10,40010,uint32,rw
+ref,value11,40012,int32,rw
+ref,value12,40014,int32,rw
+ref,value13,40016,float32,rw
+ref,value14,40018,float32,rw
+poll,coil,0,24,BE_BE
+ref,coil1-8,0,bool,rw
+ref,coil9-16,8,bool,rw
+```
+
+This configuration tells *modpoll* to do the following for each poll,
+
+- Read `20` holding registers (register address: `40000-40019`) and parse data accordingly; 
+- Read `24` coils (coil address: `0-23`) and parse data accordingly; 
+
+
+Normally, you need to customize a Modbus configuration file for your own device before running *modpoll* tool, which defines the optimal polling patterns and register mappings according to device vendor's documents. 
+
+The configuration can be either a local file or a remote public URL resource. 
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll/configure.html) site for more details.*
+
+### Poll local device (modsim)
+
+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
+```
+
+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
+```
+
+> 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
+```
+
+
+### Publish data to MQTT broker
+
+This is a useful function of this new *modpoll* tool, which provides a simple way to publish collected modbus data to MQTT broker, so users can view data from a smart phone via a MQTT client. 
+
+The following example uses a public MQTT broker `mqtt.eclipseprojects.io` for test purpose. You can also setup 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
+```
+
+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. 
+
+> The MQTT topic uses `<mqtt_topic_prefix>/<deviceid>` pattern, <mqtt_topic_prefix> is provided by `--mqtt-topic-prefix` argument, the default value is `modpoll/`  and <deviceid> is provided by the Modbus configure file. 
+
+
+
+<p align="center">
+  <img src="docs/assets/screencast-modpoll-mqtt.gif">
+</p>
+
+
+
+### Write registers via MQTT publish
+
+The *modpoll* tool will subscribe to the topic `<mqtt_topic_prefix>/<deviceid>/set` once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish, 
+
+- To write a single holding register (address at `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": 12
+  }
+  ```
+
+- To write multiple holding registers (address starting from `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": [12, 13, 14, 15]
+  }
+  ```
+
+
+
+## Run in docker
+
+A docker image has been provided for user to directly run the program without local installation, 
+
+  ```bash
+  docker run helloysd/modpoll
+  ```
+
+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`,
+
+  ```bash
+  docker run helloysd/modpoll modpoll --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
+  ```
+
+
+
+## Basic Usage
+
+- Connect to Modbus TCP device
+
+  ```bash
+  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
+  ```
+
+- 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
+  ```
+
+- 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
+  ```
+
+
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll) site for more details about the configuration and examples.*
+
+
+
+## Credits
+
+The implementation of this project is heavily inspired by the following two projects:
+- https://github.com/owagner/modbus2mqtt (MIT license)
+- https://github.com/mbs38/spicierModbus2mqtt (MIT license)
+
+Thanks to Max Brueggemann and Oliver Wagner for their great work. 
+
+
+
+## License
+
+MIT © [helloysd](helloysd@foxmail.com)
+
+
+%package help
+Summary:	Development documents and examples for modpoll
+Provides:	python3-modpoll-doc
+%description help
+# modpoll - A New Command Line Tool for Modbus
+
+[![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)
+[![Downloads](http://pepy.tech/badge/modpoll)](http://pepy.tech/project/modpoll)
+
+> Learn more about *modpoll* usage at [documentation](https://helloysd.gitlab.io/modpoll) site. 
+
+
+
+## Motivation
+
+The initial idea of creating this tool is to help myself debugging new devices during site survey. A site survey usually has limited time and space, working on-site also piles up some pressures. At that time, a portable swiss-knife toolkit is our best friend.
+
+This program can be easily deployed to Raspberry Pi or similar embedded devices, polling data from modbus devices, users can choose to log data locally or publish to a MQTT broker for further debugging. 
+
+The MQTT broker can be setup on the same Raspberry Pi or on the cloud. Once data successfully published, users can subscribe to a specific MQTT topic to view the data via a smart phone at your fingertip. 
+
+
+
+<p align="center">
+  <img src="docs/assets/modpoll-usage.png">
+</p>
+
+
+
+Moreover, you can also run this program continuously on a server as a Modbus-MQTT gateway, i.e. polling from local Modbus devices and forwarding data to a centralized cloud service. 
+
+In fact, *modpoll* helps to bridge between the traditional fieldbus world and the new IoT world. 
+
+
+> This program is designed to be a standalone tool, it works out-of-the-box on Linux/macOS/Windows. 
+
+> If you are looing for a modbus python library, please consider the following great open source projects, [pymodbus](https://github.com/riptideio/pymodbus) or [minimalmodbus](https://github.com/pyhys/minimalmodbus)
+
+
+
+## Feature
+
+- Support Modbus RTU/TCP/UDP devices
+- Show polling data for local debugging, like a typical modpoll tool
+- Publish polling data to MQTT broker for remote debugging, especially on smart phone
+- Export polling data to local storage for further investigation
+- Provide docker solution for continuous data polling use case
+
+
+
+## Installation
+
+This program tested on python 3.8+, the package is available in the Python Package Index, users can easily install it using `pip` or `pipx`.
+
+### Using PIP
+
+Python3 is supported by most popular platforms, e.g. Linux/macOS/Windows, on which you can install *modpoll* using `pip` tool, 
+
+```bash
+pip install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```bash
+pip install -U modpoll
+```
+
+### On Windows
+
+It is recommended to use `pipx` for installing *modpoll* on Windows, refer to [here](https://pypa.github.io/pipx/installation/) for more information about `pipx`. 
+
+Once `pipx` installed, you can run the following command in a Command Prompt termial. 
+
+```PowerShell
+pipx install modpoll
+```
+
+Upgrade the tool via the following command,
+
+```PowerShell
+pipx upgrade modpoll
+```
+
+
+## Quickstart
+
+As the name tells, *modpoll* is a tool for communicating with Modbus devices, so ideally it makes more sense if you have a real Modbus device on hand for the following test, but it is OK if you don't, we provide a virtual Modbus TCP device deployed at `modsim.topmaker.net:502` for your quick testing purpose. 
+
+Let's start expoloring *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
+```
+
+<p align="center">
+  <img src="docs/assets/screenshot-modpoll.png">
+</p>
+
+
+> the modsim code is also available [here](https://github.com/gavinying/modsim)
+
+
+### Prepare Modbus configure file
+
+The reason we can magically poll data from the online device *modsim* is because we have already provided the [Modbus configure file](https://raw.githubusercontent.com/gavinying/modpoll/master/examples/modsim.csv) for *modsim* device as following, 
+
+```CSV
+device,modsim001,1,,
+poll,holding_register,40000,20,BE_BE
+ref,value1,40000,uint16,rw
+ref,value2,40001,uint16,rw
+ref,value3,40002,uint16,rw
+ref,value4,40003,uint16,rw
+ref,value5,40004,int16,rw
+ref,value6,40005,int16,rw
+ref,value7,40006,int16,rw
+ref,value8,40007,int16,rw
+ref,value9,40008,uint32,rw
+ref,value10,40010,uint32,rw
+ref,value11,40012,int32,rw
+ref,value12,40014,int32,rw
+ref,value13,40016,float32,rw
+ref,value14,40018,float32,rw
+poll,coil,0,24,BE_BE
+ref,coil1-8,0,bool,rw
+ref,coil9-16,8,bool,rw
+```
+
+This configuration tells *modpoll* to do the following for each poll,
+
+- Read `20` holding registers (register address: `40000-40019`) and parse data accordingly; 
+- Read `24` coils (coil address: `0-23`) and parse data accordingly; 
+
+
+Normally, you need to customize a Modbus configuration file for your own device before running *modpoll* tool, which defines the optimal polling patterns and register mappings according to device vendor's documents. 
+
+The configuration can be either a local file or a remote public URL resource. 
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll/configure.html) site for more details.*
+
+### Poll local device (modsim)
+
+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
+```
+
+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
+```
+
+> 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
+```
+
+
+### Publish data to MQTT broker
+
+This is a useful function of this new *modpoll* tool, which provides a simple way to publish collected modbus data to MQTT broker, so users can view data from a smart phone via a MQTT client. 
+
+The following example uses a public MQTT broker `mqtt.eclipseprojects.io` for test purpose. You can also setup 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
+```
+
+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. 
+
+> The MQTT topic uses `<mqtt_topic_prefix>/<deviceid>` pattern, <mqtt_topic_prefix> is provided by `--mqtt-topic-prefix` argument, the default value is `modpoll/`  and <deviceid> is provided by the Modbus configure file. 
+
+
+
+<p align="center">
+  <img src="docs/assets/screencast-modpoll-mqtt.gif">
+</p>
+
+
+
+### Write registers via MQTT publish
+
+The *modpoll* tool will subscribe to the topic `<mqtt_topic_prefix>/<deviceid>/set` once it successfully connected to MQTT broker, user can write device register(s) via MQTT publish, 
+
+- To write a single holding register (address at `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": 12
+  }
+  ```
+
+- To write multiple holding registers (address starting from `40001`)
+
+  ```json
+  {
+    "object_type": "holding_register",
+    "address": 40001,
+    "value": [12, 13, 14, 15]
+  }
+  ```
+
+
+
+## Run in docker
+
+A docker image has been provided for user to directly run the program without local installation, 
+
+  ```bash
+  docker run helloysd/modpoll
+  ```
+
+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`,
+
+  ```bash
+  docker run helloysd/modpoll modpoll --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
+  ```
+
+
+
+## Basic Usage
+
+- Connect to Modbus TCP device
+
+  ```bash
+  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
+  ```
+
+- 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
+  ```
+
+- 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
+  ```
+
+
+
+> *Refer to the [documentation](https://helloysd.gitlab.io/modpoll) site for more details about the configuration and examples.*
+
+
+
+## Credits
+
+The implementation of this project is heavily inspired by the following two projects:
+- https://github.com/owagner/modbus2mqtt (MIT license)
+- https://github.com/mbs38/spicierModbus2mqtt (MIT license)
+
+Thanks to Max Brueggemann and Oliver Wagner for their great work. 
+
+
+
+## License
+
+MIT © [helloysd](helloysd@foxmail.com)
+
+
+%prep
+%autosetup -n modpoll-0.5.3
+
+%build
+%py3_build
+
+%install
+%py3_install
+install -d -m755 %{buildroot}/%{_pkgdocdir}
+if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
+if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
+if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
+if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
+pushd %{buildroot}
+if [ -d usr/lib ]; then
+	find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/lib64 ]; then
+	find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/bin ]; then
+	find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+if [ -d usr/sbin ]; then
+	find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
+fi
+touch doclist.lst
+if [ -d usr/share/man ]; then
+	find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
+fi
+popd
+mv %{buildroot}/filelist.lst .
+mv %{buildroot}/doclist.lst .
+
+%files -n python3-modpoll -f filelist.lst
+%dir %{python3_sitelib}/*
+
+%files help -f doclist.lst
+%{_docdir}/*
+
+%changelog
+* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.3-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..a706079
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+5336b00168aa04deddc9019640bffd88  modpoll-0.5.3.tar.gz