Next release (#1222)

Author: BottlecapDave

.cz-config.js

@@ -45,7 +45,7 @@ module.exports = {
     confirmCommit: 'Are you sure you want to proceed with the commit above?',
   },
 
-  allowCustomScopes: false,
+  allowCustomScopes: true,
   allowBreakingChanges: ['feat', 'fix'],
   // skip any questions you want
   skipQuestions: ['body'],

_docs/blueprints/octopus_energy_octoplus_join_saving_session.yml

@@ -14,15 +14,28 @@ blueprint:
             - event
             integration: octopus_energy
           multiple: false
+    minimum_awarded_points:
+      name: Minimum awarded points
+      description: The minimum number of points that should be awarded by the event per kWh in order to join the event
+      default: 0
+      selector:
+        number:
+          mode: box
+          step: 1.0
 mode: single
 variables:
   saving_session_event_entity: !input saving_session_event_entity
+  minimum_awarded_points: !input minimum_awarded_points
 trigger:
 - platform: state
   entity_id: !input saving_session_event_entity
 condition:
 - condition: template
   value_template: "{{ state_attr(saving_session_event_entity, 'available_events') != None and state_attr(saving_session_event_entity, 'available_events') | length > 0 }}"
+- condition: template
+  value_template: >
+    {% set available_events = state_attr(saving_session_event_entity, 'available_events') %}
+    {{ available_events != None and available_events | length > 0 and available_events[0]['octopoints_per_kwh'] >= minimum_awarded_points }}
 action:
 - service: octopus_energy.join_octoplus_saving_session_event
   data:

_docs/blueprints/octopus_energy_octoplus_join_saving_session_custom_action.yml

@@ -19,9 +19,18 @@ blueprint:
       description: Notifications or similar to be run. {{message}} is an example message
       selector:
         action: {}
+    minimum_awarded_points:
+      name: Minimum awarded points
+      description: The minimum number of points that should be awarded by the event per kWh in order to join the event
+      default: 0
+      selector:
+        number:
+          mode: box
+          step: 1.0
 mode: single
 variables:
   saving_session_event_entity: !input saving_session_event_entity
+  minimum_awarded_points: !input minimum_awarded_points
   message: >
     {% if state_attr(saving_session_event_entity, 'available_events') != None and state_attr(saving_session_event_entity, 'available_events') | length > 0 %}
       {% set event = state_attr(saving_session_event_entity, 'available_events')[0] %}
@@ -34,6 +43,10 @@ trigger:
 condition:
 - condition: template
   value_template: "{{ state_attr(saving_session_event_entity, 'available_events') != None and state_attr(saving_session_event_entity, 'available_events') | length > 0 }}"
+- condition: template
+  value_template: >
+    {% set available_events = state_attr(saving_session_event_entity, 'available_events') %}
+    {{ available_events != None and available_events | length > 0 and available_events[0]['octopoints_per_kwh'] >= minimum_awarded_points }}
 action:
 - service: octopus_energy.join_octoplus_saving_session_event
   data:

_docs/events.md

@@ -2,7 +2,9 @@
 
 The following events are raised by the integration. These events power various entities and can also be used within automations.
 
-## Electricity Current Day Rates
+## Rates
+
+### Electricity Current Day Rates
 
 `octopus_energy_electricity_current_day_rates`
 
@@ -18,7 +20,7 @@ This is fired when the current day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -33,7 +35,7 @@ This is fired when the current day rates are updated.
         New rates available for {{ trigger.event.data.mpan }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Electricity Previous Day Rates
+### Electricity Previous Day Rates
 
 `octopus_energy_electricity_previous_day_rates`
 
@@ -49,7 +51,7 @@ This is fired when the previous day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -64,7 +66,7 @@ This is fired when the previous day rates are updated.
         New rates available for {{ trigger.event.data.mpan }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Electricity Next Day Rates
+### Electricity Next Day Rates
 
 `octopus_energy_electricity_next_day_rates`
 
@@ -80,7 +82,7 @@ This is fired when the next day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -95,7 +97,7 @@ This is fired when the next day rates are updated.
         New rates available for {{ trigger.event.data.mpan }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Electricity Previous Consumption Rates
+### Electricity Previous Consumption Rates
 
 `octopus_energy_electricity_previous_consumption_rates`
 
@@ -111,7 +113,7 @@ This is fired when the [previous consumption's](./entities/electricity.md#previo
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -126,7 +128,7 @@ This is fired when the [previous consumption's](./entities/electricity.md#previo
         New rates available for {{ trigger.event.data.mpan }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Gas Current Day Rates
+### Gas Current Day Rates
 
 `octopus_energy_gas_current_day_rates`
 
@@ -142,7 +144,7 @@ This is fired when the current day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -157,7 +159,7 @@ This is fired when the current day rates are updated.
         New rates available for {{ trigger.event.data.mprn }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Gas Previous Day Rates
+### Gas Previous Day Rates
 
 `octopus_energy_gas_previous_day_rates`
 
@@ -173,7 +175,7 @@ This is fired when the previous day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -188,7 +190,7 @@ This is fired when the previous day rates are updated.
         New rates available for {{ trigger.event.data.mprn }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Gas Next Day Rates
+### Gas Next Day Rates
 
 `octopus_energy_gas_next_day_rates`
 
@@ -204,7 +206,7 @@ This is fired when the next day rates are updated.
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -219,7 +221,7 @@ This is fired when the next day rates are updated.
         New rates available for {{ trigger.event.data.mprn }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Gas Previous Consumption Rates
+### Gas Previous Consumption Rates
 
 `octopus_energy_gas_previous_consumption_rates`
 
@@ -235,7 +237,7 @@ This is fired when the [previous consumption's](./entities/gas.md#previous-accum
 | `max_rate` | `float` | The maximum/highest rate in the discovered rates collection |
 | `average_rate` | `float` | The average rate in the discovered rates collection |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -250,7 +252,9 @@ This is fired when the [previous consumption's](./entities/gas.md#previous-accum
         New rates available for {{ trigger.event.data.mprn }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## New Saving Session
+## Octoplus
+
+### New Saving Session
 
 `octopus_energy_new_octoplus_saving_session`
 
@@ -266,7 +270,7 @@ This event is raised when a new saving session is discovered.
 | `event_duration_in_minutes` | `integer` | The duration of the event in minutes |
 | `event_octopoints_per_kwh` | `integer` | The number of octopoints that are awarded per kwh saved during the event |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -281,7 +285,7 @@ This event is raised when a new saving session is discovered.
         New Octopus Energy saving session available. It starts at {{ trigger.event.data["event_start"].strftime('%H:%M') }} on {{ trigger.event.data["event_start"].day }}/{{ trigger.event.data["event_start"].month }} for {{ trigger.event.data["event_duration_in_minutes"] | int }} minutes.
 ```
 
-## All Saving Sessions
+### All Saving Sessions
 
 `octopus_energy_all_octoplus_saving_sessions`
 
@@ -315,7 +319,7 @@ Each joined event item will include the following attributes
 | `octopoints_per_kwh` | `integer` | The number of octopoints that are awarded per kwh saved during the event |
 | `rewarded_octopoints` | `integer` | The total number of octopoints that were awarded (if any or known) |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -330,7 +334,7 @@ Each joined event item will include the following attributes
         Saving session events updated. The latest joined event awarded {{ trigger.event.data.joined_events[0]["rewarded_octopoints"] }}
 ```
 
-## New Free Electricity Session
+### New Free Electricity Session
 
 `octopus_energy_new_octoplus_free_electricity_session`
 
@@ -344,7 +348,7 @@ This event is raised when a new free electricity session is discovered.
 | `event_end` | `datetime` | The date/time the event ends |
 | `event_duration_in_minutes` | `integer` | The duration of the event in minutes |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -359,7 +363,7 @@ This event is raised when a new free electricity session is discovered.
         New Octopus Energy free electricity session available. It starts at {{ trigger.event.data["event_start"].strftime('%H:%M') }} on {{ trigger.event.data["event_start"].day }}/{{ trigger.event.data["event_start"].month }} for {{ trigger.event.data["event_duration_in_minutes"] | int }} minutes.
 ```
 
-## All Free Electricity Sessions
+### All Free Electricity Sessions
 
 `octopus_energy_all_octoplus_free_electricity_sessions`
 
@@ -379,7 +383,7 @@ Each event item will include the following attributes
 | `end` | `datetime` | The date/time the event starts |
 | `duration_in_minutes` | `integer` | The duration of the event in minutes |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -394,7 +398,9 @@ Each event item will include the following attributes
         Free electricity session events updated. The latest event is at {{ trigger.event.data.events[-1]["start"] }}
 ```
 
-## Electricity Previous Consumption Tariff Comparison Rates
+## Tariff Comparisons
+
+### Electricity Previous Consumption Tariff Comparison Rates
 
 `octopus_energy_elec_previous_consumption_tariff_comparison_rates`
 
@@ -408,7 +414,7 @@ This is fired when the [tariff comparison](./setup/tariff_comparison.md) rates a
 | `mprn` | `string` | The mprn of the meter associated with these rates |
 | `serial_number` | `string` | The serial number of the meter associated with these rates |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:
@@ -423,7 +429,7 @@ This is fired when the [tariff comparison](./setup/tariff_comparison.md) rates a
         New rates available for {{ trigger.event.data.mprn }}. Starting value is {{ trigger.event.data.rates[0]["value_inc_vat"] }}
 ```
 
-## Gas Previous Consumption Tariff Comparison Rates
+### Gas Previous Consumption Tariff Comparison Rates
 
 `octopus_energy_gas_previous_consumption_tariff_comparison_rates`
 
@@ -437,7 +443,7 @@ This is fired when the [tariff comparison](./setup/tariff_comparison.md) rates a
 | `mprn` | `string` | The mprn of the meter associated with these rates |
 | `serial_number` | `string` | The serial number of the meter associated with these rates |
 
-### Automation Example
+#### Automation Example
 
 ```yaml
 - trigger:

_docs/services.md

@@ -292,7 +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
+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
 
@@ -302,20 +302,22 @@ The below example is how you might refresh the dispatches when you car is plugge
 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"
+  - 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'
+  - condition: state
+    entity_id: binary_sensor.car_is_plugged_in
+    state: on
 actions:
-- action: octopus_energy.refresh_intelligent_dispatches
-  target:
-    entity_id: binary_sensor.octopus_energy_{{ACCOUNT_ID}}_intelligent_dispatching
+  # 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
 ```
 
 ## Miscellaneous
@@ -363,4 +365,4 @@ This automation adds weightings based on the national grids carbon intensity, as
         {% set ns = namespace(list = [])  %}   {%- for a in forecast -%} 
           {%- set ns.list = ns.list + [{ "start": a.from.strftime('%Y-%m-%dT%H:%M:%SZ'), "end": a.to.strftime('%Y-%m-%dT%H:%M:%SZ'), "weighting": a.intensity_forecast | float }] -%} 
         {%- endfor -%} {{ ns.list }}
-```
+```

_docs/setup/tariff_comparison.md

@@ -6,10 +6,19 @@ The tariff comparison allows you to elect a new tariff which will generate some
 
 After you've configured your [account](./account.md), you'll be able to configure tariff comparison sensors. These are configured by adding subsequent instances of the integration going through the [normal flow](https://my.home-assistant.io/redirect/config_flow_start/?domain=octopus_energy), and selecting `Tariff Comparison` in the provided menu.
 
+!!! note
+
+    This will only look and provide data inline with previous consumption data. There are no plans to provide data for any other time frame (e.g. "today"). This is for two reasons.
+
+    1. I personally don't see the point of tracking this information against the current consumption as the value of the data will be larger in scope to just today (e.g. you're probably not going to switch tariffs because this morning is cheaper on another tariff) and while a tariff might be cheaper at one point during the day, it might be more expensive at another point. The value, to me, is in the historic trend of the data and knowing this a few hours early isn't going to save much.
+    
+    2. I only want the integration to retrieve data that is required for functionality to stay in the good books with OE
+
 !!! info
 
     When updating the tariff depending on what previous consumption data is available, it can take up to 24 hours to update the cost. This will be improved in the future.
 
+
 ## Setup
 
 ### Meter