PyModbus Documentation

PyModbus

Release 3.4.1 Open Source volunteers

Jul 31, 2023

CONTENTS:

1 PyModbus - A Python Modbus Stack

1

1.1 Supported versions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.2 Summary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1

1.3 Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3.1 Client Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3.2 Server Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.3.2.1 Use Cases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.4 Example Code . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

1.4.1 Examples Directory structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.5 Pymodbus REPL (Read Evaluate Print Loop) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.5.1 Pymodbus REPL Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

1.5.2 Pymodbus REPL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.6 Installing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

1.7 Current Work In Progress . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.8 Development Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.9 Generate documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.10 Contributing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

1.11 License Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6

2 CHANGELOGS

7

2.1 version 3.4.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.2 version 3.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

2.3 version 3.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.4 version 3.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.5 version 3.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9

2.6 version 3.2.2 (picked from dev, only bugfixes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.7 version 3.2.1 (picked from dev, only bugfixes) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.8 version 3.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

2.9 version 3.1.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12

2.10 version 3.1.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.11 version 3.1.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

2.12 version 3.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2.13 version 3.0.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

2.14 version 3.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.15 version 3.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

2.16 version 3.0.0dev5 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

2.17 version 3.0.0dev4 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.18 version 3.0.0dev3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.19 version 3.0.0dev2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

2.20 version 3.0.0dev1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18

i

2.21 version 3.0.0dev0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 2.22 version 2.5.3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 2.23 version 2.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 2.24 version 2.5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 2.25 version 2.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.26 version 2.5.0rc3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.27 version 2.5.0rc2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.28 version 2.5.0rc1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 2.29 Version 2.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 2.30 Version 2.3.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 2.31 Version 2.3.0rc1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20 2.32 Version 2.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 2.33 Version 2.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 2.34 Version 2.0.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.35 Version 2.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.36 Version 2.0.0rc1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.37 Version 1.5.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.38 Version 1.5.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 2.39 Version 1.5.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 2.40 Version 1.4.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 2.41 Version 1.3.2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 2.42 Version 1.3.1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 2.43 Version 1.3.0.rc2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 2.44 Version 1.3.0.rc1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 2.45 Version 1.2.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 2.46 Version 1.1.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 2.47 Version 1.0.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 2.48 Version 0.9.0 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

3 Client

27

3.1 Transport classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

3.2 Modbus calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36

4 Server

45

5 Simulator

51

5.1 Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51

5.1.1 Json file layout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

5.1.2 Server entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

5.1.3 Server configuration examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

5.1.4 Device entries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

5.1.4.1 Setup section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

5.1.4.2 Invalid section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

5.1.4.3 Write section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

5.1.4.4 Bits section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58

5.1.4.5 Uint16 section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

5.1.4.6 Uint32 section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

5.1.4.7 Float32 section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59

5.1.4.8 String section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

5.1.4.9 Repeat section . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

5.1.5 Device configuration examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

5.1.6 Configuration used for test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

5.2 Simulator datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68

5.3 Web frontend . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69

ii

5.3.1 pymodbus.simulator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69 5.4 Pymodbus simulator ReST API . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

6 REPL

73

6.1 Dependencies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

6.2 Usage Instructions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

6.3 DEMO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

6.4 REPL client classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79

6.5 REPL server classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

7 Datastore

93

7.1 Datastore classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

8 Framer

99

8.1 pymodbus.framer.ascii_framer module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

8.2 pymodbus.framer.binary_framer module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

8.3 pymodbus.framer.rtu_framer module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

8.4 pymodbus.framer.socket_framer module . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103

9 Constants

105

10 Extra functions

109

11 Examples

157

11.1 Ready to run examples: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

11.1.1 Simple asynchronous client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157

11.1.2 Simple synchronous client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160

11.1.3 Client performance sync vs async . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

11.2 Advanced examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

11.2.1 Asynchronous client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

11.2.2 Asynchronous client basic calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

11.2.3 Asynchronous server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

11.2.4 Callback Server example . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

11.2.5 Custom Message client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

11.2.6 Message generator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

11.2.7 Message Parser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

11.2.8 Modbus forwarder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

11.2.9 Modbus payload client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

11.2.10 Modbus payload Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

11.2.11 Synchronous client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

11.2.12 Synchronous server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

11.2.13 Updating server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

11.3 Examples contributions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

11.3.1 Redis datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

11.3.2 Serial Forwarder . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

11.3.3 Sqlalchemy datastore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

12 Indices and tables

213

Python Module Index

215

Index

217

iii

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download