Skip to content

Commit 141ee08

Browse files
committed
docs: Fixed docs
1 parent 28cb4b5 commit 141ee08

File tree

3 files changed

+24
-15
lines changed

3 files changed

+24
-15
lines changed

_docs/services.md

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,24 @@ Updates the source data for a given targetframe period. This will replace any ex
1010

1111
| Attribute | Optional | Description |
1212
| ------------------------ | -------- | --------------------------------------------------------------------------------------------------------------------- |
13-
| `target.entity_id` | `no` | The name of the [](./setup/data_source.md#last-updated) sensor whose configuration is to be updated. |
14-
| `data.target_hours` | `yes` | The optional number of hours the target timeframe sensor should come on during a 24 hour period. Must be divisible by 0.5. |
15-
| `data.target_start_time` | `yes` | The optional time the evaluation period should start. Must be in the format of `HH:MM`. |
16-
| `data.target_end_time` | `yes` | The optional time the evaluation period should end. Must be in the format of `HH:MM`. |
17-
| `data.target_offset` | `yes` | The optional offset to apply to the target timeframe when it starts. Must be in the format `(+/-)HH:MM:SS`. |
18-
| `data.target_minimum_value` | `yes` | The optional minimum timeframe the selected timeframes should not go below. |
19-
| `data.target_maximum_value` | `yes` | The optional maximum timeframe the selected timeframes should not go above. |
20-
| `data.target_weighting` | `yes` | The optional weighting that should be applied to the selected timeframes. |
21-
| `data.persist_changes` | `yes` | Determines if the changes should be persisted to the original configuration or should be temporary and reset upon integration reload. If not supplied, then the changes are temporary |
13+
| `target.entity_id` | `no` | The name of the [data source last updated](./setup/data_source.md#data-source-last-updated) sensor whose underlying data is to be updated. |
14+
| `data.data` | `no` | The collection of data to update the data source with. This will override any previous data. For the target rate sensors to work properly, you should target having data for the whole of yesterday, today and tomorrow (e.g. if today is 2025-01-04, you should aim to have data from 2025-01-03T00:00:00 to 2025-01-06T00:00:00).
15+
16+
The structure of the data should match the following
17+
18+
```
19+
[
20+
{
21+
"start": "2025-01-01T00:00:00Z",
22+
"end": "2025-01-01T00:30:00Z",
23+
"value": 0.1,
24+
"metadata": {
25+
// Any additional metadata that might describe how the value was created
26+
}
27+
},
28+
...
29+
]
30+
```
2231

2332
#### Automations
2433

_docs/setup/rolling_target_timeframe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
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_rate.md)
5+
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)
66

77
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.
88

@@ -42,7 +42,7 @@ This is the number of hours to look ahead for the best time periods. This will i
4242

4343
### Evaluation mode
4444

45-
Because the time frame that is being evaluated is currently moving, you might want to set how/when the target times are evaluated in order to make the selected times more or less dynamic.
45+
Because the time frame that is being evaluated could change at different frequencies depending on the source, you might want to set how/when the target times are evaluated in order to make the selected times more or less dynamic.
4646

4747
#### All existing target timeframes are in the past
4848

@@ -144,4 +144,4 @@ The following attributes are available on each sensor
144144

145145
## Services
146146

147-
There are services available associated with target timeframe sensors. Please review them in the [services doc](../services.md#rolling-target-values).
147+
There are services available associated with target timeframe sensors. Please review them in the [services doc](../services.md#rolling-target-timeframes).

_docs/setup/target_timeframe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

5-
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_value.md)
5+
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)
66

77
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.
88

@@ -52,7 +52,7 @@ For instance if the lowest period is between `2023-01-01T00:30` and `2023-01-01T
5252

5353
### Evaluation mode
5454

55-
Because the time frame that is being evaluated could have external factors change the underlying data (e.g. if you're using [external value weightings](#external-value-weightings)), you might want to set how/when the target times are evaluated in order to make the selected times more or less dynamic.
55+
Because the time frame that is being evaluated could change at different frequencies depending on the source, you might want to set how/when the target times are evaluated in order to make the selected times more or less dynamic.
5656

5757
#### All existing target values are in the past
5858

@@ -157,7 +157,7 @@ The following attributes are available on each sensor
157157

158158
## Services
159159

160-
There are services available associated with target value sensors. Please review them in the [services doc](../services.md#target-values).
160+
There are services available associated with target value sensors. Please review them in the [services doc](../services.md#target-timeframes).
161161

162162
## Examples
163163

0 commit comments

Comments
 (0)