###########
moat-modbus
###########
This is an anyio-enabled async frontend for pymodbus.
+++++
Usage
+++++
Check the example client and server for rudimentary usage.
Documentation patches gladly accepted.
++++++++++
Background
++++++++++
`moat-modbus` diverges from `pymodbus` in that it does not expose a "data
store" context to the user. Instead, every bus value is a separate object,
with arbitrary length and encapsulating its own encoding and decoding rules.
A Modbus server exposing writeable registers only needs to
* register the value in question
* wait for it to be written to
The rest happens behind the scenes.
+++++++++++++
Device Server
+++++++++++++
As some Modbus devices only allow ine server at a time, MoaT's Modbus
supports a simple bidirectional gateway.
How to get there:
* Write a generic device description. Put it in the modbus-data repository.
* Add an interface overlay that describes which topic to send the data to /
which topic to read.
* Run ``moat modbus dev poll FILE.yaml``. You can use a generic systemd
service if you copy the file to ``/etc/moat/modbus``.
The values can be modified (factor+offset); the gateway works in both
directions (command/state).
++++++++++++++++++++++++
MQTT / MoaT-KV interface
++++++++++++++++++++++++
MoaT-Modbus includes a server that's informed by a device profile. This server
acts as a bidirectional gateway from and to MQTT and/or MoaT-KV storage.
See "gateway.rst" for details.
TODO
++++
* configurable codecs
* get/set attributes
* pack multiple values into a message
* read-after-write if no slot
Raw data
{
"_id": null,
"home_page": null,
"name": "moat-modbus",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "MoaT",
"author": null,
"author_email": "Matthias Urlichs <matthias@urlichs.de>",
"download_url": "https://files.pythonhosted.org/packages/66/9c/73315a5ee399de9c595a267f88a713815dc3c641d75f88118033356ab7d7/moat_modbus-0.8.7.tar.gz",
"platform": null,
"description": "###########\nmoat-modbus\n###########\n\nThis is an anyio-enabled async frontend for pymodbus.\n\n+++++\nUsage\n+++++\n\nCheck the example client and server for rudimentary usage.\n\nDocumentation patches gladly accepted.\n\n++++++++++\nBackground\n++++++++++\n\n`moat-modbus` diverges from `pymodbus` in that it does not expose a \"data\nstore\" context to the user. Instead, every bus value is a separate object,\nwith arbitrary length and encapsulating its own encoding and decoding rules.\n\nA Modbus server exposing writeable registers only needs to\n\n* register the value in question\n\n* wait for it to be written to\n\nThe rest happens behind the scenes.\n\n+++++++++++++\nDevice Server\n+++++++++++++\n\nAs some Modbus devices only allow ine server at a time, MoaT's Modbus\nsupports a simple bidirectional gateway.\n\nHow to get there:\n\n* Write a generic device description. Put it in the modbus-data repository.\n\n* Add an interface overlay that describes which topic to send the data to /\n which topic to read.\n\n* Run ``moat modbus dev poll FILE.yaml``. You can use a generic systemd\n service if you copy the file to ``/etc/moat/modbus``.\n\nThe values can be modified (factor+offset); the gateway works in both\ndirections (command/state).\n\n++++++++++++++++++++++++\nMQTT / MoaT-KV interface\n++++++++++++++++++++++++\n\nMoaT-Modbus includes a server that's informed by a device profile. This server\nacts as a bidirectional gateway from and to MQTT and/or MoaT-KV storage.\n\nSee \"gateway.rst\" for details.\n\n\nTODO\n++++\n\n* configurable codecs\n* get/set attributes\n* pack multiple values into a message\n* read-after-write if no slot\n",
"bugtrack_url": null,
"license": null,
"summary": "Modular async modbus client and server",
"version": "0.8.7",
"project_urls": {
"homepage": "https://m-o-a-t.org",
"repository": "https://github.com/M-o-a-T/moat"
},
"split_keywords": [
"moat"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "25d1883572e8aa9c253c1cf1beee8080d8d0fec683d1a66c2c54b1618a685d84",
"md5": "fe49f6dc438b40d82e8c15622b84c7ce",
"sha256": "804d9ce310844d57794c3ddb755ef01f1a37859885839c94b1e249ad760b3ab7"
},
"downloads": -1,
"filename": "moat_modbus-0.8.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fe49f6dc438b40d82e8c15622b84c7ce",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 34814,
"upload_time": "2025-08-12T15:50:08",
"upload_time_iso_8601": "2025-08-12T15:50:08.751862Z",
"url": "https://files.pythonhosted.org/packages/25/d1/883572e8aa9c253c1cf1beee8080d8d0fec683d1a66c2c54b1618a685d84/moat_modbus-0.8.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "669c73315a5ee399de9c595a267f88a713815dc3c641d75f88118033356ab7d7",
"md5": "6c702ce764117ab01afaf067a5d8a5b8",
"sha256": "001e03d52a2134c6378f1d654036200fa68b199537a3263e88ed3089ed68b530"
},
"downloads": -1,
"filename": "moat_modbus-0.8.7.tar.gz",
"has_sig": false,
"md5_digest": "6c702ce764117ab01afaf067a5d8a5b8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 34002,
"upload_time": "2025-08-12T15:50:09",
"upload_time_iso_8601": "2025-08-12T15:50:09.828473Z",
"url": "https://files.pythonhosted.org/packages/66/9c/73315a5ee399de9c595a267f88a713815dc3c641d75f88118033356ab7d7/moat_modbus-0.8.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-12 15:50:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "M-o-a-T",
"github_project": "moat",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "anyio",
"specs": []
},
{
"name": "anyio_serial",
"specs": []
},
{
"name": "trio",
"specs": []
},
{
"name": "asyncclick",
"specs": []
},
{
"name": "asyncscope",
"specs": []
},
{
"name": "git",
"specs": []
},
{
"name": "msgpack",
"specs": []
},
{
"name": "simpleeval",
"specs": []
},
{
"name": "ruyaml",
"specs": []
},
{
"name": "cffi",
"specs": []
},
{
"name": "packaging",
"specs": []
},
{
"name": "pymodbus",
"specs": []
},
{
"name": "tomlkit",
"specs": []
}
],
"lcname": "moat-modbus"
}
JSON
