Update _index.md for Binary Sensor #5270
Open
+18
−18
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Separate those conditions & actions which USE a Binary Sensor from those which DEFINE a Binary Sensor ... per Feature Request esphome#3280
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughReorganized Binary Sensor documentation: removed the standalone "Actions" section and moved the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
content/components/binary_sensor/_index.md (4)
80-84: Fix typo and improve clarity around invalidate_state behavior
- Typo: “excuted” → “executed”.
- Since this sentence references
binary_sensor.invalidate_state, keeping it clean matters for searchability.Apply this diff:
- a `binary_sensor.invalidate_state` action has been excuted. The default is `false`. + a `binary_sensor.invalidate_state` action has been executed. The default is `false`.
91-92: Punctuation nit: double period after “Component”There’s a stray extra period.
Apply this diff:
-- If Webserver enabled and version 3 is selected, All other options from Webserver Component.. See [Webserver Version 3](#config-webserver-version-3-options). +- If Webserver enabled and version 3 is selected, All other options from Webserver Component. See [Webserver Version 3](#config-webserver-version-3-options).
463-466: Add an anchor for the new section and pluralize heading for consistency
- Other sections use pluralized titles (e.g., “Binary Sensor Filters,” “Binary Sensor Automation”). Recommend “Referencing Binary Sensors.”
- Add a section anchor to make it deep-linkable like the other sections.
Apply this diff:
+{{< anchor "binary_sensor-referencing" >}} -## Referencing Binary Sensor +## Referencing Binary Sensors
467-478: Tighten wording, align example id with prior examples, and add a brief behavioral note
- Align the example id with the rest of the page, which uses
my_binary_sensor.- Add an explicit note that invalidation won’t trigger
on_state, but will be seen byon_state_change(users often trip on this).- Optional: consider linking “Template binary sensor” to its component page for convenience.
Apply this diff:
### `binary_sensor.invalidate_state` Action This action will invalidate the current state of the sensor. It is most useful with the Template binary sensor. After the state is invalidated, it will be reported to Home Assistant as `unknown`. Example: ```yaml on_...: - binary_sensor.invalidate_state: my_binary_sensor_id + binary_sensor.invalidate_state: my_binary_sensor-The state may also be invalidated by an API call in a lambda - see the API reference linked below.
+The state may also be invalidated by an API call in a lambda — see the API reference linked below.
+
+{{< note >}}
+Invalidating a binary sensor’s state does not triggeron_state; useon_state_changeif you need to react when the state becomesunknown.
+{{< /note >}}</blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used**: CodeRabbit UI **Review profile**: CHILL **Plan**: Pro **💡 Knowledge Base configuration:** - MCP integration is disabled by default for public repositories - Jira integration is disabled by default for public repositories - Linear integration is disabled by default for public repositories You can enable these sources in your CodeRabbit configuration. <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 20682d5b5ac89b28f882063764b5f2ada20066f8 and 2d3519972c3366dbde44c228c1058fe068585296. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `content/components/binary_sensor/_index.md` (1 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>📓 Path-based instructions (1)</summary> <details> <summary>**</summary> **⚙️ CodeRabbit configuration file** > - Do not generate or add any sequence diagrams Files: - `content/components/binary_sensor/_index.md` </details> </details> </details> </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>content/components/binary_sensor/_index.md (1)</summary><blockquote> `465-469`: **No broken cross-references found for the `binary_sensor.invalidate_state` action** Ran ripgrep across all markdown files and confirmed that: - The only occurrences of `binary_sensor-invalidate_state-action` are in `content/components/binary_sensor/_index.md` at the new anchor itself. - There are no other links to `invalidate_state` or `binary_sensor.invalidate_state` elsewhere in the docs. No updates to other pages are required. </blockquote></details> </blockquote></details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
minor formatting tidy-ups.
donburch888
commented
Aug 22, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
This is a minor change moving some of the documentation sections which refer to or use a Binary Sensor to a new main heading, to separate them from the sections which define the configuration of a Binary Sensor.
This provides users with the same information, but should make it easier for less experienced users to see which sections go in the Binary Sensor configuration ... but a few sections are actually used from other sensors' configuations.
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.New Component Images
If you are adding a new component to ESPHome, you can automatically generate a standardized black and white component name image for the documentation.
To generate a component image:
Comment on this pull request with the following command, replacing
COMPONENT_NAMEwith your component name in UPPER_CASE format with underscores (e.g.,BME280,SHT3X,DALLAS_TEMP):The ESPHome bot will respond with a downloadable ZIP file containing the SVG image.
Extract the SVG file and place it in the
images/folder of this repository.Use the image in your component's index table entry in
/components/index.rst.Example: For a component called "DHT22 Temperature Sensor", use: