Deployed f3f3e12 with MkDocs version: 1.6.1

blueprints/index.html

@@ -606,6 +606,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#weather" class="md-nav__link">
+    <span class="md-ellipsis">
+      Weather
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -746,6 +755,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#weather" class="md-nav__link">
+    <span class="md-ellipsis">
+      Weather
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -804,6 +822,9 @@ <h3 id="octopus-energy-and-carbon-intensity">Octopus Energy and Carbon Intensity
 <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="weather">Weather<a class="headerlink" href="#weather" 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_weather.yaml">Install blueprint</a> | <a href="target_timeframes_weather.yaml">Source</a></p>
+<p>This blueprint will provide the data source based on the forecast of the provide weather sensor and will use the specified <code>Forecast attribute</code> as the value for the calculation of the target timeframes. The forecast will be refreshed every 30 minutes.</p>
 
 
 

blueprints/target_timeframes_weather.yaml

@@ -0,0 +1,78 @@
+blueprint:
+  name: Target Timeframes - Weather source
+  description: Configures a target timeframe data source from Weather
+  domain: automation
+  author: BottlecapDave
+  input:
+    target_timeframe_data_source_sensor:
+      name: Target timeframe data source sensor
+      description: The data source sensor which represents the data source to update
+      selector:
+        entity:
+          filter:
+          - domain:
+            - sensor
+            integration: target_timeframes
+          multiple: false
+    weather_sensor:
+      name: Weather sensor
+      description: The weather sensor to get the forecast for.
+      selector:
+        entity:
+          filter:
+          - domain:
+            - weather
+          multiple: false
+    forecast_attribute:
+      name: Forecast attribute
+      description: Type in the name of the desired forecast attribute to use as the value (e.g. "precipitation", "uv_index" or "temperature"). See the metadata of the result for possible options
+      default: "condition"
+      selector:
+        text:
+variables:
+  target_timeframe_data_source_sensor: !input target_timeframe_data_source_sensor
+  weather_sensor: !input weather_sensor
+  forecast_attribute: !input forecast_attribute
+  millisecond_jitter: >
+    {{ range(1, 1000) | random }}
+mode: queued
+max: 4
+triggers:
+- trigger: time_pattern
+  minutes: '/30'
+condition: []
+action:
+# Add a bit of jitter so the API isn't hit at once
+- delay:
+    milliseconds: >
+        {{ millisecond_jitter }}
+- action: weather.get_forecasts
+  target:
+    entity_id: !input weather_sensor
+  data:
+    type: hourly
+  response_variable: weather_forecast
+- variables:
+    data_source_data: >
+      {%- set forecast_items = weather_forecast[weather_sensor]["forecast"] -%}
+      {%- set data = namespace(items=[]) -%}
+      {%- for forecast in forecast_items -%}
+        {%- set start = forecast["datetime"] | as_timestamp | timestamp_utc -%}
+        {%- set end = ((start | as_datetime) + timedelta(minutes=30)) | as_timestamp | timestamp_utc -%}
+        {%- set value = forecast[forecast_attribute] | float -%}
+        {%- set new_item = [{ 'start': start , 'end': end, 'value': value, 'metadata': forecast }] -%}
+        
+        {%- set data.items = data.items + new_item -%}
+
+        {%- set start = end -%}
+        {%- set end = ((start | as_datetime) + timedelta(minutes=30)) | as_timestamp | timestamp_utc -%}
+        {%- set new_item = [{ 'start': start , 'end': end, 'value': value, 'metadata': forecast }] -%}
+        
+        {%- set data.items = data.items + new_item -%}
+      {%- endfor -%}
+      {{ data.items }}
+- action: target_timeframes.update_target_timeframe_data_source
+  data: >
+    {{ { 'data': data_source_data } }}
+  target:
+    entity_id: !input target_timeframe_data_source_sensor

search/search_index.json

@@ -493,6 +493,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#always" class="md-nav__link">
+    <span class="md-ellipsis">
+      Always
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -965,6 +974,15 @@
     </span>
   </a>
 
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#always" class="md-nav__link">
+    <span class="md-ellipsis">
+      Always
+    </span>
+  </a>
+  
 </li>
 
       </ul>
@@ -1169,10 +1187,26 @@ <h4 id="existing-target-values-havent-started-or-finished">Existing target value
 <p>This will only evaluate target times if no target times have been calculated or all existing target times are either in the future or all existing target times are in the past. </p>
 <p>For example, lets say we have a continuous target which looks between <code>00:00</code> and <code>08:00</code> has existing target times from <code>2023-01-02T01:00</code> to <code>2023-01-02T02:00</code>. </p>
 <ul>
-<li>If the current time is <code>2023-01-02T00:59</code>, then the target times will be re-evaluated and might change if the target period (i.e. <code>2023-01-02T00:30</code> to <code>2023-01-02T08:30</code>) has better values than the existing target times (e.g. the external weightings have changed).</li>
+<li>If the current time is <code>2023-01-02T00:59</code>, then the target times will be re-evaluated and might change if the target period (i.e. <code>2023-01-02T00:30</code> to <code>2023-01-02T08:00</code>) has better values than the existing target times (e.g. the external weightings have changed).</li>
 <li>If the current time is <code>2023-01-02T01:00</code>, the the target times will not be re-evaluated because we've entered our current target times, even if the evaluation period has cheaper times. </li>
-<li>If the current time is <code>2023-01-02T02:01</code>, the the target times will be re-evaluated because our existing target times are in the past and will find the best times in the new rolling target period (i.e. <code>2023-01-02T02:00</code> to <code>2023-01-02T10:00</code>). </li>
+<li>If the current time is <code>2023-01-02T02:01</code>, the the target times will be re-evaluated because our existing target times are in the past and will find the best times in the new target period (i.e. <code>2023-01-02T02:00</code> to <code>2023-01-02T08:00</code>). </li>
+</ul>
+<h4 id="always">Always<a class="headerlink" href="#always" title="Permanent link">#</a></h4>
+<p>This will always evaluate the best target times for the target period, even if the sensor is in the middle of an existing target time period.</p>
+<p>For example, lets say we have a continuous target which looks between <code>00:00</code> and <code>08:00</code> and has existing target times from <code>2023-01-02T01:00</code> to <code>2023-01-02T02:00</code>. </p>
+<ul>
+<li>If the current time is <code>2023-01-02T00:59</code>, then the target times will be re-evaluated and might change if the new target period (i.e. <code>2023-01-02T00:30</code> to <code>2023-01-02T08:30</code>) has better times than the existing target times.</li>
+<li>If the current time is <code>2023-01-02T01:31</code>, then the target times will be re-evaluated and might change if the new target period (i.e. <code>2023-01-02T01:30</code> to <code>2023-01-02T08:30</code>) has better times than the existing target times.</li>
+<li>If the current time is <code>2023-01-02T02:01</code>, the the target times will be re-evaluated because our existing target times are in the past and will find the best times in the new target period (i.e. <code>2023-01-02T02:00</code> to <code>2023-01-02T08:00</code>).</li>
 </ul>
+<div class="admonition note">
+<p class="admonition-title">Note</p>
+<p>This is only supported when <a href="#re-evaluate-within-time-frame">Re-evaluate within time frame</a> is enabled, otherwise it will behave the same as the other options.</p>
+</div>
+<div class="admonition warning">
+<p class="admonition-title">Warning</p>
+<p>This setting means that you could end up with the sensor not turning on for the fully requested hours as the target times might be moved ahead half way through the picked times. It also could mean that the sensor doesn't come on at all during the requested look ahead hours (e.g. 8) because the lowest period kept moving back. </p>
+</div>
 <h3 id="offset">Offset<a class="headerlink" href="#offset" title="Permanent link">#</a></h3>
 <p>You may want your target value sensors to turn on a period of time before the optimum discovered period. For example, you may be turning on a robot vacuum cleaner for a 30 minute clean and want it to charge during the optimum period. For this, you'd use the <code>offset</code> field and set it to <code>-00:30:00</code>, which can be both positive and negative and go up to a maximum of 24 hours. This will shift when the sensor turns on relative to the optimum period. For example, if the optimum period is between <code>2023-01-18T10:00</code> and <code>2023-01-18T11:00</code> with an offset of <code>-00:30:00</code>, the sensor will turn on between <code>2023-01-18T09:30</code> and <code>2023-01-18T10:30</code>.</p>
 <h3 id="re-evaluate-within-time-frame">Re-evaluate within time frame<a class="headerlink" href="#re-evaluate-within-time-frame" title="Permanent link">#</a></h3>