Add energy price calendar platform to Teslemetry #145848

Bre77 · 2025-05-29T09:09:08Z

Proposed change

Add calendar entities for energy site tariff schedules, providing:

Buy tariff calendar showing energy purchase pricing periods
Sell tariff calendar showing energy sell-back pricing periods

Features:

Displays current active pricing period
Shows seasonal pricing variations
Handles time-of-use (TOU) periods
Supports midnight crossing periods

This is a carve out from #142894

Type of change

Dependency upgrade
Bugfix (non-breaking change which fixes an issue)
New integration (thank you!)
New feature (which adds functionality to an existing integration)
Deprecation (breaking change to happen in the future)
Breaking change (fix/feature causing existing functionality to break)
Code quality improvements to existing code or addition of tests

Additional information

This PR fixes or closes issue: fixes #
This PR is related to issue:
Link to documentation pull request: Add calendar platform to Teslemetry home-assistant.io#39306
Link to developer documentation pull request:
Link to frontend pull request:

Checklist

The code change is tested and works locally.
Local tests pass. Your PR cannot be merged unless tests pass
There is no commented out code in this PR.
I have followed the development checklist
I have followed the perfect PR recommendations
The code has been formatted using Ruff (ruff format homeassistant tests)
Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Documentation added/updated for www.home-assistant.io

If the code communicates with devices, web services, or third-party tools:

The manifest file has all fields filled out correctly.
Updated and included derived files by running: python3 -m script.hassfest.
New or updated dependencies have been added to requirements_all.txt.
Updated by running python3 -m script.gen_requirements_all.
For the updated dependencies - a link to the changelog, or at minimum a diff between library versions is added to the PR description.

To help with the load of incoming pull requests:

I have reviewed two other open pull requests in this repository.

joostlek · 2025-06-16T21:52:16Z

I am wondering how well a calendar works for this. As in, people generally need this for raw data, while a calendar is used for things that happen during a day

Bre77 · 2025-06-21T09:00:08Z

I am wondering how well a calendar works for this. As in, people generally need this for raw data, while a calendar is used for things that happen during a day

It works very well, it's time based and seasonal data. It lets users see the current value and future values.

joostlek · 2025-06-22T22:17:38Z

Right I agree that it shows, but I would argue that it's not a calendar thing. As in, if I would import this in my calendar app my app would be unusable.

Bre77 · 2025-06-22T23:07:44Z

@joostlek are you saying this should just be a sensor entity with the current price?

joostlek · 2025-06-22T23:35:34Z

And maybe a service with json return for forecasting data. But I'm not sure if my opinion is shared by others so I'm open to other arguments

dgomes · 2025-06-29T09:58:45Z

I'm struggling with a similar use case (sensor vs calendar)

The calendar has the benefit of conveying future information as the sensor will only show current values.

If I want to do an automation that needs to know the future tariff start time and duration the sensor is not enough.

Bre77 · 2025-07-06T01:24:51Z

@joostlek the best case I have, is that a sensor entity will only ever tell you whats happening now, but the calendar entity allows more flexible automations with offsets from the start and end of the segment. https://www.home-assistant.io/integrations/calendar/#automation

The primary usecase I can think of here is that Tesla Powerwalls take a few minutes for certain actions to take effect, so a user may wish to have automations run a few minutes before a certain tarrif period starts or ends.

I fully accept people may never want to see this on a calandar in the UI, but its calendar like data that the Home Assistant calendar platform serves well.

There is a future possibility that I will allow editing through the create and delete event actions.

Bre77 · 2025-07-22T03:34:44Z

@joostlek can I please bump this review.

joostlek · 2025-07-22T10:06:13Z

I will throw this for in the architecture meeting on thursday

Bre77 · 2025-08-10T22:36:27Z

@joostlek did you get an architecture answer on this?

dgomes · 2025-08-19T14:10:57Z

looking into this issue before submitting yet another integration tracking tariff using a calendar entity.

emontnemery · 2025-09-16T13:56:01Z

This was discussed in the architecture meeting, but it was forgotten to update here.

The conclusion was:

We should implement both action responses and a calendar entity, and explore to add it to the energy dashboard

I think it's fine to split that in two PRs: One which adds the calendar (this PR) and one which adds a service returning data.

Bre77 · 2025-09-18T02:19:06Z

Thanks for letting me know @emontnemery, @joostlek does that mean we can push this one through?

homeassistant/components/teslemetry/helpers.py

emontnemery · 2025-09-23T13:08:28Z

homeassistant/components/teslemetry/helpers.py


-def flatten(data: dict[str, Any], parent: str | None = None) -> dict[str, Any]:
+def flatten(
+    data: dict[str, Any], parent: str | None = None, exceptions: list[str] | None = None


Suggested change

data: dict[str, Any], parent: str | None = None, exceptions: list[str] | None = None

data: dict[str, Any], parent: str | None = None, *, exceptions: list[str] | None = None

What does this achieve? Is it simply forcing exceptions (now skip_keys) to be named?

Yes, exactly. It improves readability because it's clearer what the optional passed in list is for

homeassistant/components/teslemetry/helpers.py

homeassistant/components/teslemetry/calendar.py

emontnemery · 2025-09-24T12:15:07Z

@Bre77 please address the review comments and mark the PR ready for review when done

Add calendar entities for energy site tariff schedules, providing: - Buy tariff calendar showing energy purchase pricing periods - Sell tariff calendar showing energy sell-back pricing periods Features: - Displays current active pricing period - Shows seasonal pricing variations - Handles time-of-use (TOU) periods - Supports midnight crossing periods

- Update TeslemetryEnergyInfoCoordinator to preserve tariff structure during flattening - Fix test file to only test energy tariff calendars - Update snapshots for energy price calendar entities

Co-authored-by: Erik Montnemery <[email protected]>

homeassistant/components/teslemetry/calendar.py

emontnemery · 2025-11-03T14:01:01Z

homeassistant/components/teslemetry/calendar.py

+                from_day = period_def.get("fromDayOfWeek", 0)
+                to_day = period_def.get("toDayOfWeek", 6)


Is it correct that the API doesn't always set fromDayOfWeek + toDayOfWeek, and are the defaults correct?

Yes, the data outside of the API is a protobuf, which treats missing values as their defaults, so we have to fill this back in, as the default is the full week.

OK. Can you add a comment in the code then with a reference to where the defaults are defined?

emontnemery · 2025-11-03T14:01:34Z

homeassistant/components/teslemetry/calendar.py

+                from_hour = period_def.get("fromHour", 0) % 24
+                from_minute = period_def.get("fromMinute", 0) % 60
+                to_hour = period_def.get("toHour", 0) % 24
+                to_minute = period_def.get("toMinute", 0) % 60


The defaults here differ from the defaults for weekdays, is that correct?

I dont know what your referring to, this code has no concept of weekdays and weekends, its just start days of week and end days of week.

So for example, the default here is all values as zero, which equals a full day due to the Handle periods that cross midnight logic.

I mean that the default for fromDayOfWeek is 0, which means Monday, and the default for toDayOfWeek is 6 which means Sunday, whereas the defaults for from_hour, from_minute, to_hour, to_minute are all 0 which means midnight.
Hence if nothing is set, the period starts at 00:00 Monday, and ends at 00:00 Sunday, that is, the default period spans 6 full days, not a full week. Is that correct?

emontnemery · 2025-11-03T14:03:14Z

homeassistant/components/teslemetry/calendar.py

+                # Handle periods that cross midnight
+                if end_time <= start_time:
+                    potential_end_time = end_time + timedelta(days=1)
+                    if start_time <= now < potential_end_time:
+                        end_time = potential_end_time
+                    elif (start_time - timedelta(days=1)) <= now < end_time:
+                        start_time -= timedelta(days=1)
+                    else:
+                        continue
+                elif not (start_time <= now < end_time):
+                    continue


Please add test cases which assert the behavior here. It's very easy to mess up, and even if your code is correct now it might break tomorrow if the code is changed.

I am not sure which behavior specifically you are referring to, as this would already be tested with the fixture and snapshot.

There's a single, non-parametrized, test case each to test the state of the calendar entity as well as testing the get_events service.

What I mean is that you should add parametrization or separate test cases testing the different branches to account for crossing midnight, crossing weeks and so on, since that logic is non trivial and very easy to mess up.

emontnemery · 2025-11-03T14:03:53Z

homeassistant/components/teslemetry/calendar.py

+
+        return None  # No active period found for the current time and season
+
+    async def async_get_events(


Same comments as for the event property

I have tried to address feedback in multiple places where I noticed.

home-assistant · 2025-11-03T14:04:13Z

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

home-assistant bot added cla-signed has-tests integration: teslemetry new-feature new-platform by-code-owner Quality Scale: No score labels May 29, 2025

This was referenced May 29, 2025

Add calendar platform to Teslemetry home-assistant/home-assistant.io#39306

Draft

Add calendar platform to Teslemetry home-assistant/home-assistant.io#38523

Closed

Bre77 marked this pull request as draft May 29, 2025 22:09

Bre77 marked this pull request as ready for review May 29, 2025 22:11

Bre77 force-pushed the t-calendar-energy-price branch from cc48592 to 25287fa Compare June 4, 2025 22:20

Bre77 force-pushed the t-calendar-energy-price branch from 25287fa to 56c4bdb Compare June 14, 2025 23:33

Bre77 mentioned this pull request Jun 29, 2025

Add tariff sensors to Teslemetry #147756

Closed

19 tasks

dgomes mentioned this pull request Sep 16, 2025

Add OMIE integration #150399

Draft

18 tasks

Bre77 force-pushed the t-calendar-energy-price branch from 56c4bdb to 45aa5fc Compare September 18, 2025 03:53

emontnemery reviewed Sep 23, 2025

View reviewed changes

emontnemery marked this pull request as draft September 24, 2025 12:14

Bre77 added 5 commits September 27, 2025 08:59

Fix energy price calendar tests and coordinator

1416b3d

- Update TeslemetryEnergyInfoCoordinator to preserve tariff structure during flattening - Fix test file to only test energy tariff calendars - Update snapshots for energy price calendar entities

snapshot

90e7d85

Cleanup

37ed601

Rename exceptions parameter as skip_keys

09c50ce

Bre77 force-pushed the t-calendar-energy-price branch from 45aa5fc to 09c50ce Compare September 26, 2025 23:28

Update homeassistant/components/teslemetry/calendar.py

39c0dbe

Co-authored-by: Erik Montnemery <[email protected]>

Bre77 marked this pull request as ready for review September 27, 2025 07:35

emontnemery requested changes Nov 3, 2025

View reviewed changes

home-assistant bot marked this pull request as draft November 3, 2025 14:04

Bre77 added 2 commits November 4, 2025 08:21

Review feedback 1

6f086ce

Allow day periods to cross week

c905f03

Bre77 requested a review from emontnemery November 3, 2025 23:27

Bre77 marked this pull request as ready for review November 3, 2025 23:28

	data: dict[str, Any], parent: str \| None = None, exceptions: list[str] \| None = None
	data: dict[str, Any], parent: str \| None = None, *, exceptions: list[str] \| None = None

		from_day = period_def.get("fromDayOfWeek", 0)
		to_day = period_def.get("toDayOfWeek", 6)


		return None # No active period found for the current time and season

		async def async_get_events(

Uh oh!

Add energy price calendar platform to Teslemetry #145848

Are you sure you want to change the base?

Add energy price calendar platform to Teslemetry #145848

Uh oh!

Conversation

Bre77 commented May 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Uh oh!

joostlek commented Jun 16, 2025

Uh oh!

Bre77 commented Jun 21, 2025

Uh oh!

joostlek commented Jun 22, 2025

Uh oh!

Bre77 commented Jun 22, 2025

Uh oh!

joostlek commented Jun 22, 2025

Uh oh!

dgomes commented Jun 29, 2025

Uh oh!

Bre77 commented Jul 6, 2025

Uh oh!

Bre77 commented Jul 22, 2025

Uh oh!

joostlek commented Jul 22, 2025

Uh oh!

Bre77 commented Aug 10, 2025

Uh oh!

dgomes commented Aug 19, 2025

Uh oh!

emontnemery commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Bre77 commented Sep 18, 2025

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

emontnemery commented Sep 24, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Bre77 commented May 29, 2025 •

edited

Loading

emontnemery commented Sep 16, 2025 •

edited

Loading