From b5db6053bace6356fb76e860d3b5ba8e2ca3f3d4 Mon Sep 17 00:00:00 2001 From: Julian Pawlowski <75446+jpawlowski@users.noreply.github.com> Date: Fri, 5 Dec 2025 21:44:46 +0000 Subject: [PATCH] docs: Update chart examples and sensors documentation for chart_metadata integration --- docs/user/chart-examples.md | 18 ++++++----------- docs/user/sensors.md | 39 +++++-------------------------------- 2 files changed, 11 insertions(+), 46 deletions(-) diff --git a/docs/user/chart-examples.md b/docs/user/chart-examples.md index c587826..de44701 100644 --- a/docs/user/chart-examples.md +++ b/docs/user/chart-examples.md @@ -152,7 +152,7 @@ Based on **absolute price ranges** (calculated from daily min/max): ## Dynamic Y-Axis Scaling -Rolling window modes (3 & 4) automatically integrate with the `chart_metadata` sensor for optimal visualization: +Rolling window modes (2 & 3) automatically integrate with the `chart_metadata` sensor for optimal visualization: **Without chart_metadata sensor (disabled):** ``` @@ -175,18 +175,12 @@ Rolling window modes (3 & 4) automatically integrate with the `chart_metadata` s 18 28 ct ← Optimal range ``` -**How to enable:** +**Requirements:** -1. Enable `sensor.tibber_home_chart_metadata` in entity settings -2. Add configuration to `configuration.yaml`: - ```yaml - tibber_prices: - chart_metadata_config: - day: rolling_window - minor_currency: true - ``` -3. Restart Home Assistant -4. Rolling window charts automatically use dynamic scaling! +- ✅ The `sensor.tibber_home_chart_metadata` must be **enabled** (it's enabled by default!) +- ✅ That's it! The generated YAML automatically uses the sensor for dynamic scaling + +**Important:** Do NOT disable the `chart_metadata` sensor if you want optimal Y-axis scaling in rolling window modes! **Note:** Fixed day views (`today`, `tomorrow`) use ApexCharts' built-in auto-scaling and don't require the metadata sensor. diff --git a/docs/user/sensors.md b/docs/user/sensors.md index cd8eab2..8055e67 100644 --- a/docs/user/sensors.md +++ b/docs/user/sensors.md @@ -34,16 +34,14 @@ Coming soon... ### Chart Metadata **Entity ID:** `sensor.tibber_home_NAME_chart_metadata` -**Default State:** Disabled (must be manually enabled) -> **✨ New Feature**: This sensor provides dynamic chart configuration metadata for optimal visualization. Perfect for use with ApexCharts cards! +> **✨ New Feature**: This sensor provides dynamic chart configuration metadata for optimal visualization. Perfect for use with the `get_apexcharts_yaml` action! -This diagnostic sensor provides essential chart configuration values as sensor attributes, enabling dynamic Y-axis scaling and optimal chart appearance without manual calculations. +This diagnostic sensor provides essential chart configuration values as sensor attributes, enabling dynamic Y-axis scaling and optimal chart appearance in rolling window modes. **Key Features:** - **Dynamic Y-Axis Bounds**: Automatically calculates optimal `yaxis_min` and `yaxis_max` for your price data -- **Configurable via configuration.yaml**: Set parameters like `day`, `minor_currency`, `resolution` under `tibber_prices.chart_metadata_config` - **Automatic Updates**: Refreshes when price data changes (coordinator updates) - **Lightweight**: Metadata-only mode (no data processing) for fast response - **State Indicator**: Shows `pending` (initialization), `ready` (data available), or `error` (service call failed) @@ -57,38 +55,11 @@ This diagnostic sensor provides essential chart configuration values as sensor a - **`resolution`**: Interval duration in minutes (usually 15) - **`error`**: Error message if service call failed -**Configuration:** +**Usage:** -Add to your `configuration.yaml`: +The `tibber_prices.get_apexcharts_yaml` action **automatically uses this sensor** for dynamic Y-axis scaling in `rolling_window` and `rolling_window_autozoom` modes! No manual configuration needed - just enable the action's result with `config-template-card` and the sensor provides optimal Y-axis bounds automatically. -```yaml -tibber_prices: - chart_metadata_config: - day: today # Options: yesterday, today, tomorrow, rolling_window - minor_currency: true # Use cents/øre instead of EUR/NOK - resolution: quarter_hourly # Default: quarter_hourly -``` - -**Usage with config-template-card:** - -The sensor works seamlessly with `config-template-card` to create dynamic ApexCharts configurations: - -```yaml -type: custom:config-template-card -entities: - - sensor.tibber_home_chart_metadata -card: - type: custom:apexcharts-card - apex_config: - yaxis: - min: ${states['sensor.tibber_home_chart_metadata'].attributes.yaxis_min} - max: ${states['sensor.tibber_home_chart_metadata'].attributes.yaxis_max} - # ... rest of your chart config -``` - -**Integration with get_apexcharts_yaml Service:** - -The `tibber_prices.get_apexcharts_yaml` service **automatically uses this sensor** for dynamic Y-axis scaling in `rolling_window` and `rolling_window_autozoom` modes! See the [Actions Guide](actions.md) for details. +See the **[Chart Examples Guide](chart-examples.md)** for practical examples! ---