1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
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
[](https://gitlab.com/helloysd/modpoll/-/commits/master)
[](https://gitlab.com/helloysd/modpoll/-/blob/master/LICENSE)
[](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
[](https://gitlab.com/helloysd/modpoll/-/commits/master)
[](https://gitlab.com/helloysd/modpoll/-/blob/master/LICENSE)
[](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
[](https://gitlab.com/helloysd/modpoll/-/commits/master)
[](https://gitlab.com/helloysd/modpoll/-/blob/master/LICENSE)
[](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
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 0.5.3-1
- Package Spec generated
|