Next release (#1252)

Author: BottlecapDave

.github/ISSUE_TEMPLATE/unknown_intelligent_provider.yml

@@ -4,21 +4,45 @@ labels: ["enhancement"]
 assignees:
   - BottlecapDave
 body:
-  - type: textarea
+  - type: input
     id: provider
     attributes:
       label: Provider name
       description: Please provide the name of the provider as presented in the raised repair notice
     validations:
       required: true
-  - type: checkboxes
-    id: features
+  - type: textarea
+    id: bump_charge
+    attributes:
+      label: Ability to bump charge
+      description: Please provide a screenshot of the feature within the app or type "Not available"
+    validations:
+      required: true
+  - type: textarea
+    id: target_charge
+    attributes:
+      label: Ability to set the charge limit/target
+      description: Please provide a screenshot of the feature within the app or type "Not available"
+    validations:
+      required: true
+  - type: textarea
+    id: target_time
+    attributes:
+      label: Ability to set the time the charge will be at its target for
+      description: Please provide a screenshot of the feature within the app or type "Not available"
+    validations:
+      required: true
+  - type: textarea
+    id: smart_charge
+    attributes:
+      label: Ability to turn smart charge on/off
+      description: Please provide a screenshot of the feature within the app or type "Not available"
+    validations:
+      required: true
+  - type: textarea
+    id: planned_dispatches
     attributes:
-      label: Features
-      description: Please specify the features that are available within the Octopus Energy app for your provider
-      options:
-        - label: Ability to bump charge
-        - label: Ability to set the charge limit/target
-        - label: Ability to set the time the charge will be at its target for
-        - label: Ability to turn smart charge on/off
-        - label: Ability to see planned dispatches
+      label: Ability to see planned dispatches
+      description: Please provide a screenshot of the feature within the app or type "Not available"
+    validations:
+      required: true

.github/workflows/issues.yml

@@ -2,13 +2,15 @@ name: Close inactive issues
 on:
   schedule:
     - cron: "30 1 * * *"
+  workflow_dispatch:
 jobs:
   close-issues:
     if: ${{ github.repository_owner == 'BottlecapDave' }}
     runs-on: ubuntu-latest
     permissions:
       issues: write
       pull-requests: write
+      discussions: write
     steps:
       - uses: actions/stale@v9
         with:
@@ -21,3 +23,10 @@ jobs:
           days-before-pr-close: -1
           exempt-issue-labels: enhancement
           repo-token: ${{ secrets.GITHUB_TOKEN }}
+      - uses: dessant/lock-threads@v5
+        with:
+          issue-inactive-days: '30'
+          issue-comment: 'This issue has been automatically locked due to inactivity for more than 30 days. This is to reduce noise for original parties. Please open a new issue for related bugs.'
+          pr-inactive-days: '30'
+          discussion-inactive-days: '30'
+          log-output: true

_docs/blueprints.md

@@ -70,6 +70,18 @@ This blueprint will fire a configured action when the consumption for the curren
 
     This blueprint requires sensors provided by Octopus Energy Home Mini
 
+## Intelligent
+
+## Manual Intelligent Dispatch Refreshes
+
+[Install blueprint](https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fgithub.com%2FBottlecapDave%2FHomeAssistant-OctopusEnergy%2Fblob%2Fdevelop%2F_docs%2Fblueprints%octopus_energy_manual_intelligent_refresh.yaml) | [Source](./blueprints/octopus_energy_manual_intelligent_refresh.yaml)
+
+This blueprint will fire the [intelligent dispatches service](./services.md#octopus_energyrefresh_intelligent_dispatches) either when a sensor from another integration determines the car has been plugged in (e.g. the plug status from the [MyEnergi integration](https://github.com/CJNE/ha-myenergi)) or when the data is stale and overdue a refresh (in case the dispatch information has changed).
+
+!!! warning
+
+    This blueprint requires you to be on an intelligent tariff and a way to determine that your car is plugged in from another integration.
+
 ## Wheel of Fortune
 
 ### Automatically spin wheel of fortune (single)

_docs/blueprints/octopus_energy_manual_intelligent_refresh.yaml

@@ -0,0 +1,76 @@
+blueprint:
+  name: Octopus Energy - Manual Intelligent Refresh
+  description: Handle the refresh of intelligent dispatches automatically, while refreshing when an external car sensor is plugged in. When automatic, will use normal backoff methods in event of failure.
+  domain: automation
+  author: BottlecapDave
+
+  input:
+    intelligent_dispatches_data_last_retrieved_sensor:
+      name: Intelligent dispatches data last retrieved
+      description: "The sensor that determines when intelligent dispatches data was last retrieved (e.g. sensor.octopus_energy_{{ACCOUNT_ID}}_intelligent_dispatches_data_last_retrieved). More information can be found at https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/entities/diagnostics/#intelligent-dispatches-data-last-retrieved"
+      selector:
+        entity:
+          filter:
+            domain: sensor
+            integration: octopus_energy
+
+    intelligent_dispatches_sensor:
+      name: Intelligent dispatches
+      description: "The sensor that determines if intelligent dispatches is active (e.g. binary_sensor.octopus_energy_{{ACCOUNT_ID}}_intelligent_dispatching)"
+      selector:
+        entity:
+          filter:
+            domain: binary_sensor
+            integration: octopus_energy
+
+    car_plugged_in_sensor:
+      name: Car plugged in sensor (external)
+      description: "The external sensor that determines if the car has been plugged in (e.g. binary_sensor.car_is_plugged_in). This sensor is provided by an integration outside of the Octopus Energy integration."
+      selector:
+        entity:
+          filter:
+            domain:
+            - binary_sensor
+            - sensor
+            - input_boolean
+
+    car_plugged_in_sensor_state:
+      name: Car plugged in sensor expected state
+      description: "The expected state of the external sensor that determines if the car has been plugged in (e.g. 'on')."
+      selector:
+        text:
+
+    actions:
+      name: Actions
+      description: Additional actions to run after refresh
+      default: []
+      selector:
+        action: {}
+
+variables:
+  intelligent_dispatches_sensor: !input intelligent_dispatches_sensor
+  car_plugged_in_sensor: !input car_plugged_in_sensor
+
+mode: queued
+max: 4
+trigger_variables:
+  intelligent_dispatches_data_last_retrieved_sensor: !input intelligent_dispatches_data_last_retrieved_sensor
+triggers:
+  - trigger: state
+    entity_id: !input car_plugged_in_sensor
+    to: !input car_plugged_in_sensor_state
+  - trigger: template
+    value_template: >
+      {{ state_attr(intelligent_dispatches_data_last_retrieved_sensor, 'next_refresh') | as_datetime | as_local < now() }}
+conditions:
+  - condition: state
+    entity_id: !input car_plugged_in_sensor
+    state: !input car_plugged_in_sensor_state
+actions:
+  # Wait 30 seconds to give OE a chance to update the dispatches
+  - delay: 00:00:30
+  - action: octopus_energy.refresh_intelligent_dispatches
+    target:
+      entity_id: !input intelligent_dispatches_sensor
+  - choose: []
+    default: !input actions

_docs/entities/electricity.md

@@ -175,6 +175,8 @@ If you are wishing to use these sensors with the Energy Dashboard, then you can
 
 The total consumption reported by the meter (not other devices e.g. Home Mini) for the previous available full day. If for example data is available up to `01:00` of `2024-09-02`, then this sensor will report the cost between `2024-09-01T00:00:00Z` and `2024-09-02T00:00:00Z`.
 
+Due to limitation of HA entities, the data will be updated as a single record, which means the history of the sensor will not be broken down further than once a day. If you want the cost broken down into hourly chunks, you can use the statistic entities used for the [energy dashboard](../setup/energy_dashboard.md#previous-day-consumption).
+
 !!! info
 
     This retrieves the data reported directly by the meter which is used to calculate your bill. If you have an Octopus Home Mini (or similar), then data reported by this device will not be exposed in this sensor. This is to avoid confusion when comparing the data against your bill and to provide consistency between users with and without an Octopus Home Mini.
@@ -259,7 +261,9 @@ The total consumption reported by the meter for the previous available full day
 
 `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_previous_accumulative_cost`
 
-The total cost for the previous available full day, including the standing charge. If for example data is available up to `01:00` of `2024-09-02`, then this sensor will report the cost between `2024-09-01T00:00:00Z` and `2024-09-02T00:00:00Z`.
+The total cost for the previous available full day, including the standing charge. If for example data is available up to `01:00` of `2024-09-02`, then this sensor will report the cost between `2024-09-01T00:00:00Z` and `2024-09-02T00:00:00Z`. 
+
+Due to limitation of HA entities, the data will be updated as a single record, which means the history of the sensor will not be broken down further than once a day. If you want the cost broken down into hourly chunks, you can use the statistic entities used for the [energy dashboard](../setup/energy_dashboard.md#previous-day-consumption).
 
 !!! info
 

_docs/entities/gas.md

@@ -163,6 +163,8 @@ The total consumption reported by the meter for the previous available full day
 
 If your meter reports in kwh, then this will be an accurate value reported by Octopus, otherwise it will be a calculated/estimated value.
 
+Due to limitation of HA entities, the data will be updated as a single record, which means the history of the sensor will not be broken down further than once a day. If you want the cost broken down into hourly chunks, you can use the statistic entities used for the [energy dashboard](../setup/energy_dashboard.md#previous-day-consumption).
+
 !!! info
 
     This retrieves the data reported directly by the meter which is used to calculate your bill. If you have an Octopus Home Mini (or similar), then data reported by this device will not be exposed in this sensor. This is to avoid confusion when comparing the data against your bill and to provide consistency between users with and without an Octopus Home Mini.
@@ -197,7 +199,9 @@ Each charge item has the following attributes
 
 `sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_previous_accumulative_cost`
 
-The total cost for the previous available full day, including the standing charge.
+The total cost for the previous available full day, including the standing charge. If for example data is available up to `01:00` of `2024-09-02`, then this sensor will report the cost between `2024-09-01T00:00:00Z` and `2024-09-02T00:00:00Z`. 
+
+Due to limitation of HA entities, the data will be updated as a single record, which means the history of the sensor will not be broken down further than once a day. If you want the cost broken down into hourly chunks, you can use the statistic entities used for the [energy dashboard](../setup/energy_dashboard.md#previous-day-consumption).
 
 !!! info
 

_docs/entities/intelligent.md

@@ -30,6 +30,7 @@ This sensor is used to determine if you're currently in a planned dispatch perio
 |-----------|------|-------------|
 | `planned_dispatches` | `array` | An array of the dispatches that are currently planned by Octopus Energy. |
 | `completed_dispatches` | `array` | An array of the dispatches that have been completed by Octopus Energy. This will only store up to the last 3 days worth of completed dispatches. |
+| `started_dispatches` | `array` | An array of the dispatches that have been planned by Octopus Energy and upon API refresh are still planned when the current 30 minute period started and is not in a boosting state. A planned dispatch will be added one 30 minute period at a time. This will only store up to the last 3 days worth of started dispatches. This is used to determine historic off peak rates. For example if you have a planned dispatch of `2025-04-01T10:00:00`-`2025-04-01T11:00:00`, at `2025-04-01T10:01:00` if the planned dispatch is still available the period of `2025-04-01T10:00:00`-`2025-04-01T10:30:00` will be added. |
 | `provider` | `string` | The provider of the intelligent features |
 | `vehicle_battery_size_in_kwh` | `float` | The size of the target vehicle battery in kWh. |
 | `charge_point_power_in_kw` | `float` | The power of the charge point battery in kW. |
@@ -45,9 +46,16 @@ Each item in `planned_dispatch` or `completed_dispatches` have the following att
 | `start` | `datetime` | The start date/time of the dispatch |
 | `end` | `datetime` | The end date/time of the dispatch |
 | `charge_in_kwh` | `float` | The amount to be charged within the dispatch period. |
-| `source` | `string` | Determines what has caused the dispatch to be generated. Will be `smart-charge` or `bump-charge`. |
+| `source` | `string` | Determines what has caused the dispatch to be generated. Will be `smart-charge`, `bump-charge` or None. |
 | `location` | `string` | The location of the smart charge |
 
+Each item in `started_dispatch` have the following attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `start` | `datetime` | The start date/time of the dispatch |
+| `end` | `datetime` | The end date/time of the dispatch |
+
 !!! info
 
     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.

_docs/faq.md

@@ -176,6 +176,12 @@ The first thing to do is make sure the correct tariff has been picked up. This c
 
 If the correct tariff is present, it might be that you're on a tariff that has different rates depending on if you pay by direct debit or not. This can be configured via your [account configuration](./setup/account.md#favour-direct-debit-rates).
 
+## How are costs sensors calculated?
+
+Cost sensors are calculated by multiplying the consumption by the rate for each half hour block, which are then all added together.
+
+Each half hour block has it's consumption rounded to the nearest 0.01kwh before multiplying by the rate, which is rounded to the nearest penny. The rounding method used is rounding half to even, where numbers ending in 5 are rounded up or down, towards the nearest even hundredth decimal place. As a result, 0.015 would be rounded up to 0.02, while 0.025 is rounded down to 0.02. This is based on [Octopus Energy API documentation](https://developer.octopus.energy/rest/guides/endpoints)
+
 ## Do you support older versions of the integration?
 
 Due to time constraints, I will only ever support the latest version of the integration. If you have an issue with an older version of the integration, my initial answer will always be to update to the latest version. This might be different to what HACS is reporting if you are not on the minimum supported Home Assistant version (which is highlighted in each release's changelog). 

_docs/repairs/no_active_tariff.md

@@ -0,0 +1,9 @@
+# Repairs - No active tariff
+
+If you receive this repair notice it means that no active tariff was found for one or more of your meters. There are a few reasons why this might be the case.
+
+1. You are in the middle of switching tariffs. There can sometimes be a gap in your tariff information coming through when your existing tariff ends and your new tariff begins.
+2. You are new to OE and your tariff hasn't begun yet. Once your tariff starts, the integration will pick it up and should start working.
+3. There is a configuration issue with your account. In this scenario, you'll need to contact Octopus Energy support to get this rectified.
+
+All of the above scenarios can be confirmed within your [diagnostic data](../faq.md#ive-been-asked-for-my-meter-information-in-a-bug-request-how-do-i-obtain-this). This will contain your account data including your meters. Under each of your meters, you'll have a list of tariff agreements. For each meter, you should have an agreement with a start date in the past and an end date either in the future or with no end date.

_docs/services.md

@@ -292,33 +292,7 @@ Refreshes intelligent dispatches for a given account.
 
 #### Automation Example
 
-The below example is how you might refresh the dispatches when you car is plugged in, or every 3 minutes when your car is plugged in. Please note that the entity `binary_sensor.car_is_plugged_in` is not provided by the integration and should be replaced by an external source (e.g. the plug status from the [MyEnergi integration](https://github.com/CJNE/ha-myenergi) or a manual input switch that you switch on manually when you plug in your car).
-
-!!! warn
-
-    There is a chance that the automation may fail due to the service call limit when the car is plugged in
-
-```yaml
-mode: single
-alias: Refresh intelligent dispatches
-triggers:
-  - trigger: state
-    entity_id: binary_sensor.car_is_plugged_in
-    to: on
-  # Refresh every 3 minutes in case the schedule has changed
-  - trigger: time_pattern
-    minutes: /3
-conditions:
-  - condition: state
-    entity_id: binary_sensor.car_is_plugged_in
-    state: on
-actions:
-  # Wait 30 seconds to give OE a chance to update the dispatches
-  - delay: 00:00:30
-  - action: octopus_energy.refresh_intelligent_dispatches
-    target:
-      entity_id: binary_sensor.octopus_energy_{{ACCOUNT_ID}}_intelligent_dispatching
-```
+For an automation example, please refer to the available [blueprint](./blueprints.md#manual-intelligent-dispatch-refreshes).
 
 ## Miscellaneous
 
@@ -335,6 +309,14 @@ This service is only available for the following sensors
 - `sensor.octopus_energy_electricity_{{METER_SERIAL_NUMBER}}_{{MPAN_NUMBER}}_previous_accumulative_consumption` (this will populate both consumption and cost)
 - `sensor.octopus_energy_gas_{{METER_SERIAL_NUMBER}}_{{MPRN_NUMBER}}_previous_accumulative_consumption_m3` (this will populate both consumption and cost for both m3 and kwh)
 
+!!! information
+
+    Due to limitations with Home Assistant entities, this service will only refresh data for the associated statistic ids used for the recommended approach in the [energy dashboard](./setup/energy_dashboard.md#previous-day-consumption). This will not update the history of the entities themselves.
+
+!!! warn
+
+    If you are on intelligent, the cost data will not be correct for charges outside of the normal off peak times. This is because this data isn't available.
+
 ### octopus_energy.register_rate_weightings
 
 Allows you to configure weightings against rates at given times using factors external to the integration. These are applied when calculating [target rates](./setup/target_rate.md#external-rate-weightings) or [rolling target rates](./setup/rolling_target_rate.md#external-rate-weightings).