Next release (#1524)

Author: BottlecapDave

CHANGELOG.md

@@ -15,11 +15,10 @@
 * Fixed issue where intelligent maximum hourly calls check was being checked when data wasn't due to be refreshed ([fd74794](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/fd74794d508548f071d1ceb1f16065cbdb020103))
 * Fixed issue where off peak rates flipped when multiple dispatch sources exist where one source is active and one isn't (1 hour dev time) ([72c2965](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/72c29651bf421a5934f02c988aadc0e865e1f91d))
 * Fixed repair issues to obfuscate PII information from the key (1.5 hours dev time) ([13d2f42](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/13d2f42e8903030931aca4a0fd1e8c634c8a5c82))
-* Incorrect number of arguments to async_create_issue ([0ad38cf](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/0ad38cfba6a2d89a552085432302136b7689fd6d)), closes [#1479](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/issues/1479)
+* Incorrect number of arguments to async_create_issue ([0ad38cf](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/0ad38cfba6a2d89a552085432302136b7689fd6d)), closes [#1479](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/issues/1479) (Thanks @TCWORLD)
 * Updated cost trackers to handle entities with non-string unique_ids (Thanks [@dpwood](https://github.com/dpwood)) ([5c32d16](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/5c32d16ca0084dc76da363bba7d8e16340454787))
 * Updated heat pump water heater to use valid state to represent 'on' (30 minutes dev time) ([ae0b73d](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/ae0b73d839d348b96657f63e1ae10e01c591b577))
-* Updated minimum hacs version to 2025.1 ([fa77457](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/fa774577007ee17df21ac488a6679b9f46bbe3b3))
-* Updated minimum hacs version to 2025.1 ([#1465](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/issues/1465)) ([39b9032](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/39b90320eedb1edf164919ae6bf6820cfe1e4c73))
+* Updated minimum hacs version to 2025.1 (Thanks @johncuthbertuk) ([fa77457](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/fa774577007ee17df21ac488a6679b9f46bbe3b3))
 
 
 ### Features
@@ -32,7 +31,6 @@
 * Attached intelligent diagnostic sensors to intelligent device (15 minutes dev time) ([b0ca7d1](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/b0ca7d11c6f76a69921fb5f6b0ad542d6ccf634e))
 * Updated dispatches diagnostics sensor to include maximum_requests_per_hour (15 minutes dev time) ([a48d7ce](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/a48d7cea2f64e73ceb737e58515b81f60e82b1d4))
 * Updated electricity and gas rate sensors to be measurements classes to match rate sensors in other native integrations and provide min/max/average stats (30 minutes dev time) ([4a7305e](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/4a7305e7924ba483357d95ba6e75d3cd053ee7f9))
-* Updated electricity/gas/heat pump/octoplus diagnostic entities so they're attached to the correct devices (1 hour dev time) ([af0c285](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/af0c285675aebd10085f3d65b4f6c4897d9b4f34))
 * Updated electricity/gas/heat pump/octoplus diagnostic entities so they're attached to the correct devices (1 hour dev time) ([#1497](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/issues/1497)) ([2ce05ed](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/2ce05ed738c0ad3c6c71776fd7c1b73058e7de29))
 * Updated off peak sensor to come on when intelligent devices are dispatching (30 minutes dev time) ([18e3eca](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/18e3eca01e21c9d63d0b30b78d01c70807bde5dd))
 * Updated raised errors for heat pump and intelligent controls to be more user friendly (2 hours dev time) ([e60ce63](https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy/commit/e60ce637641dc1d570602aa3121d79b79b69092a))
@@ -46,9 +44,8 @@ peak not turning on when in an ad-hoc off peak period). See
 https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/architecture_decision_records/0002_intelligent_is_dispatching_behaviour_changes
 for full details.
 * Intelligent device related entity ids have been changed from including the account id to including the device id. This is to support multiple EVs as well as other future intelligent devices OE might want to add in the future (e.g. Snug)
-
-is_dispatching entity will now only show when the car is within a scheduled dispatching period. It will no longer turn on when within the standard off peak period. This is because the naming and behaviour was confusing with the name (on when it's not dispatching) and behavior in conjunction with the off peak sensor (off peak not turning on when in an ad-hoc off peak period). See https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/architecture_decision_records/0002_intelligent_is_dispatching_behaviour_changes for full details.
-* If you are using blueprints provided by this integration, you will need to re-import them and potentially update automations in order to continue receiving updates.
+* is_dispatching entity will now only show when the car is within a scheduled dispatching period. It will no longer turn on when within the standard off peak period. This is because the naming and behaviour was confusing with the name (on when it's not dispatching) and behavior in conjunction with the off peak sensor (off peak not turning on when in an ad-hoc off peak period). See https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/architecture_decision_records/0002_intelligent_is_dispatching_behaviour_changes for full details.
+* If you are using blueprints provided by this integration, you will need to re-import them and potentially update automations in order to continue receiving updates. Please note the extensions for blueprints have changed from `.yml` to `.yaml`
 * If you have automations that look at the heat pump water heater, then you'll need to update any reference to the state of 'on' to 'electric'
 * Due to repair issue key structure changing, you may receive repair notices that you have previously ignored. You will need to ignore them again to hide them.
 

_docs/entities/electricity.md

@@ -153,6 +153,10 @@ This is `on` when you're within your tariff's off peak period, and `off` at all
 
     Depending on your [account configuration](../setup/account.md#intelligent-rates-mode), what is determined as an active dispatching period will change. If you have configured to accept [planned or started dispatches](../setup/account.md#planned-and-started-dispatches-will-turn-into-off-peak-rates), then the sensor will turn on when you're are within an active planned or started dispatch period. If you have configured to accept [only started dispatches](../setup/account.md#only-started-dispatches-will-turn-into-off-peak-rates), then the sensor will turn on when you're are within an active started dispatch period, but not planned dispatch.
 
+    This above does not apply and will not come on outside of the standard off peak hours for the following intelligent providers
+
+    * OHME
+
 | Attribute | Type | Description |
 |-----------|------|-------------|
 | `current_start` | `datetime` | The date/time when the off peak rate started |

_docs/entities/intelligent.md

@@ -6,7 +6,7 @@ If you are on the [intelligent tariff](https://octopus.energy/smart/intelligent-
 
     If you switch to the intelligent tariff after you have installed the integration, you will need to reload the integration or restart your Home Assistant instance. You will also need to do this if you re-onboard.
 
-### Is Dispatching
+## Is Dispatching
 
 `binary_sensor.octopus_energy_{{DEVICE_ID}}_intelligent_dispatching`
 
@@ -75,7 +75,7 @@ Each item in `started_dispatch` have the following attributes
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-dispatches-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-### Current State
+## Current State
 
 `sensor.octopus_energy_{{DEVICE_ID}}_intelligent_state`
 
@@ -96,7 +96,7 @@ This sensor displays the current state of your intelligent provider as told by t
 * `LOST_CONNECTION` - lost connection to the device, ready to re-auth (if not temporary / automatic fix).
 * `RETIRED` - / de-authed (re-auth not possible, re-register device to onboard again).
 
-### Bump Charge
+## Bump Charge
 
 `switch.octopus_energy_{{DEVICE_ID}}_intelligent_bump_charge`
 
@@ -112,7 +112,7 @@ This sensor is used to turn on/off bump ("on-demand") charging for a **single**
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-### Smart Charge
+## Smart Charge
 
 `switch.octopus_energy_{{DEVICE_ID}}_intelligent_smart_charge`
 
@@ -128,7 +128,7 @@ This sensor is used to turn on/off intelligent smart charging for a **single** i
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-### Charge Target
+## Charge Target
 
 `number.octopus_energy_{{DEVICE_ID}}_intelligent_charge_target`
 
@@ -144,7 +144,7 @@ This sensor is used to see and set the charge target for your future intelligent
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-### Target Time (Select)
+## Target Time (Select)
 
 `select.octopus_energy_{{DEVICE_ID}}_intelligent_target_time`
 
@@ -166,7 +166,7 @@ This is limited to 30 minute increments between 4 and 11 to match the Octopus En
 |-----------|------|-------------|
 | `raw_value` | `time` | The raw target time. This is useful if the time is set to a value outside of the range available in the select options (e.g. from another integration) |
 
-### Target Time (Time)
+## Target Time (Time)
 
 `time.octopus_energy_{{DEVICE_ID}}_intelligent_target_time`
 
@@ -192,11 +192,11 @@ This gives you finer control over the times (still within valid time periods), b
 If you're moving to this integration from [megakid/ha_octopus_intelligent](https://github.com/megakid/ha_octopus_intelligent), below is a quick guide on what entities you should use
 
 * `binary_sensor.octopus_intelligent_slot` - Use the [off peak sensor](./electricity.md#off-peak)
-* `binary_sensor.octopus_intelligent_planned_dispatch_slot` - There is no alternative for this.
+* `binary_sensor.octopus_intelligent_planned_dispatch_slot` - Use the [is dispatching sensor](#is-dispatching)
 * `binary_sensor.octopus_intelligent_slot_next_1_hour`, `binary_sensor.octopus_intelligent_slot_next_2_hours` and `binary_sensor.octopus_intelligent_slot_next_3_hours` - These sensors felt like they would always fall short of peoples requirements as everyone has different time periods they wish to know about. The [off peak sensor](./electricity.md#off-peak) exposes the current and next start/end times which could be used in a template sensor to determine how long the rate is cheap for when on. Or the [target rate](../setup/target_rate.md) or [rolling target rate](../setup/rolling_target_rate.md) might help for what you need.
 * `sensor.octopus_intelligent_next_offpeak_start` - The default off peak start date/time can be found as an attribute on the [off peak sensor](./electricity.md#off-peak). This can be extracted using a [template sensor](https://www.home-assistant.io/integrations/template/).
 * `sensor.octopus_intelligent_offpeak_end` - The default off peak end date/time can be found as an attribute on the [off peak sensor](./electricity.md#off-peak). This can be extracted using a [template sensor](https://www.home-assistant.io/integrations/template/).
 * `switch.octopus_intelligent_bump_charge` - Use the [bump charge sensor](#bump-charge)
 * `switch.octopus_intelligent_smart_charging` - Use the [smart charge sensor](#smart-charge)
 * `select.octopus_intelligent_target_time` - Use the [target time (time) sensor](#target-time-time) or [target time (select) sensor](#target-time-select)
-* `select.octopus_intelligent_target_soc` - Use the [charge target sensor](#charge-target)
+* `select.octopus_intelligent_target_soc` - Use the [charge target sensor](#charge-target)

_docs/entities/octoplus.md

@@ -43,15 +43,37 @@ Binary sensor to indicate if a saving session that the account has joined is act
 
 `calendar.octopus_energy_{{ACCOUNT_ID}}_octoplus_saving_sessions`
 
-Calendar sensor to record saving sessions. Will be `on` when a saving session that the account has joined is active. Standard calendar attributes will indicate the current/next saving session.
+Read only [calendar](https://www.home-assistant.io/integrations/calendar) sensor to record saving sessions. Will be `on` when a saving session that the account has joined is active. Calendar events will be automatically added/removed by the integration when joined events are discovered. 
+
+Standard calendar attributes will indicate the current/next saving session.
+
+!!! warning
+
+    The sensor does not store past events indefinitely. Past events could be removed without notice.
 
 !!! info
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#saving-sessions-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
-!!! note
-
-    The events are supplied by OE API and does not store past events indefinitely. Past events could be removed without notice.
+### Automation Example
+
+Below is an example of raising a persistent notification 5 minutes before a saving session starts.
+
+```yaml
+triggers:
+- trigger: calendar
+  entity_id: calendar.octopus_energy_{{ACCOUNT_ID}}_octoplus_saving_sessions
+  event: start
+  offset: -00:05:00
+actions:
+- action: persistent_notification.create
+  data:
+    title: Saving Session Starting
+    message: >
+      {% set minutes = ((state_attr(trigger.entity_id, 'end_time') | as_datetime - state_attr(trigger.entity_id, 'start_time') | as_datetime).seconds / 60) | round(0) | string %}
+      {% set start_time = (state_attr(trigger.entity_id, 'start_time') | as_datetime).strftime('%H:%M') %}
+      Saving session starts at {{ start_time }} for {{ minutes }} minutes.
+```
 
 ## Saving Session Events
 
@@ -170,7 +192,13 @@ Binary sensor to indicate if a free electricity session is active.
 
 `calendar.octopus_energy_{{ACCOUNT_ID}}_octoplus_free_electricity_session`
 
-Calendar sensor to record free electricity sessions. Will be `on` when a free electricity session is active. Standard calendar attributes will indicate the current/next saving session.
+Read only [calendar](https://www.home-assistant.io/integrations/calendar) sensor to record free electricity sessions. Will be `on` when a free electricity session is active. Calendar events will be automatically added/removed by the integration when events are discovered.
+
+Standard calendar attributes will indicate the current/next saving session.
+
+!!! warning
+
+    The sensor does not store past events indefinitely. Past events could be removed without notice.
 
 !!! note
     This will only be available if you have enrolled into Octoplus. Once enrolled, reload the integration to gain access to this sensor. This is only applicable if you have signed up to [free electricity sessions](https://octopus.energy/free-electricity/). This sensor uses public information supplied by https://github.com/BottlecapDave/OctopusEnergyApi.
@@ -182,6 +210,26 @@ Calendar sensor to record free electricity sessions. Will be `on` when a free el
 
     You can use the [data_last_retrieved sensor](./diagnostics.md#free-electricity-sessions-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
 
+### Automation Example
+
+Below is an example of raising a persistent notification 5 minutes before a free electricity session starts.
+
+```yaml
+triggers:
+- trigger: calendar
+  entity_id: calendar.octopus_energy_{{ACCOUNT_ID}}_octoplus_free_electricity_session
+  event: start
+  offset: -00:05:00
+actions:
+- action: persistent_notification.create
+  data:
+    title: Free Electricity Session Starting
+    message: >
+      {% set minutes = ((state_attr(trigger.entity_id, 'end_time') | as_datetime - state_attr(trigger.entity_id, 'start_time') | as_datetime).seconds / 60) | round(0) | string %}
+      {% set start_time = (state_attr(trigger.entity_id, 'start_time') | as_datetime).strftime('%H:%M') %}
+      Free electricity session starts at {{ start_time }} for {{ minutes }} minutes.
+```
+
 ## Free Electricity Session Events
 
 `event.octopus_energy_{{ACCOUNT_ID}}_octoplus_free_electricity_session_events`

custom_components/octopus_energy/electricity/current_rate.py

@@ -71,7 +71,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):

custom_components/octopus_energy/electricity/next_rate.py

@@ -58,7 +58,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):

custom_components/octopus_energy/electricity/previous_rate.py

@@ -58,7 +58,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):

custom_components/octopus_energy/gas/current_rate.py

@@ -60,7 +60,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):

custom_components/octopus_energy/gas/next_rate.py

@@ -56,7 +56,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):

custom_components/octopus_energy/gas/previous_rate.py

@@ -56,7 +56,12 @@ def name(self):
   @property
   def state_class(self):
     """The state class of sensor"""
-    return SensorStateClass.MEASUREMENT
+    return SensorStateClass.TOTAL
+
+  @property
+  def device_class(self):
+    """The type of sensor"""
+    return SensorDeviceClass.MONETARY
 
   @property
   def icon(self):