Skip to content

Commit

Permalink
Nordpool doc update (home-assistant#36228)
Browse files Browse the repository at this point in the history
* Update nordpool.markdown

- Use commonly used table format to list the sensors. 
- Elaborate on peak and off-peak timeframe. 
- Add an example of a UI template. 
- Update YAML template to match the UI screenshots (for consistency)
- Add an example of how to use the template sensor in the energy dashboard.

* Apply suggestions from code review

Remove whitespace

Co-authored-by: Klaas Schoute <[email protected]>

* Create test.txt

* Add files via upload

* Add files via upload

* Update nordpool.markdown

do images properly

* Delete source/images/integrations/nordpool/test.txt

file not needed

* Tiny tweaks

---------

Co-authored-by: Klaas Schoute <[email protected]>
Co-authored-by: c0ffeeca7 <[email protected]>
  • Loading branch information
3 people authored Dec 9, 2024
1 parent c9628e1 commit ab864f5
Show file tree
Hide file tree
Showing 5 changed files with 60 additions and 26 deletions.
86 changes: 60 additions & 26 deletions source/_integrations/nordpool.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -39,58 +39,92 @@ Currency:

## Sensors

Each market area will create a device which has the following sensors:
The integration will create entities showing today's energy prices for the configured market area. Only the base energy price is shown. VAT and other additional costs are not included.

### Main sensors

- Current price for the selected area
- Previous price for the selected area
- Next price for the selected area
| Sensor | Type | Description |
| ------------------------- | ----------------- | --------------------------------------------------------------------------------- |
| Current price | [Currency]/kWh | The current (hourly) energy price. |
| Previous price | [Currency]/kWh | The price of the previous hour. |
| Next price | [Currency]/kWh | The price of the next hour. |
| Daily average | [Currency]/kWh | The average of today's energy prices. |

These sensors can be used to calculate your current energy cost, or to help decide whether to charge the battery now or in an hour, etc.
### Peak & off-peak sensors

### Block price sensors
Additional sensors are provided for peak and off-peak blocks.

- Block average
- Block minimum
- Block maximum
- Block start time
- Block end time
- Peak refers to the price of the period from 8am to 8pm.
- Off-peak 1 refers to the price of the time period from midnight to 8am.
- Off-peak 2 refers to the average price of the time period from 8pm to midnight.

<p class='img'>
<img src='/images/integrations/nordpool/nordpool-blocks.png' alt='Time blocks'>
</p>

| Sensor | Type | Description |
| ------------------------------- | ----------------- | --------------------------------------------------------------------------------- |
| [peak/off-peak] highest price | [Currency]/kWh | The hightest hourly price during the given timeframe. |
| [peak/off-peak] lowest price | [Currency]/kWh | The lowest hourly price during the given timeframe. |
| [peak/off-peak] average | [Currency]/kWh | The average price of the given timeframe. |
| [peak/off-peak] time from | Datetime | The start date/time of the given timeframe. |
| [peak/off-peak] time until | Datetime | The end date/time of the given timeframe. |

These sensors show the minimum/maximum and average during certain blocks of the day. More known as off-peak (typically lower price) or peak hours (typically higher price).
The block price sensors are not enabled by default.

### Daily average
### Diagnostic sensors

- Daily average
| Sensor | Type | Description |
| ------------------------- | ----------------- | --------------------------------------------------------------------------------- |
| Currency | [Currency] | The configured currency. |
| Exchange rate | Integer | The exchange rate between the configure currency and Euro's. |
| Last updated | Datetime | The time when the market prices were last updated. |

The daily average sensor is not enabled by default.
## Examples

### Diagnostic sensors
A template sensor to add VAT and fixed cost is useful to get the actual energy cost in the energy dashboard.

### UI Template

- Last updated - indicates when the market price was last updated.
- Currency - The selected currency.
- Exchange rate - EUR is the base currency so will show the exchange rate used on the market place.
Create a helper using the UI.
1. Go to {% my integrations title="**Settings** > **Devices & Services**" %} and at the top, choose the **Helpers** tab.
2. In the bottom right corner, select **Create helper**.
3. Select **Template** and **Template a sensor**.
4. Enter the fields as shown below.

The `Exchange rate` sensor is not enabled by default.
The template below takes the current price attributes, adds 0.1293 EUR as fixed costs and adds 21% VAT.

## Example
<p class='img'>
<img src='/images/integrations/nordpool/nordpool_create_template.png' alt='Screenshot: Create template sensor'>
</p>

A simple template sensor to add VAT and a fixed cost from an `input_number` entity
### YAML Template

A template sensor to add VAT and a fixed cost from an helper entity `input_number.add_fixed_cost`.

{% raw %}

```yaml
template:
- sensor:
- name: "Full SE3 current price"
unit_of_measurement: "SEK/kWh"
- name: "Nordpool"
unit_of_measurement: "EUR/kWh"
state_class: measurement
state: >
{% set cost = states('sensor.nord pool_se3_current_price') | float(0) %}
# create a variable with the current price
{% set cost = states('sensor.nord_pool_nl_current_price') | float(0) %}
# create a variable with the additional fixed cost
{% set add_cost = states('input_number.add_fixed_cost') | float(0) %}
# Add fixed cost to the spot price and add VAT (25%)
# Add cost and additional fixed cost. Add VAT (25%) by multiplying with 1.25 and round to 2 digits:
{{ ((cost + add_cost) * 1.25) | round(2, default=0) }}
```
{% endraw %}
### Energy Dashboard
To use the Nordpool integration in the **Energy** dashboard, when configuring grid consumption and production, use the **Use an entity with current price** option.
<p class='img'>
<img src='/images/integrations/nordpool/nordpool_energy_dashboard.png' alt='Screenshot: Create template sensor'>
</p>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ab864f5

Please sign in to comment.