Skip to content

Commit 5001c8e

Browse files
docs: keep compare_tariff sensors in the FAQ recorder example (#5485) (#5487)
The FAQ's recorder example excludes the predbat domain and re-includes only a fixed entity list, which leaves out predbat.compare_tariff_*. The Compare tab builds its day-by-day history from those sensors' recorded history, so anyone copying the example only ever sees the latest compare run. Add an entity_globs include for predbat.compare_tariff_*, say why in the FAQ's caveats, and note the recorder requirement in compare.md. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
1 parent a73bfef commit 5001c8e

2 files changed

Lines changed: 8 additions & 1 deletion

File tree

‎docs/compare.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,10 @@ For each tariff a new sensor is created in Home Assistant called **predbat.compa
142142

143143
You can create charts from these sensors to show how the different tariffs compare on a daily basis.
144144

145+
The day-by-day history on the Compare tab is read back from Home Assistant's recorded history of these sensors, so they must be kept by the recorder.
146+
If you have added a `recorder:` filter that excludes the `predbat` domain, include them again with an `entity_globs` entry of `predbat.compare_tariff_*`
147+
(see the [recorder example in the FAQ](faq.md#predbat-is-causing-exceed-maximum-size-warning-messages-in-the-home-assistant-core-log)), otherwise the Compare tab will only ever show the most recent run.
148+
145149
![image](https://github.com/user-attachments/assets/6d5c30f6-822f-4d9c-b4a6-701c0b676c61)
146150

147151
## Overriding Predbat configuration per tariff

‎docs/faq.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,8 @@ recorder:
252252
- sensor.predbat_pv_d3
253253
- sensor.predbat_temperature
254254
include:
255+
entity_globs: #The history of these entities is used by Predbat's Compare tab
256+
- predbat.compare_tariff_*
255257
entities: #The history of these entities is used by Predbat
256258
- predbat.car_charging_power
257259
- predbat.carbon_today
@@ -289,7 +291,8 @@ Two things to be careful of if you adapt the example above:
289291

290292
- Don't drop entries from the `include` list without checking what reads them. Predbat needs the recorded history of
291293
every entity listed there and quietly loses a feature for each one it can no longer read - `predbat.cost_today`, for
292-
instance, is what the Plan tab's *History* and *Yesterday Without Predbat* views are built from.
294+
instance, is what the Plan tab's *History* and *Yesterday Without Predbat* views are built from. Likewise the `predbat.compare_tariff_*`
295+
sensors are what the [Compare tab](compare.md) builds its day-by-day history from; without them it only ever shows the latest run.
293296
- Don't add further Predbat sensors to the `exclude` list for the same reason. `sensor.predbat_pv_forecast_h0`,
294297
`sensor.predbat_pv_forecast_h0_uncalibrated` and `sensor.predbat_pv_today` are deliberately left out of it because PV
295298
calibration, the PV chart and the PV accuracy chart compare against their history. Adding a `sensor.*` entity to

0 commit comments

Comments
 (0)