blueprint: added blueprint for manual intelligent dispatch refreshes. This is the recommended way of achieving this functionality to ensure all users are not refreshing their data at the same time (1 .5 hours dev time)

Author: BottlecapDave

_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/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