PiotrMachowski / Home-Assistant-custom-components-Tauron-AMIplus

This sensor uses unofficial API to get energy usage and generation data from https://elicznik.tauron-dystrybucja.pl.
MIT License
128 stars 34 forks source link
amiplus custom-component elicznik energy-monitor hacs home-assistant homeassistant integration tauron

HACS Default GitHub Latest Release GitHub All Releases Installations Ko-Fi buycoffee.to PayPal.Me Revolut.Me

Tauron AMIplus sensor

This sensor uses unofficial API to get energy usage and generation data from TAURON eLicznik.

Configuration

Config flow (recommended)

To configure this integration go to: Configuration -> Integrations -> Add integration -> Tauron AMIplus.

You can also use following My Home Assistant link:

Open your Home Assistant instance and start setting up a new integration.

Manual - yaml

Warning: yaml configuration is no longer recommended **Warning:** Not all features are available when using yaml configuration | Key | Type | Required | Default | Description | |-----------------------|----------|----------|------------------|--------------------------------------------------------------------------------| | `name` | `string` | `False` | `Tauron AMIPlus` | Name of sensor | | `username` | `string` | `True` | - | Username used to login at [*eLicznik*](https://elicznik.tauron-dystrybucja.pl) | | `password` | `string` | `True` | - | Password used to login at [*eLicznik*](https://elicznik.tauron-dystrybucja.pl) | | `energy_meter_id` | `string` | `True` | - | ID of energy meter | | `monitored_variables` | `list` | `True` | - | List of variables to monitor | #### Possible monitored conditions | Key | Description | |------------------------------|--------------------------------------------------| | `consumption_reading` | Current consumption reading of a meter | | `consumption_daily` | Daily energy consumption **(for previous day!)** | | `consumption_monthly` | Monthly energy consumption | | `consumption_yearly` | Yearly energy consumption | | `consumption_last_12_months` | Total energy consumption for last 12 months | | `generation_reading` | Current generation reading of a meter | | `generation_daily` | Daily energy generation **(for previous day!)** | | `generation_monthly` | Monthly energy generation | | `generation_yearly` | Yearly energy generation | | `generation_last_12_months` | Total energy generation for last 12 months | | `balanced_daily` | Daily balance **(for previous day!)** | | `balanced_monthly` | Monthly balance | | `balanced_yearly` | Yearly balance | | `balanced_last_12_months` | Balance for last 12 months | #### Example usage ``` sensor: - platform: tauron_amiplus name: Tauron AMIPlus username: !secret tauron_amiplus.username password: !secret tauron_amiplus.password energy_meter_id: !secret tauron_amiplus.energy_meter_id monitored_variables: - consumption_reading - consumption_daily - consumption_monthly - consumption_yearly - consumption_last_12_months - generation_reading - generation_daily - generation_monthly - generation_yearly - generation_last_12_months - balanced_daily - balanced_monthly - balanced_yearly - balanced_last_12_months ```

Installation

Since v2.3.0 this integration requires Home Assistant version 2022.12 or latter
Since v2.4.8 this integration might cause slow starts of Home Assistant

Using HACS (recommended)

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

Manual

Download tauron_amiplus.zip and extract its contents to config/custom_components/tauron_amiplus directory:

mkdir -p custom_components/tauron_amiplus
cd custom_components/tauron_amiplus
wget https://github.com/PiotrMachowski/Home-Assistant-custom-components-Tauron-AMIplus/releases/latest/download/tauron_amiplus.zip
unzip tauron_amiplus.zip
rm tauron_amiplus.zip

Then restart Home Assistant before applying configuration file changes.

FAQ

Support

If you want to support my work with a donation you can use one of the following platforms:

Platform Payment methods Link Comment
Ko-fi
  • PayPal
  • Credit card
  • Buy Me a Coffee at ko-fi.com
  • No fees
  • Single or monthly payment
  • buycoffee.to
  • BLIK
  • Bank transfer
  • Postaw mi kawę na buycoffee.to
    PayPal
  • PayPal
  • PayPal Logo
  • No fees
  • Revolut
  • Revolut
  • Credit Card
  • Revolut
  • No fees