Merge pull request #3 from BottlecapDave/develop

Next release

Author: BottlecapDave

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -59,15 +59,15 @@ body:
     id: ha-logs
     attributes:
       label: Home Assistant Logs
-      description: Paste any related Home Assistant logs here. Please follow the instructions as outlined in the [FAQ](https://bottlecapdave.github.io/homeassistant-targettimeframes/faq#how-do-i-increase-the-logs-for-the-integration)
+      description: Paste any related Home Assistant logs here. Please follow the instructions as outlined in the [FAQ](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/faq#how-do-i-increase-the-logs-for-the-integration)
     validations:
       required: true
   - type: checkboxes
     id: confirm
     attributes:
       label: Confirmation
       options:
-        - label: I confirm that I cannot find my solution within the [documentation](https://bottlecapdave.github.io/homeassistant-targettimeframes)
+        - label: I confirm that I cannot find my solution within the [documentation](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes)
           required: true
-        - label: I confirm that I cannot find my solution within the [FAQ](https://bottlecapdave.github.io/homeassistant-targettimeframes/faq)
+        - label: I confirm that I cannot find my solution within the [FAQ](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/faq)
           required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -30,6 +30,6 @@ body:
     attributes:
       label: Confirmation
       options:
-        - label: By submitting this feature request, you agree that you have read the [documentation](https://bottlecapdave.github.io/homeassistant-targettimeframes) and confirmed it does not already exist
+        - label: By submitting this feature request, you agree that you have read the [documentation](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes) and confirmed it does not already exist
           required: true
         - label: I am willing/able to help contribute to the solution of this feature

README.md

@@ -29,24 +29,24 @@ To install, place the contents of `custom_components` into the `<config director
 
 ## How to setup
 
-You will initially need to setup one or more [data sources](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/data_source.md). You'll then need to setup one or more [target timeframe](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_timeframe.md) or [rolling target timeframe](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_timeframe.md) sensors.
+You will initially need to setup one or more [data sources](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/data_source). You'll then need to setup one or more [target timeframe](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_timeframe) or [rolling target timeframe](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_timeframe) sensors.
 
 ## Events
 
-This integration raises several events, which can be used for various tasks like automations. For more information, please see the [events docs](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/events.md).
+This integration raises several events, which can be used for various tasks like automations. For more information, please see the [events docs](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/events).
 
 ## Services
 
-This integration includes several services. Please review them in the [services doc](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/services.md).
+This integration includes several services. Please review them in the [services doc](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/services).
 
 ## Blueprints
 
-A selection of [blueprints](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/blueprints.md) are available to help get you up and running quickly with the integration.
+A selection of [blueprints](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/blueprints) are available to help get you up and running quickly with the integration.
 
 ## FAQ
 
-Before raising anything, please read through the [faq](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/faq.md). If you have questions, then you can raise a [discussion](https://github.com/BottlecapDave/homeassistant-targettimeframes/discussions). If you have found a bug or have a feature request please [raise it](https://github.com/BottlecapDave/homeassistant-targettimeframes/issues) using the appropriate report template.
+Before raising anything, please read through the [faq](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/faq). If you have questions, then you can raise a [discussion](https://github.com/BottlecapDave/homeassistant-targettimeframes/discussions). If you have found a bug or have a feature request please [raise it](https://github.com/BottlecapDave/homeassistant-targettimeframes/issues) using the appropriate report template.
 
 ## Sponsorship
 
-Please see the [sponsorship](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/sponsorship.md) page for more information.
+Please see the [sponsorship](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/sponsorship) page for more information.

_docs/repairs/invalid_target_timeframe.md

@@ -0,0 +1,11 @@
+# Repairs - Invalid Target Timeframe
+
+If you receive this error, it means that one or more of your target timeframe sensors have gone into an invalid state. This can happen if more validation has been added, which your target timeframe sensor(s) are in violation of.
+
+To solve this
+
+1. Go to [your integration](https://my.home-assistant.io/redirect/integration/?domain=target_timeframes)
+2. Click configure against the target timeframe sensor that is in violation
+3. Update the config and save your changes
+
+If you are still having issues, feel free to raise a discussion.

_docs/services.md

@@ -25,10 +25,20 @@ The structure of the data should match the following
       // Any additional metadata that might describe how the value was created
     }
   },
+  {
+    "start": "2025-01-01T00:30:00Z",
+    "end": "2025-01-01T01:00:00Z",
+    "value": 0.2,
+    "metadata": {
+      // Any additional metadata that might describe how the value was created
+    }
+  },
   ...
 ]
 ```
 
+Each item within the data must be in thirty minute increments. The minute must be 00 or 30, the second should be zero.
+
 #### Automations
 
 Examples can be found in the [blueprints](./blueprints.md) section for configuring a variety of different data sources.
@@ -94,7 +104,7 @@ actions:
   - action: target_timeframes.update_target_timeframe_config
     data:
       target_hours: >
-        "{{ states('input_number.target_timeframes_target_hours') | string }}"
+        {{ states('input_number.target_timeframes_target_hours') }}
       target_start_time: >
         {{ states('input_text.target_timeframes_target_from') }}
       target_end_time: >
@@ -161,9 +171,9 @@ actions:
   - action: target_timeframes.update_target_timeframe_config
     data:
       target_hours: >
-        "{{ states('input_number.target_timeframes_target_hours') | string }}"
+        {{ states('input_number.target_timeframes_target_hours') }}
       target_look_ahead_hours: >
-        "{{ states('input_number.target_timeframes_rolling_target_look_ahead_hours') | string }}"
+        {{ states('input_number.target_timeframes_rolling_target_look_ahead_hours') }}
       target_offset: >
         {{ states('input_text.target_timeframes_target_offset') }}
     target:

_docs/setup/rolling_target_timeframe.md

@@ -1,12 +1,12 @@
-# Rolling Target timeframe Sensor(s)
+# Rolling Target Timeframe Sensor(s)
 
-After you've configured your [data source](./data_source.md), you'll be able to configure rolling target timeframe sensors. These are configured as sub configuration options associated with your data source. Select `Rolling Target timeframe` from the sub menu.
+After you've configured your [data source](./data_source.md), you'll be able to configure rolling target timeframe sensors. These are configured as sub configuration options associated with your data source. Select `Rolling Target Timeframe` from the sub menu.
 
 These sensors calculate the lowest continuous or intermittent values within the next available `x` hours, where `x` is configurable via the sensor, and turn on when these periods are active. If you are targeting an export meter, then the sensors will calculate the highest continuous or intermittent values within the next available `x` hours and turn on when these periods are active. If you are wanting to evaluate on a fixed basis (e.g. every 24 hours), you might be interested in the [standard target timeframe sensors](./target_timeframe.md)
 
 These sensors can then be used in automations to turn on/off devices that save you (and the planet) energy and money. You can go through this flow as many times as you need rolling target timeframe sensors.
 
-Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_RATE_NAME}}`.
+Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_TIMEFRAME_NAME}}`.
 
 ## Setup
 

_docs/setup/target_timeframe.md

@@ -1,12 +1,12 @@
-# Target Rate Sensor(s)
+# Target Timeframe Sensor(s)
 
 After you've configured your [data source](./data_source.md), you'll be able to configure rolling target timeframe sensors. These are configured as sub configuration options associated with your data source. Select `Target timeframe` from the sub menu.
 
 These sensors calculate the lowest continuous or intermittent values **within a 24 hour period** and turn on when these periods are active. If you are targeting an export meter, then the sensors will calculate the highest continuous or intermittent values **within a 24 hour period** and turn on when these periods are active. If you are wanting to evaluate on a rolling basis, you might be interested in the [rolling target value sensors](./rolling_target_timeframe.md)
 
 These sensors can then be used in automations to turn on/off devices that save you (and the planet) energy and money. You can go through this flow as many times as you need target value sensors.
 
-Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_RATE_NAME}}`.
+Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_TIMEFRAME_NAME}}`.
 
 ## Setup
 

custom_components/target_timeframes/binary_sensor.py

@@ -50,12 +50,12 @@ async def async_setup_entry(hass, entry, async_add_entities):
             vol.All(
               cv.make_entity_service_schema(
                 {
-                  vol.Optional("target_hours"): str,
+                  vol.Optional("target_hours"): vol.Coerce(float),
                   vol.Optional("target_start_time"): str,
                   vol.Optional("target_end_time"): str,
                   vol.Optional("target_offset"): str,
-                  vol.Optional("target_minimum_value"): str,
-                  vol.Optional("target_maximum_value"): str,
+                  vol.Optional("target_minimum_value"): vol.Coerce(float),
+                  vol.Optional("target_maximum_value"): vol.Coerce(float),
                   vol.Optional("target_weighting"): str,
                   vol.Optional("persist_changes"): bool,
                 },
@@ -65,19 +65,19 @@ async def async_setup_entry(hass, entry, async_add_entities):
                 "target_hours", "target_start_time", "target_end_time", "target_offset", "target_minimum_value", "target_maximum_value"
               ),
             ),
-            "async_update_target_rate_config",
+            "async_update_target_timeframe_config",
           )
         else:
           platform.async_register_entity_service(
             "update_rolling_target_timeframe_config",
             vol.All(
               cv.make_entity_service_schema(
                 {
-                  vol.Optional("target_hours"): str,
-                  vol.Optional("target_look_ahead_hours"): str,
+                  vol.Optional("target_hours"): vol.Coerce(float),
+                  vol.Optional("target_look_ahead_hours"): vol.Coerce(float),
                   vol.Optional("target_offset"): str,
-                  vol.Optional("target_minimum_value"): str,
-                  vol.Optional("target_maximum_value"): str,
+                  vol.Optional("target_minimum_value"): vol.Coerce(float),
+                  vol.Optional("target_maximum_value"): vol.Coerce(float),
                   vol.Optional("target_weighting"): str,
                   vol.Optional("persist_changes"): bool,
                 },
@@ -87,7 +87,7 @@ async def async_setup_entry(hass, entry, async_add_entities):
                 "target_hours", "target_look_ahead_hours", "target_offset", "target_minimum_value", "target_maximum_value"
               ),
             ),
-            "async_update_rolling_target_rate_config",
+            "async_update_rolling_target_timeframe_config",
           )
 
       async_add_entities(entities, config_subentry_id=sub_entry_id)

custom_components/target_timeframes/config/rolling_target_timeframe.py

@@ -26,10 +26,8 @@ async def async_migrate_rolling_target_timeframe_config(version: int, data: {},
 
   return new_data
 
-def merge_rolling_target_rate_config(data: dict, options: dict, updated_config: dict = None):
+def merge_rolling_target_timeframe_config(data: dict, updated_config: dict = None):
   config = dict(data)
-  if options is not None:
-    config.update(options)
 
   if updated_config is not None:
     config.update(updated_config)

custom_components/target_timeframes/config/target_timeframe.py

@@ -32,14 +32,30 @@ async def async_migrate_target_timeframe_config(version: int, data: {}, get_entr
 
   return new_data
 
-def merge_target_timeframe_config(data: dict, options: dict, updated_config: dict = None):
+def merge_target_timeframe_config(data: dict, updated_config: dict = None):
   config = dict(data)
-  if options is not None:
-    config.update(options)
 
   if updated_config is not None:
     config.update(updated_config)
 
+    if CONFIG_TARGET_START_TIME not in updated_config and CONFIG_TARGET_START_TIME in config:
+      config[CONFIG_TARGET_START_TIME] = None
+
+    if CONFIG_TARGET_END_TIME not in updated_config and CONFIG_TARGET_END_TIME in config:
+      config[CONFIG_TARGET_END_TIME] = None
+
+    if CONFIG_TARGET_OFFSET not in updated_config and CONFIG_TARGET_OFFSET in config:
+      config[CONFIG_TARGET_OFFSET] = None
+
+    if CONFIG_TARGET_MIN_VALUE not in updated_config and CONFIG_TARGET_MIN_VALUE in config:
+      config[CONFIG_TARGET_MIN_VALUE] = None
+
+    if CONFIG_TARGET_MAX_VALUE not in updated_config and CONFIG_TARGET_MAX_VALUE in config:
+      config[CONFIG_TARGET_MAX_VALUE] = None
+
+    if CONFIG_TARGET_WEIGHTING not in updated_config and CONFIG_TARGET_WEIGHTING in config:
+      config[CONFIG_TARGET_WEIGHTING] = None
+
   return config
 
 def is_time_frame_long_enough(hours, start_time, end_time):
@@ -54,7 +70,7 @@ def is_time_frame_long_enough(hours, start_time, end_time):
 
   return available_minutes >= target_minutes
 
-def validate_target_rate_config(data):
+def validate_target_timeframe_config(data):
   errors = {}
 
   matches = re.search(REGEX_ENTITY_NAME, data[CONFIG_TARGET_NAME])