Skip to content

docs: keep compare_tariff sensors in the FAQ recorder example - #5487

Merged
springfall2008 merged 1 commit into
mainfrom
docs/recorder-compare-tariff
Oct 12, 2026
Merged

springfall2008 merged 1 commit into
mainfrom
docs/recorder-compare-tariff

Conversation

@chalfontchubby

Copy link
Copy Markdown
Collaborator

Opened by Claude on Rik's behalf.

Fixes #5485

Problem

The FAQ's recorder: example excludes the whole predbat domain and only includes a fixed list of entities, and predbat.compare_tariff_* isn't on that list. The Compare tab builds its day-by-day history from the recorded history of those sensors (get_history_wrapper(result["entity_id"], 28) in web.py). Predbat itself keeps only the latest run, in comparisons.yaml. So anyone who copies the FAQ example sees only last night's comparison, and it gets replaced every night.

The reporter in #5485 had copied the FAQ block word for word. Their log shows all four comparisons completing normally every run, and their HA history graph for a compare sensor is flat apart from one old value.

Change

  • docs/faq.md: add entity_globs: - predbat.compare_tariff_* under include: in the recorder example. In HA's filter order an include glob is checked before the excluded domain, so this restores recording. Also add a line to the "be careful if you adapt this" notes.
  • docs/compare.md: note that the compare sensors must be kept by the recorder, linking to the FAQ example.

Docs only, no code change.

🤖 Generated with Claude Code

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>
@chalfontchubby chalfontchubby added the documentation Improvements or additions to documentation label Oct 11, 2026
@springfall2008
springfall2008 merged commit 5001c8e into main Oct 12, 2026
2 checks passed
@springfall2008
springfall2008 deleted the docs/recorder-compare-tariff branch October 12, 2026 07:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Compare only contains previous day

2 participants