https://github.com/denpamusic/pyplumio
PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
https://github.com/denpamusic/pyplumio
econet heating-control heating-monitoring home-automation library pypi-package python3
Last synced: 5 months ago
JSON representation
PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
- Host: GitHub
- URL: https://github.com/denpamusic/pyplumio
- Owner: denpamusic
- License: mit
- Created: 2022-01-06T03:21:23.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-04-08T00:02:33.000Z (about 1 year ago)
- Last Synced: 2025-04-13T05:37:38.050Z (about 1 year ago)
- Topics: econet, heating-control, heating-monitoring, home-automation, library, pypi-package, python3
- Language: Python
- Homepage:
- Size: 7.91 MB
- Stars: 16
- Watchers: 7
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# PyPlumIO is a native ecoNET library for Plum ecoMAX controllers
[](https://badge.fury.io/py/PyPlumIO)
[](https://pypi.python.org/pypi/pyplumio/)
[](https://github.com/denpamusic/PyPlumIO/actions/workflows/ci.yml)
[](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
[](https://qlty.sh/gh/denpamusic/projects/PyPlumIO)
[](https://guidelines.denpa.pro/stability#release-candidate)
[](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/)
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.
## 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)
- [Supported frames](https://pyplumio.denpa.pro/frames.html)
## 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.
[](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.