PyPlumIO


NamePyPlumIO JSON
Version 0.5.16 PyPI version JSON
download
home_page
SummaryPyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
upload_time2024-03-06 12:25:10
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT License
keywords home automation heating
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
[![PyPI version](https://badge.fury.io/py/PyPlumIO.svg)](https://badge.fury.io/py/PyPlumIO)
[![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyplumio.svg)](https://pypi.python.org/pypi/pyplumio/)
[![PyPlumIO CI](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml/badge.svg)](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)
[![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://guidelines.denpa.pro/stability#release-candidate)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

## Overview
This package aims to provide complete and easy to use solution for communicating with climate devices by [Plum Sp. z o.o.](https://www.plum.pl/)

![ecoMAX controllers](https://raw.githubusercontent.com/denpamusic/PyPlumIO/main/images/ecomax.png)

Currently it supports reading and writing parameters of ecoMAX controllers by Plum Sp. z o.o., getting service password and sending network information to show on controller's display.

Devices can be connected directly via RS-485 to USB adapter or through network by using RS-485 to Ethernet/WiFi converter.

![RS-485 converters](https://raw.githubusercontent.com/denpamusic/PyPlumIO/main/images/rs485.png)

## Table of contents
- [Connecting](https://pyplumio.denpa.pro/connecting.html)
- [Reading](https://pyplumio.denpa.pro/reading.html)
- [Writing](https://pyplumio.denpa.pro/writing.html)
- [Callbacks](https://pyplumio.denpa.pro/callbacks.html)
- [Mixers/Thermostats](https://pyplumio.denpa.pro/mixers_thermostats.html)
- [Schedules](https://pyplumio.denpa.pro/schedules.html)
- [Protocol](https://pyplumio.denpa.pro/protocol.html)
  - [Frame Structure](https://pyplumio.denpa.pro/protocol.html#frame-structure)
  - [Requests and Responses](https://pyplumio.denpa.pro/protocol.html#requests-and-responses)
  - [Communication](https://pyplumio.denpa.pro/protocol.html#communication)
  - [Versioning](https://pyplumio.denpa.pro/protocol.html#versioning)


## Quickstart

1. To use PyPlumIO, first install it using pip:

```bash
$ pip install pyplumio
```

2. Connect to the ecoMAX controller:

```python
>>> connection = pyplumio.open_serial_connection("/dev/ttyUSB0")
>>> await connection.connect()
>>> ecomax = await connection.get("ecomax")
```

3. Print some values:
```python
>>> print(await ecomax.get("heating_temp"))
```

4. Don’t forget to close the connection:
```python
>>> await connection.close()
```

## Home Assistant Integration
There is companion Home Assistant integration that is being co-developed with this package and depends on it. Click button below to check it out.

[![Plum ecoMAX for Home Assistant](https://img.shields.io/badge/Plum%20ecoMAX%20for%20Home%20Assistant-41bdf5)](https://github.com/denpamusic/homeassistant-plum-ecomax)

## Attribution
Special thanks to [econetanalyze](https://github.com/twkrol/econetanalyze) project by twkrol for initial information about protocol.

## License
This product is distributed under MIT license.

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "PyPlumIO",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "home,automation,heating",
    "author": "",
    "author_email": "Denis Paavilainen <denpa@denpa.pro>",
    "download_url": "https://files.pythonhosted.org/packages/1f/c3/f06fba88aa4dcc004ae8d4b55381343af4a8b883049204f2e1c8fd210da2/PyPlumIO-0.5.16.tar.gz",
    "platform": "any",
    "description": "# PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.\n[![PyPI version](https://badge.fury.io/py/PyPlumIO.svg)](https://badge.fury.io/py/PyPlumIO)\n[![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyplumio.svg)](https://pypi.python.org/pypi/pyplumio/)\n[![PyPlumIO CI](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml/badge.svg)](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)\n[![Maintainability](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/maintainability)](https://codeclimate.com/github/denpamusic/PyPlumIO/maintainability)\n[![Test Coverage](https://api.codeclimate.com/v1/badges/9f275fbc50fe9082a909/test_coverage)](https://codeclimate.com/github/denpamusic/PyPlumIO/test_coverage)\n[![stability-release-candidate](https://img.shields.io/badge/stability-pre--release-48c9b0.svg)](https://guidelines.denpa.pro/stability#release-candidate)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n\n## Overview\nThis package aims to provide complete and easy to use solution for communicating with climate devices by [Plum Sp. z o.o.](https://www.plum.pl/)\n\n![ecoMAX controllers](https://raw.githubusercontent.com/denpamusic/PyPlumIO/main/images/ecomax.png)\n\nCurrently it supports reading and writing parameters of ecoMAX controllers by Plum Sp. z o.o., getting service password and sending network information to show on controller's display.\n\nDevices can be connected directly via RS-485 to USB adapter or through network by using RS-485 to Ethernet/WiFi converter.\n\n![RS-485 converters](https://raw.githubusercontent.com/denpamusic/PyPlumIO/main/images/rs485.png)\n\n## Table of contents\n- [Connecting](https://pyplumio.denpa.pro/connecting.html)\n- [Reading](https://pyplumio.denpa.pro/reading.html)\n- [Writing](https://pyplumio.denpa.pro/writing.html)\n- [Callbacks](https://pyplumio.denpa.pro/callbacks.html)\n- [Mixers/Thermostats](https://pyplumio.denpa.pro/mixers_thermostats.html)\n- [Schedules](https://pyplumio.denpa.pro/schedules.html)\n- [Protocol](https://pyplumio.denpa.pro/protocol.html)\n  - [Frame Structure](https://pyplumio.denpa.pro/protocol.html#frame-structure)\n  - [Requests and Responses](https://pyplumio.denpa.pro/protocol.html#requests-and-responses)\n  - [Communication](https://pyplumio.denpa.pro/protocol.html#communication)\n  - [Versioning](https://pyplumio.denpa.pro/protocol.html#versioning)\n\n\n## Quickstart\n\n1. To use PyPlumIO, first install it using pip:\n\n```bash\n$ pip install pyplumio\n```\n\n2. Connect to the ecoMAX controller:\n\n```python\n>>> connection = pyplumio.open_serial_connection(\"/dev/ttyUSB0\")\n>>> await connection.connect()\n>>> ecomax = await connection.get(\"ecomax\")\n```\n\n3. Print some values:\n```python\n>>> print(await ecomax.get(\"heating_temp\"))\n```\n\n4. Don\u2019t forget to close the connection:\n```python\n>>> await connection.close()\n```\n\n## Home Assistant Integration\nThere is companion Home Assistant integration that is being co-developed with this package and depends on it. Click button below to check it out.\n\n[![Plum ecoMAX for Home Assistant](https://img.shields.io/badge/Plum%20ecoMAX%20for%20Home%20Assistant-41bdf5)](https://github.com/denpamusic/homeassistant-plum-ecomax)\n\n## Attribution\nSpecial thanks to [econetanalyze](https://github.com/twkrol/econetanalyze) project by twkrol for initial information about protocol.\n\n## License\nThis product is distributed under MIT license.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.",
    "version": "0.5.16",
    "project_urls": {
        "Bug Tracker": "https://github.com/denpamusic/PyPlumIO/issues",
        "Documentation": "https://pyplumio.denpa.pro",
        "Source Code": "https://github.com/denpamusic/PyPlumIO"
    },
    "split_keywords": [
        "home",
        "automation",
        "heating"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "14f593e1aaedcceb8be4ccb24735eded373cab26418c80f20e3ad825c8f0c492",
                "md5": "59581e0b4ee52e0cf90a535882ec8ef3",
                "sha256": "575334355ea7781156490ff9a3dca6a43e11f85107d857607729210a5d1e7af7"
            },
            "downloads": -1,
            "filename": "PyPlumIO-0.5.16-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "59581e0b4ee52e0cf90a535882ec8ef3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 68880,
            "upload_time": "2024-03-06T12:25:07",
            "upload_time_iso_8601": "2024-03-06T12:25:07.176449Z",
            "url": "https://files.pythonhosted.org/packages/14/f5/93e1aaedcceb8be4ccb24735eded373cab26418c80f20e3ad825c8f0c492/PyPlumIO-0.5.16-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "1fc3f06fba88aa4dcc004ae8d4b55381343af4a8b883049204f2e1c8fd210da2",
                "md5": "0fadaaaceb25c5bb532366434fbf3c48",
                "sha256": "a1df7c5e31a2ea7f4400af3afdbc9822b62376f06435e04c2db91e521c80dabd"
            },
            "downloads": -1,
            "filename": "PyPlumIO-0.5.16.tar.gz",
            "has_sig": false,
            "md5_digest": "0fadaaaceb25c5bb532366434fbf3c48",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 257939,
            "upload_time": "2024-03-06T12:25:10",
            "upload_time_iso_8601": "2024-03-06T12:25:10.385026Z",
            "url": "https://files.pythonhosted.org/packages/1f/c3/f06fba88aa4dcc004ae8d4b55381343af4a8b883049204f2e1c8fd210da2/PyPlumIO-0.5.16.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-03-06 12:25:10",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "denpamusic",
    "github_project": "PyPlumIO",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "pyplumio"
}
        
Elapsed time: 0.21195s