Skip to content

Commit

Permalink
Update docs for EnergyZero integration (home-assistant#36291)
Browse files Browse the repository at this point in the history
  • Loading branch information
@klaasnicolaas
klaasnicolaas authored Dec 11, 2024
1 parent 7db5c13 commit bdba56d
Showing 1 changed file with 57 additions and 12 deletions.
69 changes: 57 additions & 12 deletions source/_integrations/energyzero.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ ha_platforms:
ha_integration_type: integration
---

The EnergyZero integration integrates the [EnergyZero](https://www.energyzero.nl/) API platform with Home Assistant.
The **EnergyZero** {% term integration %} integrates the [EnergyZero](https://www.energyzero.nl/) API platform with Home Assistant.

The integration makes it possible to retrieve the dynamic energy/gas prices
from EnergyZero in order to gain insight into the price trend of the day and
Expand All @@ -32,6 +32,18 @@ Partners who are a reseller from EnergyZero:

{% include integrations/config_flow.md %}

## Use cases

With the [energy dashboard](/energy) you can use the `current hour` price entity to calculate how much the electricity or gas has cost each hour based on the prices from EnergyZero. Or use one of the actions in combination with a [template sensor](#prices-sensor-with-response-data) to show the prices for the next 24 hours in a chart on your dashboard.

## Data updates

The integration will poll the EnergyZero API every 10 minutes to update the data in Home Assistant.

## Known limitations

The prices retrieved via the API are bare prices including VAT, however an energy company also charges other rates such as **energy tax** and **purchase costs**. The integration has no configuration option to add these values, but you could create a [template sensor](#all-in-price-sensor) for this.

## Sensors

The EnergyZero integration creates a number of sensor entities for both gas and electricity prices.
Expand Down Expand Up @@ -64,12 +76,12 @@ Fetches the gas prices. The `config_entry` value be found using the **Actions**

| Data attribute | Optional | Description | Example |
| -------------- | -------- | ---------------------------------------------------- | -------------------------------- |
| `config_entry` | no | Config entry to use. | 1b4a46c6cba0677bbfb5a8c53e8618b0 |
| `config_entry` | no | Config entry ID to use. | 1b4a46c6cba0677bbfb5a8c53e8618b0 |
| `incl_vat` | no | Defines whether the prices include or exclude VAT. | false |
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |
| `end` | yes | End time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |

### Response data
#### Response data

The response data is a dictionary with the gas timestamps and prices as string and float values.

Expand Down Expand Up @@ -97,14 +109,14 @@ The response data is a dictionary with the gas timestamps and prices as string a

Fetches the energy prices. The `config_entry` value be found using the **Actions** tab in the **Developer Tools**, selecting the desired entity and then switching to YAML.

| Data attribute | Optional | Description | Example |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------- |
| `config_entry` | no | Config entry to use. Can be found using the **Actions** tab in the **Developer Tools** and switching to YAML. | 1b4a46c6cba0677bbfb5a8c53e8618b0 |
| `incl_vat` | no | Defines whether the prices include or exclude VAT. | false |
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |
| `end` | yes | End time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |
| Data attribute | Optional | Description | Example |
| -------------- | -------- | ---------------------------------------------------- | -------------------------------- |
| `config_entry` | no | Config entry ID to use. | 1b4a46c6cba0677bbfb5a8c53e8618b0 |
| `incl_vat` | no | Defines whether the prices include or exclude VAT. | false |
| `start` | yes | Start time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |
| `end` | yes | End time to get prices. Defaults to today 00:00:00 | 2023-01-01 00:00:00 |

### Response data
#### Response data

The response data is a dictionary with the energy timestamps and prices as string and float values.

Expand All @@ -127,9 +139,13 @@ The response data is a dictionary with the energy timestamps and prices as strin

{% endraw %}

### Add response to sensor
## Templates

Create template sensors to display the prices in a chart or to calculate the all-in hour price.

### Prices sensor with response data

The response data can be added to a template sensor:
To use the response data from the actions, you can create a template sensor that updates every hour.

{% raw %}

Expand All @@ -153,3 +169,32 @@ template:
```
{% endraw %}
### All-in price sensor
To calculate the all-in hour price, you can create a template sensor that calculates the price based on the current price, energy tax, and purchase costs.
{% raw %}
```yaml
template:
- sensor:
- name: EnergyZero all-in current price
unique_id: allin_current_price
icon: mdi:cash
unit_of_measurement: "€/kWh"
state_class: measurement
state: >
{% set energy_tax = PUT_HERE_THE_PRICE %}
{% set purch_costs = PUT_HERE_THE_PRICE %}
{% set current_price = states('sensor.energyzero_today_energy_current_hour_price') | float(0) %}
{{ (current_price + energy_tax + purch_costs) | round(2) }}
```
{% endraw %}
## Removing the integration
This integration follows standard integration removal steps. If you also use the template sensors, you need to remove them manually.
{% include integrations/remove_device_service.md %}

0 comments on commit bdba56d

Please sign in to comment.