Skip to content

Commit

Permalink
feat(config): Added detail around target rate hours
Browse files Browse the repository at this point in the history
  • Loading branch information
BottlecapDave committed May 1, 2023
1 parent df82983 commit 9b084c9
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 4 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
- [Saving Sessions](#saving-sessions)
- [Target Rates](#target-rates)
- [From and To times](#from-and-to-times)
- [Hours](#hours)
- [Offset](#offset)
- [Rolling Target](#rolling-target)
- [Examples](#examples)
Expand Down Expand Up @@ -132,6 +133,10 @@ If for example you want to look at prices overnight you could set your from time

See the examples below for how this might work.

#### Hours

The hours that you require for the sensor to find. This should be in decimal format and represent 30 minute increments. For example 30 minutes would be `0.5`, 1 hour would be `1` or `1.0`, 1 hour and 30 minutes would be `1.5`, etc.

#### Offset

You may want your target rate 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 `offset` field and set it to `-00:30:00`, 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 `2023-01-18T10:00` and `2023-01-18T11:00` with an offset of `-00:30:00`, the sensor will turn on between `2023-01-18T09:30` and `2023-01-18T10:30`.
Expand Down
8 changes: 4 additions & 4 deletions custom_components/octopus_energy/translations/en.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"description": "Setup a target rate period. Continuous target will find the cheapest continuous period for your target hours. While intermittent will find the cheapest periods with potential gaps, which when combined will meet your target hours.",
"data": {
"entity_id": "The name of your target",
"Hours": "The hours you require.",
"Hours": "The hours you require in decimal format.",
"Type": "The type of target you're after",
"MPAN": "The MPAN number of the meter to apply the target to",
"Start time": "The minimum time to start the device",
Expand All @@ -29,7 +29,7 @@
},
"error": {
"account_not_found": "Account information was not found",
"invalid_target_hours": "Target hours must be in half hour increments.",
"invalid_target_hours": "Target hours must be in half hour increments (e.g. 0.5 = 30 minutes; 1 = 60 minutes).",
"invalid_target_name": "Name must only include lower case alpha characters and underscore (e.g. my_target)",
"invalid_target_time": "Must be in the format HH:MM",
"invalid_offset": "Offset must be in the form of HH:MM:SS with an optional negative symbol"
Expand Down Expand Up @@ -57,7 +57,7 @@
"title": "Update Target Rate",
"description": "Update the settings for your target rate sensor, which can be used to help you save energy and money.",
"data": {
"Hours": "The hours you require.",
"Hours": "The hours you require in decimal format.",
"MPAN": "The MPAN number of the meter to apply the target to",
"Start time": "The minimum time to start the device",
"End time": "The maximum time to stop the device",
Expand All @@ -67,7 +67,7 @@
}
},
"error": {
"invalid_target_hours": "Target hours must be in half hour increments.",
"invalid_target_hours": "Target hours must be in half hour increments (e.g. 0.5 = 30 minutes; 1 = 60 minutes).",
"invalid_target_time": "Must be in the format HH:MM",
"invalid_offset": "Offset must be in the form of HH:MM:SS with an optional negative symbol"
},
Expand Down

0 comments on commit 9b084c9

Please sign in to comment.