Add gas and battery to energy widget

[bgoncal]

AI Policy

• I have read the Open Home Foundation AI Policy.

Select exactly one option that describes AI usage in this contribution:

• I have not used AI for this contribution.
• AI assistance was used for this contribution.
• AI fully generated the code for this contribution, but I've reviewed and understood it before submitting and will respond without AI during review.

Summary

Adds gas and battery to the energy widget, alongside the existing grid and solar figures.

Battery is drawn as its own stacked series on the chart — discharge above the axis, charging below — matching the frontend's energy usage graph. Gas is shown as a figure only, not a chart series, because it is metered in volume as often as in energy; its unit comes from the recorder's statistics metadata. The consumption split is a port of computeConsumptionSingle from the frontend, so energy that charged the battery is not counted as demand. Cost now covers electricity and gas together, like the dashboard's totals row.

Layouts adapt as sources are added, so a home with all four still fits the small card and the lock screen accessories.

Screenshots

Recorded snapshots for every family and configuration, in light and dark, are in Tests/Widgets/__Snapshots__/WidgetsSnapshot.test/ — for example energyWidgetEverySourceSystemMediumSnapshot.{light,dark}.png, energyWidgetEverySourceSystemSmallSnapshot.{light,dark}.png and energyWidgetEverySourceAccessoryRectangularSnapshot.{light,dark}.png.

Link to pull request in Documentation repository

Documentation: home-assistant/companion.home-assistant#

Any other notes

Gas is deliberately kept off the chart to match the dashboard, which gives it a separate card for the same reason.

[Copilot]

Pull request overview

Extends the Energy widget’s data model, timeline provider, and rendering to support battery (charge/discharge stacked above/below axis) and gas (figure + cost contribution, no chart series), aligning behavior and visual stacking with the Home Assistant frontend energy dashboard.

Changes:

• Add battery + gas fields to the widget entry, metrics, and sample/test data; update metric ordering and labels.
• Extend statistics fetching to include battery/gas IDs and fetch recorder metadata/config needed for gas units and combined cost.
• Update HADesignSystem energy widget layouts/chart rendering to handle up to four figures and battery in/out chart layers, with density-based typography.

Reviewed changes

Copilot reviewed 25 out of 99 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
Tests/Widgets/WidgetsSnapshot.test.swift	Adds snapshot coverage for battery/gas scenarios and four-source layouts.
Tests/Widgets/WidgetEnergyMetricTests.swift	Updates expectations for new metric ordering (grid-first) and direction/unit assertions.
Tests/Widgets/WidgetEnergyGasTests.swift	New unit tests covering gas unit handling, ordering, and combined cost behavior.
Tests/Widgets/WidgetEnergyBatteryTests.swift	New unit tests covering battery allocation math, aggregation, and metric behavior.
Sources/Shared/Resources/Swiftgen/Strings.swift	Updates SwiftGen accessors for new/renamed energy widget localization keys.
Sources/Shared/API/WebSocket/Energy/EnergyStatistics.swift	Adds recorder metadata model + request and supports volume-unit conversion for statistics.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyStatView.swift	Introduces density-driven sizing for energy figures and updates preview coverage.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyStatDensity.swift	New density model to scale figure typography/layout as sources increase.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergySmallContentView.swift	Reworks small layout to support crowded 2×2 figure arrangements.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergySampleData.swift	Updates sample stats and adds four-source sample set including battery + gas.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyPalette.swift	Adds battery/gas colors and a generic quantity formatter (non-kWh values).
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyMediumContentView.swift	Adapts medium/large layout for up to four figures and revised cost placement.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyChartView.swift	Adds battery-in/out stacked layers and updates stacking logic for positive/negative flows.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyChartPoint.swift	Extends chart point model and ports frontend allocation logic including battery flows.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyAccessoryRectangularContentView.swift	Adjusts rectangular accessory layout to handle 3–4 figures via columns.
Sources/HADesignSystem/Sources/Widgets/Energy/WidgetEnergyAccessoryCircularContentView.swift	Updates empty-state behavior/icon for circular accessory.
Sources/Extensions/Widgets/Energy/WidgetEnergyStyle.swift	Exposes new palette colors and quantity formatting for gas.
Sources/Extensions/Widgets/Energy/WidgetEnergyMetric.swift	Adds battery/gas metric kinds, ordering, labeling, and design-system model mapping updates.
Sources/Extensions/Widgets/Energy/WidgetEnergyMediumView.swift	Wires showsBattery/cost display rules and adds an every-source preview timeline entry.
Sources/Extensions/Widgets/Energy/WidgetEnergyAccessoryCircularView.swift	Updates documentation to match new “headline series” behavior.
Sources/Extensions/AppIntents/Widget/Energy/WidgetEnergySource.swift	Adds source options for battery/gas and updates inclusion rules.
Sources/Extensions/AppIntents/Widget/Energy/WidgetEnergyEntry.swift	Extends entry with battery/gas totals, live battery power, and updated hasStatistics/net helpers.
Sources/Extensions/AppIntents/Widget/Energy/WidgetEnergyChartSample.swift	Adds battery sample day and extends totals to include battery charge/discharge.
Sources/Extensions/AppIntents/Widget/Energy/WidgetEnergyAppIntentTimelineProvider.swift	Fetches additional stats + metadata/config, aggregates battery/gas totals, and computes combined cost.
Sources/App/Resources/en.lproj/Localizable.strings	Adds/renames English strings for battery/gas and revised electricity/grid labeling.

Suppressed comments (1)

Sources/Extensions/AppIntents/Widget/Energy/WidgetEnergyAppIntentTimelineProvider.swift:313

• costStatIds now iterates over gridSources + gasSources when building the compensation list. If a gas source ever has statCompensation set (or statEnergyTo that maps to a cost sensor), it would be incorrectly treated as export compensation and netted off the bill, even though gas has no export/compensation concept.

Keep gas contributing to cost, but restrict compensation collection to grid sources only.

        for source in gridSources + gasSources {
            if let id = source.statCost ?? source.statEnergyFrom.flatMap({ info?.costSensors[$0] }) {
                cost.append(id)
            }
            if let id = source.statCompensation ?? source.statEnergyTo.flatMap({ info?.costSensors[$0] }) {

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.