Skip to content

dominikamann/oekofen-pellematic-compact

Repository files navigation

Ökofen Pellematic Integration for Home Assistant

hacs_badge commit_activity GitHub release (latest by date) downloads dominik support

Home Assistant integration oekofen-pellematic-compact is designed for Ökofen Pellematic Heaters with enabled TCP/JSON-Interface. It communicates locally with the heater. This is not an official integration by Ökofen.

  • 🚀 Automatic entity discovery - All sensors automatically detected from API
  • 🌍 Multilingual support - Names in DE/FR/EN directly from your Ökofen system
  • 🐛 v4.2.10 - Stop flooding the HA log with "Value 00:00-00:00 could not be scaled with factor 1" on newer firmware with GreenMode schedule fields (#184)
  • ⚠️ If your heater’s software version is 3.10 (or similarly old), do NOT install an integration version 4.0.0 or newer. Last working version for this old heater software is https://github.com/dominikamann/oekofen-pellematic-compact/releases/tag/v3.6.6. Update: It now also works in many cases with the latest version. Please try and report issues. Thank you.

grafik

grafik

grafik

Installation

Copy the content of the 'custom_components' folder to your home-assistant folder 'config/custom_components' or install through HACS. After reboot of Home-Assistant, this integration can be configured through the integration setup UI

Click here to install over HACS: Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

grafik

Enable JSON-Interface on your Ökofen Pellematic

Go to your Ökofen Pellematic -> Touchscreen -> Open General Settings -> Network Settings/"IP Config" -> Scroll down -> Activate JSON Interface

IMPORTANT: Do not activate the compatibility mode. This mode is not supported/recommended.

Use the provided URL as HOST in Component-Configuration (http://[ip]:[port]/[password]/all)

Password or url change

If you upgrade your Ökofen Pellematic firmawre or change your password, you can simply change it in the homessistant configuration by :

  • connecting via ssh to your homeassistant : ssh root@homeassistant
  • edit your configuration via : vi /root/config/.storage/core.config_entries
  • search for pellematic configuration and change the url in the "host" key of pellematic configuration
  • restart your homeassistant core

OR

401221389-5b7e7316-5a60-4428-93fd-7f5761fa9ed7

Tips: derived sensors (e.g. gas-equivalent energy)

The integration exposes the raw sensors needed to derive your own values — for example pellet consumption in kg (sensor.pellematic_pe1_storage_fill_today, sensor.pellematic_pe1_storage_fill_yesterday, sensor.pellematic_pe1_l_storage_fill). Anything that's a fixed-constant calculation on top of those (gas-equivalent volume, CO₂ avoided, cost per day, ...) is best done as a Home Assistant Template Helper so you can pick the constants that match your pellet quality and local gas tariff.

Converting kg of pellets to m³ of natural gas (equivalent energy)

  1. Go to Settings → Devices & services → Helpers → Create helper → Template → Template a sensor.
  2. Use the formula below. Adjust the two constants to match your situation:
    • Pellet heating value: ~4.8 kWh/kg for ENplus A1, ~4.6 kWh/kg for ENplus A2
    • Natural gas heating value (Hi): ~10.0 kWh/m³ in most of Europe (check your local supplier)
{% set kg = states('sensor.pellematic_pe1_storage_fill_today') | float(0) %}
{% set pellet_kwh_per_kg = 4.8 %}
{% set gas_kwh_per_m3   = 10.0 %}
{{ (kg * pellet_kwh_per_kg / gas_kwh_per_m3) | round(2) }}

Set unit of measurement to and device class to Gas so the result shows up in the HA Energy dashboard.

Why not ship this as a built-in entity? Pellet energy density varies by grade and natural-gas Wobbe Index varies by country — hard-coding the constants would be wrong for many users. The helper keeps the choice in your hands.

About

A Ökofen Pellematic Integration based on JSON/TCP-Inteface for Home Assistant.

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors