REPL (Read-Eval-Print Loop) tool for working with Modbus devices using the Pymodbus library.
Project description
Pymodbus-REPL
Pymodbus-REPL is a REPL (Read-Eval-Print Loop) tool for working with Modbus devices using the Pymodbus library.
Development Setup
Prerequisites
- Python 3.8+
- Poetry (installed globally or within a virtual environment)
Dev instructions
-
Clone the repository:
git clone https://github.com/pymodbus-dev/repl.git
-
Navigate to the project directory:
cd repl
-
Install dependencies using Poetry:
poetry install
NOTE This repo is meant to be an helper for pymodbus and the usage requires a working version of pymodbus.
The installed pymodbus
library for local development can also have impact on the path resolution while working locally on this repo.
To overcome that problem, please make sure to run the client and server files
from with in the respective working directories.
For .e.g
Run Server
(pymodbus3.8)
pymodbus/repl/server on repl-server-startup [!?] via 🐍 v3.8.13 (pymodbus3.8)
❯ python3 main.py --host 0.0.0.0 --verbose run --modbus-config default_config.json --modbus-server tcp --modbus-framer socket --modbus-port 5020 --unit-id 1 --unit-id 2 -u 4 -r 1 --timeout 2
2024-02-17 13:27:17,218 INFO logging:97 Modbus server started
2024-02-17 13:27:17,219 DEBUG logging:103 Awaiting connections server_listener
2024-02-17 13:27:17,219 INFO logging:97 Server listening.
__________ .______. _________
\______ \___.__. _____ ____ __| _/\_ |__ __ __ ______ / _____/ ______________ __ ___________
| ___< | |/ \ / _ \ / __ | | __ \| | \/ ___/ \_____ \_/ __ \_ __ \ \/ // __ \_ __ \\
| | \___ | Y Y ( <_> ) /_/ | | \_\ \ | /\___ \ / \ ___/| | \/\ /\ ___/| | \/
|____| / ____|__|_| /\____/\____ | |___ /____//____ > /_______ /\___ >__| \_/ \___ >__|
\/ \/ \/ \/ \/ \/ \/ \/
SERVER >
Run client
pymodbus/repl/client on repl-server-startup [!?] via 🐍 v3.8.13 (pymodbus3.8)
❯ python3 main.py tcp --port 5020 --framer tcp
----------------------------------------------------------------------------
__________ _____ .___ __________ .__
\______ \___.__. / \ ____ __| _/ \______ \ ____ ______ | |
| ___< | |/ \ / \ / _ \ / __ | | _// __ \\\____ \| |
| | \___ / Y ( <_> ) /_/ | | | \ ___/| |_> > |__
|____| / ____\____|__ /\____/\____ | /\ |____|_ /\___ > __/|____/
\/ \/ \/ \/ \/ \/|__|
v1.3.1 - 3.6.4
----------------------------------------------------------------------------
> client.read_input_registers address 1 count 1 slave 4
{
"registers": [
34518
]
}
> client.read_input_registers address 1 count 1 slave 1
{
"registers": [
32198
]
}
> client.read_input_registers address 1 count 1 slave 2
{
"registers": [
51557
]
}
> client.read_input_registers address 1 count 1 slave 3
{
"original_function_code": "4 (0x4)",
"error": "[Input/Output] Modbus Error: [Invalid Message] No response received, expected at least 8 bytes (0 received)"
}
Running Tests
To run tests, use the following command:
poetry run pytest
Building Distribution
To build the distribution package, use the following command:
poetry build
This will create distribution packages in the dist/ directory.
Usage
Pymodbus Client
Refer REPL Client
Pymodbus Server
Refer REPL Server
Contributing
- Fork the repository.
- Create a new branch (git checkout -b feature-name).
- Make your changes and commit them (git commit -am 'Add feature').
- Push to the branch (git push origin feature-name).
- Create a new Pull Request.
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pymodbus_repl-2.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fa7c11eeb1708114b331a2f95844e263e2f1d775ee40d595b1a3c4ca3cf8c325 |
|
MD5 | 6b3d762f829bf5ea4408c4bc574072e8 |
|
BLAKE2b-256 | 14dac649bb393753304672319c82a4f88fbd0b2d52490ab672ffde1b804daebc |