denpamusic / PyPlumIO

PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.
MIT License
16 stars 2 forks source link
econet heating-control heating-monitoring home-automation library pypi-package python3

PyPlumIO is a native ecoNET library for Plum ecoMAX controllers.

PyPI version PyPI Supported Python Versions PyPlumIO CI Maintainability Test Coverage stability-release-candidate Ruff

Overview

This package aims to provide complete and easy to use solution for communicating with climate devices by Plum Sp. z o.o.

ecoMAX controllers

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

Table of contents

Quickstart

  1. To use PyPlumIO, first install it using pip:
$ pip install pyplumio
  1. Connect to the ecoMAX controller:
>>> connection = pyplumio.open_serial_connection("/dev/ttyUSB0")
>>> await connection.connect()
>>> ecomax = await connection.get("ecomax")
  1. Print some values:

    >>> print(await ecomax.get("heating_temp"))
  2. Don’t forget to close the connection:

    >>> 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

Attribution

Special thanks to econetanalyze project by twkrol for initial information about protocol.

License

This product is distributed under MIT license.