mirror of https://github.com/jpawlowski/hass.tibber_prices.git synced 2026-03-29 21:03:40 +00:00

Julian Pawlowski ef983d0a99 feat(sensor): migrate chart_data_export from binary_sensor to sensor platform

Migrated chart_data_export from binary_sensor to sensor to enable
compatibility with dashboard integrations (ApexCharts, etc.) that
require sensor entities for data selection.

Changes:
- Moved chart_data_export from binary_sensor/ to sensor/ platform
- Changed from boolean state (ON/OFF) to ENUM states ("pending", "ready", "error")
- Maintained all functionality: service call, attribute structure, caching
- Updated translations in all 5 languages (de, en, nb, nl, sv)
- Updated user documentation (sensors.md, services.md)
- Removed all chart_data_export code from binary_sensor platform

Technical details:
- State: "pending" (before first call), "ready" (data available), "error" (service failed)
- Attributes: timestamp + error (metadata) → descriptions → service response data
- Cache (_chart_data_response) bridges async service call and sync property access
- Service call: Triggered on async_added_to_hass() and async_update()

Impact: Dashboard integrations can now select chart_data_export sensor
in their entity pickers. No breaking changes for existing users - entity ID
changes from binary_sensor.* to sensor.*, but functionality identical.

2025-11-17 04:11:10 +00:00

4.3 KiB

Raw Blame History

Services

This integration provides several services for advanced price data access and manipulation.

Available Services

tibber_prices.get_chartdata

Purpose: Returns electricity price data in chart-friendly formats for visualization and analysis.

Key Features:

Flexible Output Formats: Array of objects or array of arrays
Time Range Selection: Filter by day (yesterday, today, tomorrow)
Price Filtering: Filter by price level or rating
Period Support: Return best/peak price period summaries instead of intervals
Resolution Control: Interval (15-minute) or hourly aggregation
Customizable Field Names: Rename output fields to match your chart library
Currency Control: Major (EUR/NOK) or minor (ct/øre) units

Basic Example:

service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_ENTRY_ID
    day: ["today", "tomorrow"]
    output_format: array_of_objects
response_variable: chart_data

Response Format:

{
    "data": [
        {
            "start_time": "2025-11-17T00:00:00+01:00",
            "price_per_kwh": 0.2534
        },
        {
            "start_time": "2025-11-17T00:15:00+01:00",
            "price_per_kwh": 0.2498
        }
    ]
}

Common Parameters:

Parameter	Description	Default
`entry_id`	Integration entry ID (required)	-
`day`	Days to include: yesterday, today, tomorrow	`["today", "tomorrow"]`
`output_format`	`array_of_objects` or `array_of_arrays`	`array_of_objects`
`resolution`	`interval` (15-min) or `hourly`	`interval`
`minor_currency`	Return prices in ct/øre instead of EUR/NOK	`false`
`round_decimals`	Decimal places (0-10)	4 (major) or 2 (minor)

Period Filter Example:

Get best price periods as summaries instead of intervals:

service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_ENTRY_ID
    period_filter: best_price # or peak_price
    day: ["today", "tomorrow"]
    include_level: true
    include_rating_level: true
response_variable: periods

Advanced Filtering:

service: tibber_prices.get_chartdata
data:
    entry_id: YOUR_ENTRY_ID
    level_filter: ["VERY_CHEAP", "CHEAP"] # Only cheap periods
    rating_level_filter: ["LOW"] # Only low-rated prices
    insert_nulls: segments # Add nulls at segment boundaries

Complete Documentation:

For detailed parameter descriptions, see the service definition in Developer Tools → Services → tibber_prices.get_chartdata or check the inline documentation in the integration's services.yaml file.

tibber_prices.get_apexcharts_yaml

Purpose: Generates complete ApexCharts card YAML configuration for visualizing electricity prices.

Quick Example:

service: tibber_prices.get_apexcharts_yaml
data:
    entry_id: YOUR_ENTRY_ID
response_variable: apexcharts_config

Use the response in Lovelace dashboards by copying the generated YAML.

Documentation: See Developer Tools → Services for parameter details.

tibber_prices.refresh_user_data

Purpose: Forces an immediate refresh of user data (homes, subscriptions) from the Tibber API.

Example:

service: tibber_prices.refresh_user_data
data:
    entry_id: YOUR_ENTRY_ID

Note: User data is cached for 24 hours. Use this service only when you need immediate updates (e.g., after changing Tibber subscriptions).

Migration from Chart Data Export Sensor

If you're currently using the sensor.tibber_home_chart_data_export sensor, consider migrating to tibber_prices.get_chartdata:

Benefits:

No HA restart required for configuration changes
More flexible filtering and formatting options
Better performance (on-demand instead of polling)
Future-proof (active development)

Migration Steps:

Note your current sensor configuration (Step 7 in Options Flow)
Create automation/script using tibber_prices.get_chartdata with same parameters
Test the new approach
Disable the old sensor when satisfied

4.3 KiB Raw Blame History