mirror of
https://github.com/jpawlowski/hass.tibber_prices.git
synced 2026-04-09 09:03:40 +00:00
docs: explain how to find the config entry_id
Added a dedicated 'Finding Your Entry ID' section to actions.md explaining the two workflows: dropdown in the Action UI vs. 'Copy Config Entry ID' from the integration's three-dot menu in YAML. Added matching :::info callouts to chart-examples.md and automation-examples.md where entry_id: YOUR_ENTRY_ID appears in code examples, and a new 'Config Entry ID' entry in the glossary. Addresses user confusion reported in GitHub Discussions #94. Impact: Users no longer get stuck on YOUR_ENTRY_ID placeholders. Both GUI and YAML workflows are clearly explained at the point of need.
This commit is contained in:
parent
190c979e9c
commit
d8f005d3bb
4 changed files with 45 additions and 0 deletions
|
|
@ -4,6 +4,30 @@ Home Assistant now surfaces these backend service endpoints as **Actions** in th
|
||||||
|
|
||||||
You can still call them from automations, scripts, and dashboards the same way as before (`service: tibber_prices.get_chartdata`, etc.), just remember that the frontend officially lists them as actions.
|
You can still call them from automations, scripts, and dashboards the same way as before (`service: tibber_prices.get_chartdata`, etc.), just remember that the frontend officially lists them as actions.
|
||||||
|
|
||||||
|
## Finding Your Entry ID
|
||||||
|
|
||||||
|
Every action requires an `entry_id` parameter that tells Home Assistant which Tibber home (integration instance) to use. If you only have one home, there is still exactly one entry ID — you just need to know where to find it.
|
||||||
|
|
||||||
|
### In the Action UI — no lookup needed
|
||||||
|
|
||||||
|
When you use the action through the Home Assistant interface (Developer Tools → Actions, or the Action picker inside the automation / script editor), the `entry_id` field renders as a **dropdown list** showing all your configured Tibber Prices instances. Just select your home from the drop-down and Home Assistant fills in the correct ID automatically. You never have to deal with the raw ID string.
|
||||||
|
|
||||||
|
### In YAML — copy from the integration menu
|
||||||
|
|
||||||
|
When you write YAML directly (automations, scripts, Lovelace dashboard cards), you need the actual ID string. The quickest way to get it:
|
||||||
|
|
||||||
|
1. Go to **Settings → Devices & Services**
|
||||||
|
2. Find the **Tibber Prices** integration card
|
||||||
|
3. Click the **⋮** (three-dot) menu on the card
|
||||||
|
4. Choose **"Copy Config Entry ID"**
|
||||||
|
5. Paste the value wherever you see `YOUR_ENTRY_ID` in the YAML examples
|
||||||
|
|
||||||
|
The ID looks like a long alphanumeric string, for example `01JKPC7AB3EF4GH5IJ6KL7MN8P`.
|
||||||
|
|
||||||
|
:::tip Multiple homes?
|
||||||
|
If you have configured more than one Tibber home, each home has its own entry ID. Repeat the steps above for each integration card to get the individual IDs.
|
||||||
|
:::
|
||||||
|
|
||||||
## Available Actions
|
## Available Actions
|
||||||
|
|
||||||
> **Entity ID tip:** `<home_name>` is a placeholder for your Tibber home display name in Home Assistant. Entity IDs are derived from the displayed name (localized), so the exact slug may differ. Example suffixes below use the English display names (en.json) as a baseline. You can find the real ID in **Settings → Devices & Services → Entities** (or **Developer Tools → States**).
|
> **Entity ID tip:** `<home_name>` is a placeholder for your Tibber home display name in Home Assistant. Entity IDs are derived from the displayed name (localized), so the exact slug may differ. Example suffixes below use the English display names (en.json) as a baseline. You can find the real ID in **Settings → Devices & Services → Entities** (or **Developer Tools → States**).
|
||||||
|
|
|
||||||
|
|
@ -467,6 +467,14 @@ automation:
|
||||||
|
|
||||||
The `tibber_prices.get_apexcharts_yaml` service generates basic ApexCharts card configuration examples for visualizing electricity prices.
|
The `tibber_prices.get_apexcharts_yaml` service generates basic ApexCharts card configuration examples for visualizing electricity prices.
|
||||||
|
|
||||||
|
:::info Finding your Entry ID (`entry_id`)
|
||||||
|
The examples below contain `entry_id: YOUR_ENTRY_ID`. This value identifies which Tibber home (integration instance) the action targets.
|
||||||
|
|
||||||
|
**In the Action UI (Developer Tools → Actions or the automation editor):** The `entry_id` field is a **dropdown** — just select your Tibber home and HA fills in the correct ID automatically.
|
||||||
|
|
||||||
|
**In YAML:** Go to **Settings → Devices & Services**, find the **Tibber Prices** card, open the **⋮** (three-dot) menu, and choose **"Copy Config Entry ID"**. Paste the copied value in place of `YOUR_ENTRY_ID`.
|
||||||
|
:::
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
|
|
||||||
**Required:**
|
**Required:**
|
||||||
|
|
|
||||||
|
|
@ -6,6 +6,14 @@ This guide showcases the different chart configurations available through the `t
|
||||||
|
|
||||||
> **Entity ID tip:** `<home_name>` is a placeholder for your Tibber home display name in Home Assistant. Entity IDs are derived from the displayed name (localized), so the exact slug may differ. Example suffixes below use the English display names (en.json) as a baseline. You can find the real ID in **Settings → Devices & Services → Entities** (or **Developer Tools → States**).
|
> **Entity ID tip:** `<home_name>` is a placeholder for your Tibber home display name in Home Assistant. Entity IDs are derived from the displayed name (localized), so the exact slug may differ. Example suffixes below use the English display names (en.json) as a baseline. You can find the real ID in **Settings → Devices & Services → Entities** (or **Developer Tools → States**).
|
||||||
|
|
||||||
|
:::info Finding your Entry ID (`entry_id`)
|
||||||
|
Every example below contains `entry_id: YOUR_ENTRY_ID`. This value identifies which Tibber home (integration instance) the action targets.
|
||||||
|
|
||||||
|
**In the Action UI (Developer Tools → Actions or the automation editor):** The `entry_id` field is a **dropdown** — just select your Tibber home and HA fills in the correct ID automatically.
|
||||||
|
|
||||||
|
**In YAML:** Go to **Settings → Devices & Services**, find the **Tibber Prices** card, open the **⋮** (three-dot) menu, and choose **"Copy Config Entry ID"**. Paste the copied value in place of `YOUR_ENTRY_ID`.
|
||||||
|
:::
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
|
|
||||||
The integration can generate 4 different chart modes, each optimized for specific use cases:
|
The integration can generate 4 different chart modes, each optimized for specific use cases:
|
||||||
|
|
|
||||||
|
|
@ -24,6 +24,11 @@ Quick reference for terms used throughout the documentation.
|
||||||
|
|
||||||
## C
|
## C
|
||||||
|
|
||||||
|
**Config Entry ID** (also: `entry_id`)
|
||||||
|
: A unique identifier assigned by Home Assistant to each configured integration instance. When this integration is used with multiple Tibber homes, each home gets its own Config Entry ID. All actions (`get_chartdata`, `get_apexcharts_yaml`, etc.) require this value as the `entry_id` parameter so that Home Assistant knows which home to query.
|
||||||
|
- **In the Action UI**: The field appears as a dropdown — select your home and HA fills in the ID automatically.
|
||||||
|
- **In YAML**: Go to **Settings → Devices & Services**, find the **Tibber Prices** card, open the **⋮** menu, and choose **"Copy Config Entry ID"**.
|
||||||
|
|
||||||
**Currency Display Mode**
|
**Currency Display Mode**
|
||||||
: Configurable setting for how prices are shown. Choose base currency (€, kr) or subunit (ct, øre). Smart defaults apply: EUR → subunit, NOK/SEK/DKK → base.
|
: Configurable setting for how prices are shown. Choose base currency (€, kr) or subunit (ct, øre). Smart defaults apply: EUR → subunit, NOK/SEK/DKK → base.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue