moat-modbus


Namemoat-modbus JSON
Version 0.8.0 PyPI version JSON
download
home_pageNone
SummaryModular async modbus client and server
upload_time2024-09-27 09:43:46
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
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).

++++++++++++++++++++++++
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/6a/82/d92fcab82c10062102d524873e7dbd07256bcf8a24968d5cc1a0fc2d2c8f/moat-modbus-0.8.0.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.0",
    "project_urls": {
        "homepage": "https://m-o-a-t.org",
        "repository": "https://github.com/M-o-a-T/moat-modbus"
    },
    "split_keywords": [
        "moat"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "996e871afa1788b37f0729d558aeccd1db63aab9cdc11b86b7d2760a99d7e992",
                "md5": "01621a00110f0210f31ab4517d6de920",
                "sha256": "fa72e2fb346252ab9a6804e5291e31e51792cd21819179879063b5ff250aece9"
            },
            "downloads": -1,
            "filename": "moat_modbus-0.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "01621a00110f0210f31ab4517d6de920",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 33554,
            "upload_time": "2024-09-27T09:43:45",
            "upload_time_iso_8601": "2024-09-27T09:43:45.021183Z",
            "url": "https://files.pythonhosted.org/packages/99/6e/871afa1788b37f0729d558aeccd1db63aab9cdc11b86b7d2760a99d7e992/moat_modbus-0.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6a82d92fcab82c10062102d524873e7dbd07256bcf8a24968d5cc1a0fc2d2c8f",
                "md5": "b9d69d993c112e0b0d1ab6625e9a0650",
                "sha256": "982345372f761722cc69ecf8198a792c9e4835353045b4a9bd84905301352e50"
            },
            "downloads": -1,
            "filename": "moat-modbus-0.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b9d69d993c112e0b0d1ab6625e9a0650",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 35434,
            "upload_time": "2024-09-27T09:43:46",
            "upload_time_iso_8601": "2024-09-27T09:43:46.128173Z",
            "url": "https://files.pythonhosted.org/packages/6a/82/d92fcab82c10062102d524873e7dbd07256bcf8a24968d5cc1a0fc2d2c8f/moat-modbus-0.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-27 09:43:46",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "M-o-a-T",
    "github_project": "moat-modbus",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "moat-modbus"
}
        
Elapsed time: 0.35702s