Change how the person component works internally #36569
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence DiagramsequenceDiagram
participant Trackers
participant Person Integration
Trackers->>Person Integration: Report device states
alt Any tracker is home
Person Integration->>Person Integration: Set state to home
Person Integration->>Person Integration: Prioritize most recent GPS home tracker
else No home trackers
Person Integration->>Person Integration: Follow most recent GPS tracker
Person Integration->>Person Integration: Fallback to latest tracker
end
The sequence diagram illustrates the logic described in the documentation for determining a person's state based on connected trackers, showing the prioritization of home states and tracker types. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
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)
source/_integrations/person.markdown (4)
13-13: Fix grammar: Add missing articleAdd "the" before "person" for better grammar.
-The state updates of a connected device tracker will set the state of person. +The state updates of a connected device tracker will set the state of the person.🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Possible missing article found.
Context: ... device trackers are used, the state of person will be determined by this logic: 1. I...(AI_HYDRA_LEO_MISSING_THE)
15-21: Improve readability of state determination logicThe logic explanation is clear but could benefit from visual separation between main points.
Add blank lines between the top-level numbered items:
1. If any tracker is presenting the state `home`, the state of the `person` will be `home`. + 2. If multiple trackers are `home`, the source of the state of the `person` will either be 1. The most recently updated tracker of type `gps`, **IF** it is `home` **OR** 2. The most recently updated tracker + 3. If no tracker is `home`, the state of the `person` will follow: 1. The most recently updated tracker of type `gps`, **IF** it exists **OR** 2. The most recently updated tracker
27-27: Add comma for better readabilityAdd a comma before "Now" to properly separate the clauses.
-After some time, both stationary trackers show state `not_home`. Now your Person entity has state `not_home` with source `tracker_gps`. +After some time, both stationary trackers show state `not_home`. Now, your Person entity has state `not_home` with source `tracker_gps`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...tionary trackers show statenot_home. Now your Person entity has statenot_home...(AI_HYDRA_LEO_MISSING_COMMA)
33-35: Add blank lines around list per markdown best practicesThe list should be surrounded by blank lines for proper markdown formatting.
In short: + 1. The `home` state will always take priority over any other state. 2. Trackers of type `gps` will always take priority over non-gps trackers. +🧰 Tools
🪛 Markdownlint (0.37.0)
34-34: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/person.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/person.markdown
[uncategorized] ~13-~13: Possible missing article found.
Context: ... device trackers are used, the state of person will be determined by this logic: 1. I...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...tionary trackers show state not_home. Now your Person entity has state not_home...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.37.0)
source/_integrations/person.markdown
34-34: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🔇 Additional comments (1)
source/_integrations/person.markdown (1)
13-35: Documentation changes look good!
The updated documentation effectively explains the internal workings of the person component. The state determination logic is well-structured, and the examples cover various scenarios that users might encounter. The explanations are clear and will help users understand how their person entities will behave.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~13-~13: Possible missing article found.
Context: ... device trackers are used, the state of person will be determined by this logic: 1. I...
(AI_HYDRA_LEO_MISSING_THE)
[uncategorized] ~27-~27: Possible missing comma found.
Context: ...tionary trackers show state not_home. Now your Person entity has state not_home...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 Markdownlint (0.37.0)
34-34: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
Proposed change
This change documents the changes that home-assistant/core#134075 would implement if merged
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
personintegration documentation for clarity on state determination logic based on device trackers.