moat-modbus


Namemoat-modbus JSON
Version 0.5.3 PyPI version JSON
download
home_page
SummaryModular async modbus client and server
upload_time2023-01-03 13:20:55
maintainer
docs_urlNone
author
requires_python>=3.8
license
keywords moat
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ###########
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).

TODO
++++

* plain MQTT
* configurable codecs
* get/set attributes
* pack multiple values into a message

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "moat-modbus",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "MoaT",
    "author": "",
    "author_email": "Matthias Urlichs <matthias@urlichs.de>",
    "download_url": "https://files.pythonhosted.org/packages/9a/97/1ca93ed6182111c3551d3b9698eb877ded651b99239125a25fc592a96a06/moat-modbus-0.5.3.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\nTODO\n++++\n\n* plain MQTT\n* configurable codecs\n* get/set attributes\n* pack multiple values into a message\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Modular async modbus client and server",
    "version": "0.5.3",
    "split_keywords": [
        "moat"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3ad4367415a90e3a158ac772c2886e58c316d090d6fbb5dca9325a388e5da4ae",
                "md5": "e9266955f475975ea2eb7a17ae6c8c98",
                "sha256": "bb10b096bc5974e9f940855d9150d803d6501ab4d47648616c0d53bacce73cfb"
            },
            "downloads": -1,
            "filename": "moat_modbus-0.5.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e9266955f475975ea2eb7a17ae6c8c98",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 29538,
            "upload_time": "2023-01-03T13:20:53",
            "upload_time_iso_8601": "2023-01-03T13:20:53.621352Z",
            "url": "https://files.pythonhosted.org/packages/3a/d4/367415a90e3a158ac772c2886e58c316d090d6fbb5dca9325a388e5da4ae/moat_modbus-0.5.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9a971ca93ed6182111c3551d3b9698eb877ded651b99239125a25fc592a96a06",
                "md5": "2d0a8fa036147b1d9a3e2de555183d15",
                "sha256": "21ce0e5f0b5e548ef71dc7a848c182ba411279852ece91e161f7a4eb44fdf753"
            },
            "downloads": -1,
            "filename": "moat-modbus-0.5.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2d0a8fa036147b1d9a3e2de555183d15",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 29650,
            "upload_time": "2023-01-03T13:20:55",
            "upload_time_iso_8601": "2023-01-03T13:20:55.024201Z",
            "url": "https://files.pythonhosted.org/packages/9a/97/1ca93ed6182111c3551d3b9698eb877ded651b99239125a25fc592a96a06/moat-modbus-0.5.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-03 13:20:55",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "moat-modbus"
}
        
Elapsed time: 0.12733s