Skip to content

Commit 4d0d8f9

Browse files
committed
docs: Added clarification for off peak sensor and OHME
1 parent 3f292aa commit 4d0d8f9

File tree

2 files changed

+13
-9
lines changed

2 files changed

+13
-9
lines changed

_docs/entities/electricity.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,6 +153,10 @@ This is `on` when you're within your tariff's off peak period, and `off` at all
153153

154154
Depending on your [account configuration](../setup/account.md#intelligent-rates-mode), what is determined as an active dispatching period will change. If you have configured to accept [planned or started dispatches](../setup/account.md#planned-and-started-dispatches-will-turn-into-off-peak-rates), then the sensor will turn on when you're are within an active planned or started dispatch period. If you have configured to accept [only started dispatches](../setup/account.md#only-started-dispatches-will-turn-into-off-peak-rates), then the sensor will turn on when you're are within an active started dispatch period, but not planned dispatch.
155155

156+
This above does not apply and will not come on outside of the standard off peak hours for the following intelligent providers
157+
158+
* OHME
159+
156160
| Attribute | Type | Description |
157161
|-----------|------|-------------|
158162
| `current_start` | `datetime` | The date/time when the off peak rate started |

_docs/entities/intelligent.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ If you are on the [intelligent tariff](https://octopus.energy/smart/intelligent-
66

77
If you switch to the intelligent tariff after you have installed the integration, you will need to reload the integration or restart your Home Assistant instance. You will also need to do this if you re-onboard.
88

9-
### Is Dispatching
9+
## Is Dispatching
1010

1111
`binary_sensor.octopus_energy_{{DEVICE_ID}}_intelligent_dispatching`
1212

@@ -75,7 +75,7 @@ Each item in `started_dispatch` have the following attributes
7575

7676
You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-dispatches-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
7777

78-
### Current State
78+
## Current State
7979

8080
`sensor.octopus_energy_{{DEVICE_ID}}_intelligent_state`
8181

@@ -96,7 +96,7 @@ This sensor displays the current state of your intelligent provider as told by t
9696
* `LOST_CONNECTION` - lost connection to the device, ready to re-auth (if not temporary / automatic fix).
9797
* `RETIRED` - / de-authed (re-auth not possible, re-register device to onboard again).
9898

99-
### Bump Charge
99+
## Bump Charge
100100

101101
`switch.octopus_energy_{{DEVICE_ID}}_intelligent_bump_charge`
102102

@@ -112,7 +112,7 @@ This sensor is used to turn on/off bump ("on-demand") charging for a **single**
112112

113113
You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
114114

115-
### Smart Charge
115+
## Smart Charge
116116

117117
`switch.octopus_energy_{{DEVICE_ID}}_intelligent_smart_charge`
118118

@@ -128,7 +128,7 @@ This sensor is used to turn on/off intelligent smart charging for a **single** i
128128

129129
You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
130130

131-
### Charge Target
131+
## Charge Target
132132

133133
`number.octopus_energy_{{DEVICE_ID}}_intelligent_charge_target`
134134

@@ -144,7 +144,7 @@ This sensor is used to see and set the charge target for your future intelligent
144144

145145
You can use the [data_last_retrieved sensor](./diagnostics.md#intelligent-settings-data-last-retrieved) to determine when the underlying data was last retrieved from the OE servers.
146146

147-
### Target Time (Select)
147+
## Target Time (Select)
148148

149149
`select.octopus_energy_{{DEVICE_ID}}_intelligent_target_time`
150150

@@ -166,7 +166,7 @@ This is limited to 30 minute increments between 4 and 11 to match the Octopus En
166166
|-----------|------|-------------|
167167
| `raw_value` | `time` | The raw target time. This is useful if the time is set to a value outside of the range available in the select options (e.g. from another integration) |
168168

169-
### Target Time (Time)
169+
## Target Time (Time)
170170

171171
`time.octopus_energy_{{DEVICE_ID}}_intelligent_target_time`
172172

@@ -192,11 +192,11 @@ This gives you finer control over the times (still within valid time periods), b
192192
If you're moving to this integration from [megakid/ha_octopus_intelligent](https://github.com/megakid/ha_octopus_intelligent), below is a quick guide on what entities you should use
193193

194194
* `binary_sensor.octopus_intelligent_slot` - Use the [off peak sensor](./electricity.md#off-peak)
195-
* `binary_sensor.octopus_intelligent_planned_dispatch_slot` - There is no alternative for this.
195+
* `binary_sensor.octopus_intelligent_planned_dispatch_slot` - Use the [is dispatching sensor](#is-dispatching)
196196
* `binary_sensor.octopus_intelligent_slot_next_1_hour`, `binary_sensor.octopus_intelligent_slot_next_2_hours` and `binary_sensor.octopus_intelligent_slot_next_3_hours` - These sensors felt like they would always fall short of peoples requirements as everyone has different time periods they wish to know about. The [off peak sensor](./electricity.md#off-peak) exposes the current and next start/end times which could be used in a template sensor to determine how long the rate is cheap for when on. Or the [target rate](../setup/target_rate.md) or [rolling target rate](../setup/rolling_target_rate.md) might help for what you need.
197197
* `sensor.octopus_intelligent_next_offpeak_start` - The default off peak start date/time can be found as an attribute on the [off peak sensor](./electricity.md#off-peak). This can be extracted using a [template sensor](https://www.home-assistant.io/integrations/template/).
198198
* `sensor.octopus_intelligent_offpeak_end` - The default off peak end date/time can be found as an attribute on the [off peak sensor](./electricity.md#off-peak). This can be extracted using a [template sensor](https://www.home-assistant.io/integrations/template/).
199199
* `switch.octopus_intelligent_bump_charge` - Use the [bump charge sensor](#bump-charge)
200200
* `switch.octopus_intelligent_smart_charging` - Use the [smart charge sensor](#smart-charge)
201201
* `select.octopus_intelligent_target_time` - Use the [target time (time) sensor](#target-time-time) or [target time (select) sensor](#target-time-select)
202-
* `select.octopus_intelligent_target_soc` - Use the [charge target sensor](#charge-target)
202+
* `select.octopus_intelligent_target_soc` - Use the [charge target sensor](#charge-target)

0 commit comments

Comments
 (0)