Skip to content

jontofront/ecoNET-300-Home-Assistant-Integration

 
 

Repository files navigation

ecoNET300 Home Assistant integration

Code_formatter hacs_badge HACS Action stability-alpha Validate with hassfest

Note: This repository is a fork of the original pblxptr/ecoNET-300-Home-Assistant-Integration. Most of the work was done by @pblxpt, and we are very grateful for their efforts. Additionally, I maintained and supported this code up to version v0.3.3.

Home Assistant ecoNET300 device

Overview

he ecoNET300 Home Assistant Integration allows local control and monitoring of ecoNET300 devices directly from Home Assistant. It communicates over your local network via the ecoNET300’s native REST API, avoiding any external cloud services.

  • Local Operation: No dependency on econet24.com cloud services.
  • Easy Configuration: Integrate directly via Home Assistant UI.
  • Tested With: ecoMAX810P-L TOUCH controller from Plum Sp. z o.o.

Table of Contents

  1. ecoNET300 Home Assistant Integration
  2. Overview
  3. Versions
  4. Example
  5. Installation
  6. Configuration
  7. Entities
  8. Contributing
  9. Acknowledgments
  10. Disclaimer

versions

  • v0.3.3 - version is stable. Most of the work was done by @pblxpt, for which we're very thankful as the community.
  • v1.0.0 - A development version that retrieves more data from the API. It may be unstable, and upgrades from previous versions are not supported.

Migrating to v1.0.0_beta

Important: This release resets versioning. To upgrade:

  1. Remove the existing integration.
  2. Install v1.0.0_beta fresh.
  3. Reconfigure as instructed below.

Example

Installation

HACS (Recommended)

  1. Install and configure HACS.
  2. Add this repository as a custom repository using:
https://github.com/jontofront/ecoNET-300-Home-Assistant-Integration
  1. In HACS, search for "ecoNET300", install the integration.
  2. Restart Home Assistant.

Manual Installation

  1. Download or clone this repository.
  2. Copy custom_components/econet300 into your <config_directory>/custom_components/.
<config directory>/
|-- custom_components/
|   |-- econet300/
|       |-- [...]
  1. Restart Home Assistant.

Configuration

Integrate ecoNET300 via the user interface:

Add integration

Manual Configuration Steps

Apart from using 'My button' (in case it doesn't work) you can also perform the following steps manually:

  1. Go to Settings > Devices & Services in Home Assistant.
  2. Click Add Integration.
  3. Search and select "ecoNET300".
  4. In the bottom right, click on the Add Integration button.
  5. From the list, search and select "ecoNET300".

Search dialog

  1. Enter your local device IP/domain and local credentials (not econet24.com credentials). "Submit".

Host: Local IP/domain of your device.

Username: Local username (NOT the username that you use to login to econet24.com!).

Password: Local password (NOT the password that you use to login to econet24.com!).

Configuration dialog

  1. Your device should now be available in your Home Assistant installation.

Success


Entities

Sensors

These sensors are retrieved from the ../econet/regParams and ../econet/sysParams endpoints. Below is the list of available entity keys, their descriptions, and the corresponding API endpoint keys:

**👉 Click here to expand the table**
Entity Key Description Endpoint
tempFeeder Temperature of the feeder mechanism ../econet/regParams
fuelLevel Current fuel level in the system ../econet/regParams
tempCO Current fireplace temperature ../econet/regParams
tempCOSet Desired fireplace set temperature ../econet/regParams
statusCWU Status of the hot water (CWU) system ../econet/regParams
tempCWU Current hot water (CWU) temperature ../econet/regParams
tempCWUSet Desired hot water (CWU) temperature ../econet/regParams
tempFlueGas Exhaust temperature reading ../econet/regParams
mode Current operational mode of the device ../econet/regParams
fanPower Current fan power usage ../econet/regParams
thermostat Thermostat status or set temperature ../econet/regParams
tempExternalSensor Outside (external) temperature ../econet/regParams
tempLowerBuffer Temperature of the lower thermal buffer ../econet/regParams
tempUpperBuffer Temperature of the upper thermal buffer ../econet/regParams
boilerPower Current power output of the boiler ../econet/regParams
quality Fuel quality or system quality indicator (if applicable) ../econet/sysParams
signal Signal strength or communication status ../econet/sysParams
softVer Software version of the controller ../econet/sysParams
controllerID Unique identifier for the controller ../econet/sysParams
moduleASoftVer Software version of Module A ../econet/sysParams
moduleBSoftVer Software version of Module B ../econet/sysParams
moduleCSoftVer Software version of Module C ../econet/sysParams
moduleLambdaSoftVer Software version of the lambda module ../econet/sysParams
modulePanelSoftVer Software version of the control panel ../econet/sysParams

Binary Sensors

These binary sensors are retrieved from the ../econet/regParams and ../econet/sysParams endpoints. Below is the list of available entity keys, their descriptions, and the corresponding API endpoint keys:

**👉 Click here to expand the table**
Entity Key Description Endpoint
lighter Indicates if the lighter is active ../econet/regParams
pumpCOWorks Indicates if the fireplace pump is working ../econet/regParams
fanWorks Indicates if the fan is currently active ../econet/regParams
pumpFireplaceWorks Indicates if the fireplace pump is working ../econet/regParams
pumpCWUWorks Indicates if the hot water (CWU) pump is active ../econet/regParams
mainSrv Indicates if the main server is operational ../econet/sysParams
wifi Indicates if the Wi-Fi connection is active ../econet/sysParams
lan Indicates if the LAN connection is active ../econet/sysParams

Number Entities

These number entities are retrieved from the ../econet/rmCurrentDataParamsEdits endpoint. Below is the list of available entity keys, their descriptions, and the corresponding API endpoint keys:

**👉 Click here to expand the table**
Entity Key Description Endpoint
tempCOSet Desired fireplace set temperature ../econet/rmCurrentDataParamsEdits
tempCWUSet Desired hot water (CWU) set temperature ../econet/rmCurrentDataParamsEdits

Contributing

We welcome contributions to improve the ecoNET300 integration! Please follow these steps to ensure your contributions align with Home Assistant's development guidelines:

  1. Familiarize yourself with the Home Assistant Contribution Guidelines.
  2. Fork this repository and create a new branch for your changes.
  3. Write code that follows Home Assistant's Coding Standards.
  4. Update documentation to reflect any changes or new functionality.
  5. Open a pull request with a clear description of your changes and reference any related issues.

Thank you for contributing to the Home Assistant community!

Acknowledgments:

Disclaimer

Use at your own risk.
This software is provided as-is, for educational purposes. The authors and contributors hold no responsibility for any harm, data loss, or damage caused by using this integration.