38ce1c4c50
Added optional diagnostic binary sensor that exposes get_chartdata service results as entity attributes for legacy dashboard tools. Key features: - Entity: binary_sensor.tibber_home_NAME_chart_data_export - Configurable via Options Flow Step 7 (YAML parameters) - Calls get_chartdata service with user configuration - Exposes response as attributes for chart cards - Disabled by default (opt-in) - Auto-refreshes on coordinator updates - Manual refresh via homeassistant.update_entity Implementation details: - Added chart_data_export entity description to definitions.py - Implemented state/attribute logic in binary_sensor/core.py - Added YAML configuration schema in schemas.py - Added validation in options_flow.py (Step 7) - Service call validation with detailed error messages - Attribute ordering: metadata first, descriptions next, service data last - Dynamic icon mapping (database-export/database-alert) Translations: - Added chart_data_export_config to all 5 languages - Added Step 7 descriptions with legacy warning - Added invalid_yaml_syntax/invalid_yaml_structure error messages - Added custom_translations for sensor descriptions Documentation: - Added Chart Data Export section to sensors.md - Added comprehensive service guide to services.md - Migration path from sensor to service - Configuration instructions via Options Flow Impact: Provides backward compatibility for dashboard tools that can only read entity attributes (e.g., older ApexCharts versions). New integrations should use tibber_prices.get_chartdata service directly.
3.5 KiB
Sensors
Note: This guide is under construction. For now, please refer to the main README for available sensors.
Tip: Many sensors have dynamic icons and colors! See the Dynamic Icons Guide and Dynamic Icon Colors Guide to enhance your dashboards.
Binary Sensors
Best Price Period & Peak Price Period
These binary sensors indicate when you're in a detected best or peak price period. See the Period Calculation Guide for a detailed explanation of how these periods are calculated and configured.
Quick overview:
- Best Price Period: Turns ON during periods with significantly lower prices than the daily average
- Peak Price Period: Turns ON during periods with significantly higher prices than the daily average
Both sensors include rich attributes with period details, intervals, relaxation status, and more.
Core Price Sensors
Coming soon...
Statistical Sensors
Coming soon...
Rating Sensors
Coming soon...
Diagnostic Sensors
Chart Data Export
Entity ID: binary_sensor.tibber_home_NAME_chart_data_export
Default State: Disabled (must be manually enabled)
⚠️ Legacy Feature: This sensor is maintained for backward compatibility. For new integrations, use the
tibber_prices.get_chartdataservice instead, which offers more flexibility and better performance.
This diagnostic sensor provides cached chart-friendly price data that can be consumed by chart cards (ApexCharts, custom cards, etc.).
Key Features:
- Configurable via Options Flow: Service parameters can be configured through the integration's options menu (Step 7 of 7)
- Automatic Updates: Data refreshes on coordinator updates (every 15 minutes)
- Attribute-Based Output: Chart data is stored in sensor attributes for easy access
Important Notes:
- ⚠️ Disabled by default - must be manually enabled in entity settings
- ⚠️ Consider using the service instead for better control and flexibility
- ⚠️ Configuration updates require HA restart
Attributes:
The sensor exposes a single attribute containing the chart data in your configured format:
data(or custom name): Array of price data points in configured format
Configuration:
To configure the sensor's output format:
- Go to Settings → Devices & Services → Tibber Prices
- Click Configure on your Tibber home
- Navigate through the options wizard to Step 7: Chart Data Export Settings
- Configure output format, filters, field names, and other options
- Save and restart Home Assistant
Available Settings:
See the tibber_prices.get_chartdata service documentation below for a complete list of available parameters. All service parameters can be configured through the options flow.
Example Usage:
# ApexCharts card consuming the sensor
type: custom:apexcharts-card
series:
- entity: binary_sensor.tibber_home_chart_data_export
data_generator: |
return entity.attributes.data;
Migration Path:
If you're currently using this sensor, consider migrating to the service:
# Old approach (sensor)
- service: apexcharts_card.update
data:
entity: binary_sensor.tibber_home_chart_data_export
# New approach (service)
- service: tibber_prices.get_chartdata
data:
entry_id: YOUR_ENTRY_ID
day: ["today", "tomorrow"]
output_format: array_of_objects
response_variable: chart_data