Deployed 0d64015 with MkDocs version: 1.6.1

blueprints/index.html

@@ -552,6 +552,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#octopus-energy-and-carbon-intensity" class="md-nav__link">
+    <span class="md-ellipsis">
+      Octopus Energy and Carbon Intensity
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -659,6 +668,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#octopus-energy-and-carbon-intensity" class="md-nav__link">
+    <span class="md-ellipsis">
+      Octopus Energy and Carbon Intensity
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -687,13 +705,29 @@
 <h1 id="blueprints">Blueprints<a class="headerlink" href="#blueprints" title="Permanent link">#</a></h1>
 <p><a href="https://www.home-assistant.io/docs/automation/using_blueprints/">Blueprints</a> are an excellent way to get you up and running with the integration quickly. They can also be used as a guide for setting up new automations which you can tailor to your needs.</p>
 <h2 id="data-sources">Data Sources<a class="headerlink" href="#data-sources" title="Permanent link">#</a></h2>
-<p>The following blueprints can help you configure data sources provided by other integrations</p>
+<p>The following blueprints can help you use data from other integrations as the source of your target timeframes.</p>
 <h3 id="carbon-intensity">Carbon Intensity<a class="headerlink" href="#carbon-intensity" title="Permanent link">#</a></h3>
 <p><a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fbottlecapdave.github.io%2FHomeAssistant-TargetTimeframes%2Fblueprints%2Ftarget_timeframes_carbon_intensity.yaml">Install blueprint</a> | <a href="target_timeframes_carbon_intensity.yaml">Source</a></p>
 <p>This blueprint will provide the data source for the UK Carbon Intensity as provided by the <a href="https://github.com/BottlecapDave/HomeAssistant-CarbonIntensity">Carbon Intensity</a> integration.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This automation will run when any of the underlying entities update. This make take a while initially. If you want the data available immediately, then you'll need to run the automation manually.</p>
+</div>
 <h3 id="octopus-energy">Octopus Energy<a class="headerlink" href="#octopus-energy" title="Permanent link">#</a></h3>
-<p><a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fbottlecapdave.github.io%2FHomeAssistant-TargetTimeframes%2Fblueprints%2Ftarget_timeframes_octopus_energy.yaml">Install blueprint</a> | <a href="target_timeframes_octopus_energy.yaml">Source</a></p>
+<p><a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fbottlecapdave.github.io%2FHomeAssistant-TargetTimeframes%2Fblueprints%2Ftarget_timeframes_octopus_energy.yaml">Install blueprint (No Free Electricity)</a> | <a href="target_timeframes_octopus_energy.yaml">Source</a></p>
+<p><a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fbottlecapdave.github.io%2FHomeAssistant-TargetTimeframes%2Fblueprints%2Ftarget_timeframes_octopus_energy.yaml">Install blueprint (Free Electricity Included)</a> | <a href="target_timeframes_octopus_energy.yaml">Source</a></p>
 <p>This blueprint will provide the data source for Octopus Energy rates as provided by the <a href="https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy">Octopus Energy</a> integration.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This automation will run when any of the underlying entities update. This make take a while initially. If you want the data available immediately, then you'll need to run the automation manually.</p>
+</div>
+<h3 id="octopus-energy-and-carbon-intensity">Octopus Energy and Carbon Intensity<a class="headerlink" href="#octopus-energy-and-carbon-intensity" title="Permanent link">#</a></h3>
+<p><a href="https://my.home-assistant.io/redirect/blueprint_import/?blueprint_url=https%3A%2F%2Fbottlecapdave.github.io%2FHomeAssistant-TargetTimeframes%2Fblueprints%2Ftarget_timeframes_octopus_energy_carbon_intensity.yaml">Install blueprint</a> | <a href="target_timeframes_octopus_energy_carbon_intensity.yaml">Source</a></p>
+<p>This blueprint will provide the data source for Octopus Energy rates as provided by the <a href="https://github.com/BottlecapDave/HomeAssistant-OctopusEnergy">Octopus Energy</a> integration and UK Carbon Intensity as provided by the <a href="https://github.com/BottlecapDave/HomeAssistant-CarbonIntensity">Carbon Intensity</a> integration. It will multiply the OE rate by the carbon intensity, resulting in target timeframes favouring periods with low rates, and then falling back to carbon intensity where rates are the same.</p>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This automation will run when any of the underlying entities update. This make take a while initially. If you want the data available immediately, then you'll need to run the automation manually.</p>
+</div>
 
 
 

blueprints/target_timeframes_carbon_intensity.yaml

@@ -1,6 +1,6 @@
 blueprint:
   name: Target Timeframes - Carbon Intensity source
-  description: Configures a targe timeframe data source from Carbon Intensity
+  description: Configures a target timeframe data source from Carbon Intensity
   domain: automation
   author: BottlecapDave
   input:
@@ -16,7 +16,7 @@ blueprint:
           multiple: false
     carbon_intensity_current_day_rates:
       name: Current day rates
-      description: The current day rates event sensor supplied by Carbon Intensity
+      description: The current day rates event sensor supplied by Carbon Intensity. More information can be found at https://bottlecapdave.github.io/HomeAssistant-CarbonIntensity/entities/#current-day-rates.
       selector:
         entity:
           filter:
@@ -26,7 +26,7 @@ blueprint:
           multiple: false
     carbon_intensity_next_day_rates:
       name: Next day rates
-      description: The next day rates event sensor supplied by Carbon Intensity
+      description: The next day rates event sensor supplied by Carbon Intensity. More information can be found at https://bottlecapdave.github.io/HomeAssistant-CarbonIntensity/entities/#next-day-rates.
       selector:
         entity:
           filter:
@@ -49,20 +49,20 @@ condition: []
 action:
 - action: target_timeframes.update_target_timeframe_data_source
   data: >
-    {% set all_rates = [] %}
-    {% if state_attr(carbon_intensity_current_day_rates, 'rates') != None %}
-    {% set all_rates = all_rates + state_attr(carbon_intensity_current_day_rates, 'rates') %}
-    {% endif %}
-    {% if state_attr(carbon_intensity_next_day_rates, 'rates') != None %}
-    {% set all_rates = all_rates + state_attr(carbon_intensity_next_day_rates, 'rates') %}
-    {% endif %}
-    {% set data = namespace(new_rates=[]) %}
-    {% for rate in all_rates %}
-    {% set start = rate["from"] | as_timestamp | timestamp_utc %}
-    {% set end = rate["to"] | as_timestamp | timestamp_utc %}
-    {% set value = rate["intensity_forecast"] | float %}
-    {% set data.new_rates = data.new_rates + [{ 'start': start , 'end': end, 'value': value, 'metadata': { "generation_mix": rate["generation_mix"] } }] %}
-    {% endfor %}
+    {%- set all_rates = [] -%}
+    {%- if state_attr(carbon_intensity_current_day_rates, 'rates') != None -%}
+      {%- set all_rates = all_rates + state_attr(carbon_intensity_current_day_rates, 'rates') -%}
+    {%- endif -%}
+    {%- if state_attr(carbon_intensity_next_day_rates, 'rates') != None -%}
+      {%- set all_rates = all_rates + state_attr(carbon_intensity_next_day_rates, 'rates') -%}
+    {%- endif -%}
+    {%- set data = namespace(new_rates=[]) -%}
+    {%- for rate in all_rates -%}
+      {%- set start = rate["from"] | as_timestamp | timestamp_utc -%}
+      {%- set end = rate["to"] | as_timestamp | timestamp_utc -%}
+      {%- set value = rate["intensity_forecast"] | float -%}
+      {%- set data.new_rates = data.new_rates + [{ 'start': start , 'end': end, 'value': value, 'metadata': { "generation_mix": rate["generation_mix"] } }] -%}
+    {%- endfor -%}
     {{ { 'data': data.new_rates } | to_json }}
   target:
     entity_id: !input target_timeframe_data_source_sensor

blueprints/target_timeframes_octopus_energy.yaml

@@ -16,7 +16,7 @@ blueprint:
           multiple: false
     octopus_energy_previous_day_rates:
       name: Previous day rates
-      description: The previous day rates event sensor supplied by Octopus Energy
+      description: The previous day rates event sensor supplied by Octopus Energy. More information can be found at https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/entities/electricity/#previous-day-rates.
       selector:
         entity:
           filter:
@@ -26,7 +26,7 @@ blueprint:
           multiple: false
     octopus_energy_current_day_rates:
       name: Current day rates
-      description: The current day rates event sensor supplied by Octopus Energy
+      description: The current day rates event sensor supplied by Octopus Energy. More information can be found at https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/entities/electricity/#current-day-rates.
       selector:
         entity:
           filter:
@@ -36,7 +36,7 @@ blueprint:
           multiple: false
     octopus_energy_next_day_rates:
       name: Next day rates
-      description: The next day rates event sensor supplied by Octopus Energy
+      description: The next day rates event sensor supplied by Octopus Energy. More information can be found at https://bottlecapdave.github.io/HomeAssistant-OctopusEnergy/entities/electricity/#current-day-rates.
       selector:
         entity:
           filter:
@@ -52,6 +52,8 @@ variables:
 mode: queued
 max: 4
 triggers:
+- platform: state
+  entity_id: !input octopus_energy_previous_day_rates
 - platform: state
   entity_id: !input octopus_energy_current_day_rates
 - platform: state
@@ -60,23 +62,27 @@ condition: []
 action:
 - action: target_timeframes.update_target_timeframe_data_source
   data: >
-    {% set all_rates = [] %}
-    {% if state_attr(octopus_energy_previous_day_rates, 'rates') != None %}
-    {% set all_rates = all_rates + state_attr(octopus_energy_previous_day_rates, 'rates') %}
-    {% endif %}
-    {% if state_attr(octopus_energy_current_day_rates, 'rates') != None %}
-    {% set all_rates = all_rates + state_attr(octopus_energy_current_day_rates, 'rates') %}
-    {% endif %}
-    {% if state_attr(octopus_energy_next_day_rates, 'rates') != None %}
-    {% set all_rates = all_rates + state_attr(octopus_energy_next_day_rates, 'rates') %}
-    {% endif %}
-    {% set data = namespace(new_rates=[]) %}
-    {% for rate in all_rates %}
-    {% set start = rate["start"] | as_timestamp | timestamp_utc %}
-    {% set end = rate["end"] | as_timestamp | timestamp_utc %}
-    {% set value = rate["value_inc_vat"] | float %}
-    {% set data.new_rates = data.new_rates + [{ 'start': start , 'end': end, 'value': value, 'metadata': { "is_capped": rate["is_capped"] } }] %}
-    {% endfor %}
+    {%- set all_rates = [] -%}
+    {%- if state_attr(octopus_energy_previous_day_rates, 'rates') != None -%}
+      {%- set all_rates = all_rates + state_attr(octopus_energy_previous_day_rates, 'rates') -%}
+    {%- endif -%}
+    {%- if state_attr(octopus_energy_current_day_rates, 'rates') != None -%}
+      {%- set all_rates = all_rates + state_attr(octopus_energy_current_day_rates, 'rates') -%}
+    {%- endif -%}
+    {%- if state_attr(octopus_energy_next_day_rates, 'rates') != None -%}
+      {%- set all_rates = all_rates + state_attr(octopus_energy_next_day_rates, 'rates') -%}
+    {%- endif -%}
+    {%- set data = namespace(new_rates=[]) -%}
+    {%- for rate in all_rates -%}
+      {%- set start = rate["start"] | as_timestamp | timestamp_utc -%}
+      {%- set end = rate["end"] | as_timestamp | timestamp_utc -%}
+      {%- set value = rate["value_inc_vat"] | float -%}
+
+      {%- set metadata = { "is_capped": rate["is_capped"] } -%}
+      {%- set new_rate = [{ 'start': start , 'end': end, 'value': value, 'metadata': metadata }] -%}
+
+      {%- set data.new_rates = data.new_rates + new_rate -%}
+    {%- endfor -%}
     {{ { 'data': data.new_rates } }}
   target:
     entity_id: !input target_timeframe_data_source_sensor