Skip to content

Commit 1013194

Browse files
committed
Update README and docs
1 parent 20108a3 commit 1013194

File tree

6 files changed

+72
-5
lines changed

6 files changed

+72
-5
lines changed

.readthedocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,6 @@ requirements_file: requirements-docs.txt
66
python:
77
extra_requirements:
88
- twisted
9+
- torndo
910
- documents
1011
version: 3.5

README.rst

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,9 @@ Client Features
3434
* Full read/write protocol on discrete and register
3535
* Most of the extended protocol (diagnostic/file/pipe/setting/information)
3636
* TCP, UDP, Serial ASCII, Serial RTU, and Serial Binary
37-
* asynchronous(powered by twisted) and synchronous versions
37+
* asynchronous(powered by twisted/tornado/asyncio) and synchronous versions
3838
* Payload builder/decoder utilities
39+
* Pymodbus REPL for quick tests
3940

4041
------------------------------------------------------------
4142
Server Features
@@ -93,6 +94,18 @@ trace them. I get a lot of email and sometimes these requests
9394
get lost in the noise: http://groups.google.com/group/pymodbus or
9495
at gitter: https://gitter.im/pymodbus_dev/Lobby
9596

97+
------------------------------------------------------------
98+
Pymodbus REPL (Read Evaluate Procee Loop)
99+
------------------------------------------------------------
100+
Starting with Pymodbus 2.x, pymodbus library comes with handy
101+
Pymodbus REPL to quickly run the modbus clients in tcp/rtu modes.
102+
103+
Pymodbus REPL comes with many handy features such as payload decoder
104+
to directly retrieve the values in desired format and supports all
105+
the diagnostic function codes directly .
106+
107+
For more info on REPL refer `Pymodbus REPL <pymodbus/repl/README.md>`_
108+
96109
------------------------------------------------------------
97110
Installing
98111
------------------------------------------------------------
@@ -104,15 +117,18 @@ permissions or a virtualenv currently running)::
104117
easy_install -U pymodbus
105118
pip install -U pymodbus
106119

107-
To Install pymodbus with twisted support run
108-
.. code-block:: python
120+
To Install pymodbus with twisted support run::
121+
109122
pip install -U pymodbus[twisted]
110123

111-
To Install pymodbus with tornado support run
124+
To Install pymodbus with tornado support run::
112125

113-
.. code-block:: python
114126
pip install -U pymodbus[tornado]
115127

128+
To Install pymodbus REPL::
129+
130+
pip install -U pymodbus[repl]
131+
116132
Otherwise you can pull the trunk source and install from there::
117133

118134
git clone git://github.com/bashwork/pymodbus.git

doc/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ Welcome to PyModbus's documentation!
1212

1313
readme.rst
1414
changelog.rst
15+
repl.rst
1516
source/example/modules.rst
1617
source/library/modules.rst
1718

doc/repl.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Pymodbus REPL
2+
=============
3+
4+
.. mdinclude:: ../pymodbus/repl/README.md

doc/source/library/pymodbus.repl.rst

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
pymodbus\.repl package
2+
==========================
3+
4+
.. automodule:: pymodbus.repl
5+
:members:
6+
:undoc-members:
7+
:show-inheritance:
8+
9+
10+
Submodules
11+
----------
12+
13+
pymodbus\.repl\.client module
14+
-----------------------------------
15+
16+
.. automodule:: pymodbus.repl.client
17+
:members:
18+
:undoc-members:
19+
:show-inheritance:
20+
21+
pymodbus\.repl\.completer module
22+
-----------------------------------
23+
24+
.. automodule:: pymodbus.repl.completer
25+
:members:
26+
:undoc-members:
27+
:show-inheritance:
28+
29+
pymodbus\.repl\.helper module
30+
-----------------------------------
31+
32+
.. automodule:: pymodbus.repl.helper
33+
:members:
34+
:undoc-members:
35+
:show-inheritance:
36+
37+
38+
pymodbus\.repl\.main module
39+
-----------------------------------
40+
41+
.. automodule:: pymodbus.repl.main
42+
:members:
43+
:undoc-members:
44+
:show-inheritance:

doc/source/library/pymodbus.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Subpackages
1616
pymodbus.framer
1717
pymodbus.internal
1818
pymodbus.server
19+
pymodbus.repl
1920

2021

2122
Submodules

0 commit comments

Comments
 (0)