Skip to content

Commit c09d012

Browse files
committed
fix: Fixed documentation references
1 parent e71a958 commit c09d012

File tree

7 files changed

+22
-22
lines changed

7 files changed

+22
-22
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,15 +59,15 @@ body:
5959
id: ha-logs
6060
attributes:
6161
label: Home Assistant Logs
62-
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)
62+
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)
6363
validations:
6464
required: true
6565
- type: checkboxes
6666
id: confirm
6767
attributes:
6868
label: Confirmation
6969
options:
70-
- label: I confirm that I cannot find my solution within the [documentation](https://bottlecapdave.github.io/homeassistant-targettimeframes)
70+
- label: I confirm that I cannot find my solution within the [documentation](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes)
7171
required: true
72-
- label: I confirm that I cannot find my solution within the [FAQ](https://bottlecapdave.github.io/homeassistant-targettimeframes/faq)
72+
- label: I confirm that I cannot find my solution within the [FAQ](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/faq)
7373
required: true

.github/ISSUE_TEMPLATE/feature_request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,6 @@ body:
3030
attributes:
3131
label: Confirmation
3232
options:
33-
- 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
33+
- 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
3434
required: true
3535
- label: I am willing/able to help contribute to the solution of this feature

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,24 @@ To install, place the contents of `custom_components` into the `<config director
2929

3030
## How to setup
3131

32-
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.
32+
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.
3333

3434
## Events
3535

36-
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).
36+
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).
3737

3838
## Services
3939

40-
This integration includes several services. Please review them in the [services doc](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/services.md).
40+
This integration includes several services. Please review them in the [services doc](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/services).
4141

4242
## Blueprints
4343

44-
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.
44+
A selection of [blueprints](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/blueprints) are available to help get you up and running quickly with the integration.
4545

4646
## FAQ
4747

48-
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.
48+
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.
4949

5050
## Sponsorship
5151

52-
Please see the [sponsorship](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/sponsorship.md) page for more information.
52+
Please see the [sponsorship](https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/sponsorship) page for more information.

_docs/setup/rolling_target_timeframe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Rolling Target timeframe Sensor(s)
1+
# Rolling Target Timeframe Sensor(s)
22

3-
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.
3+
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

55
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

9-
Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_RATE_NAME}}`.
9+
Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_TIMEFRAME_NAME}}`.
1010

1111
## Setup
1212

_docs/setup/target_timeframe.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
1-
# Target Rate Sensor(s)
1+
# Target Timeframe Sensor(s)
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

55
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

9-
Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_RATE_NAME}}`.
9+
Each sensor will be in the form `binary_sensor.target_timeframes_{{DATA_SOURCE_ID}}_{{TARGET_TIMEFRAME_NAME}}`.
1010

1111
## Setup
1212

custom_components/target_timeframes/config_flow.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
from homeassistant.config_entries import (ConfigFlow, ConfigEntry, ConfigSubentryFlow, SubentryFlowResult)
33
from homeassistant.core import callback
44

5-
from .config.target_timeframe import validate_target_rate_config
5+
from .config.target_timeframe import validate_target_timeframe_config
66
from .config.rolling_target_timeframe import validate_rolling_target_timeframe_config
77

88
from .const import (
@@ -88,7 +88,7 @@ async def async_step_user(
8888
self, user_input: dict[str, Any] | None = None
8989
) -> SubentryFlowResult:
9090
config = dict(user_input) if user_input is not None else None
91-
errors = validate_target_rate_config(config) if config is not None else {}
91+
errors = validate_target_timeframe_config(config) if config is not None else {}
9292

9393
if len(errors) < 1 and user_input is not None:
9494
config[CONFIG_KIND] = CONFIG_KIND_TARGET_RATE
@@ -109,7 +109,7 @@ async def async_step_user(
109109

110110
async def async_step_reconfigure(self, user_input: dict[str, Any] | None = None):
111111
config = dict(user_input) if user_input is not None else None
112-
errors = validate_target_rate_config(config) if config is not None else {}
112+
errors = validate_target_timeframe_config(config) if config is not None else {}
113113

114114
if len(errors) < 1 and user_input is not None:
115115
return self.async_update_and_abort(

custom_components/target_timeframes/translations/en.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@
5252
"step": {
5353
"user": {
5454
"title": "Add Target Timeframe",
55-
"description": "Setup a target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_value",
55+
"description": "Setup a target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_timeframe",
5656
"data": {
5757
"name": "The name of your target",
5858
"hours": "The hours you require in decimal format.",
@@ -78,7 +78,7 @@
7878
},
7979
"reconfigure": {
8080
"title": "Reconfigure Target Timeframe",
81-
"description": "Setup a target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_value",
81+
"description": "Setup a target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/target_timeframe",
8282
"data": {
8383
"name": "The name of your target",
8484
"hours": "The hours you require in decimal format.",
@@ -116,7 +116,7 @@
116116
"step": {
117117
"user": {
118118
"title": "Rolling Target Timeframe",
119-
"description": "Setup a rolling target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_value",
119+
"description": "Setup a rolling target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_timeframe",
120120
"data": {
121121
"name": "The name of your target",
122122
"hours": "The hours you require in decimal format.",
@@ -133,7 +133,7 @@
133133
},
134134
"reconfigure": {
135135
"title": "Reconfigure Rolling Target Timeframe",
136-
"description": "Setup a rolling target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_value",
136+
"description": "Setup a rolling target time. Full documentation can be found at https://bottlecapdave.github.io/HomeAssistant-TargetTimeframes/setup/rolling_target_timeframe",
137137
"data": {
138138
"name": "The name of your target",
139139
"hours": "The hours you require in decimal format.",

0 commit comments

Comments
 (0)