Add model_id to device filters #36926
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 selectors has been updated to introduce a new optional Changes
Sequence DiagramsequenceDiagram
participant User
participant Selector
participant Entity List
User->>Selector: Configure with model_id
Selector->>Entity List: Filter entities
Entity List-->>Selector: Return matching entities
Selector-->>User: Display filtered list
The sequence diagram illustrates how the new 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 (1)
source/_docs/blueprint/selectors.markdown (1)
158-158: Remove trailing spaces.There are trailing spaces at the end of these lines that should be removed.
- required: false + required: falseAlso applies to: 574-574, 811-811, 1365-1365
🧰 Tools
🪛 Markdownlint (0.37.0)
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_docs/blueprint/selectors.markdown(5 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_docs/blueprint/selectors.markdown
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
574-574: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (4)
source/_docs/blueprint/selectors.markdown (4)
153-158: LGTM! Area selector documentation updated correctly.The new
model_idfilter option is well-documented and follows the established pattern for device filter options.🧰 Tools
🪛 Markdownlint (0.37.0)
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
570-574: LGTM! Device selector documentation updated correctly.The new
model_idfilter option is well-documented and follows the established pattern for device filter options.🧰 Tools
🪛 Markdownlint (0.37.0)
574-574: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
806-811: LGTM! Floor selector documentation updated correctly.The new
model_idfilter option is well-documented and follows the established pattern for device filter options.🧰 Tools
🪛 Markdownlint (0.37.0)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
1362-1365: LGTM! Target selector documentation updated correctly.The new
model_idfilter option is well-documented and follows the established pattern for device filter options.🧰 Tools
🪛 Markdownlint (0.37.0)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_docs/blueprint/selectors.markdown (4)
153-158: Fix trailing spaces in the model_id configuration.The
model_idparameter documentation has trailing spaces that should be removed.model_id: description: > - When set, the list of areas is limited to areas with devices that have - the set model ID. + When set, the list of areas is limited to areas with devices that have + the set model ID. type: string required: false🧰 Tools
🪛 Markdownlint (0.37.0)
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
494-494: Fix trailing spaces and improve description consistency.The
model_idparameter documentation has trailing spaces and its description should be consistent with other filter parameters.- manufacturer, model, or model ID of the device, the entities the device provides or based + manufacturer, model, or model ID of the device, the entities the device provides, or based model_id: description: > - When set, the list of devices is limited to devices that have the set model ID. + When set, the list of devices is limited to devices that have the set model ID. type: string required: falseAlso applies to: 570-574
806-811: Fix trailing spaces in floor selector documentation.The
model_idparameter documentation has trailing spaces that should be removed.model_id: description: > - When set, the list only includes floors with devices that have - the set model ID. + When set, the list only includes floors with devices that have + the set model ID. type: string required: false🧰 Tools
🪛 Markdownlint (0.37.0)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
1362-1365: Fix capitalization and trailing spaces in target selector.The
Descriptionfield should be lowercase and trailing spaces should be removed.model_id: - Description: When set, the targets are limited to devices that have the set model ID. + description: When set, the targets are limited to devices that have the set model ID. type: string required: false🧰 Tools
🪛 Markdownlint (0.37.0)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_docs/blueprint/selectors.markdown(5 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_docs/blueprint/selectors.markdown
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
574-574: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
🔇 Additional comments (1)
source/_docs/blueprint/selectors.markdown (1)
153-158: LGTM: The model_id parameter is consistently documented.The addition of the
model_idparameter is well documented across all relevant selectors (Area, Device, Floor, and Target) with consistent type definitions and optional status.Also applies to: 570-574, 806-811, 1362-1365
🧰 Tools
🪛 Markdownlint (0.37.0)
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_docs/blueprint/selectors.markdown (4)
153-158: Improve description consistency for model_id filter.The description is clear but could be more consistent with other filter descriptions in the documentation.
- When set, the list of areas is limited to areas with devices that have - the set model ID. + When set, it limits the list of areas to areas with devices that have the set model ID.🧰 Tools
🪛 Markdownlint (0.37.0)
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
570-574: Fix trailing spaces and improve description consistency.The description should follow the same pattern as other filter descriptions, and trailing spaces should be removed.
- When set, the list of devices is limited to devices that have the set model ID. + When set, it limits the list of devices to devices that have the set model ID.🧰 Tools
🪛 Markdownlint (0.37.0)
574-574: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
806-811: Fix trailing spaces and improve description consistency.The description should follow the same pattern as other filter descriptions, and trailing spaces should be removed.
- When set, the list only includes floors with devices that have - the set model ID. + When set, it limits the list of floors to floors with devices that have the set model ID.🧰 Tools
🪛 Markdownlint (0.37.0)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
1362-1365: Fix trailing spaces and improve description consistency.The description should follow the same pattern as other filter descriptions, and trailing spaces should be removed.
- description: When set, the targets are limited to devices that have the set model ID. + description: When set, it limits the targets to devices that have the set model ID.🧰 Tools
🪛 Markdownlint (0.37.0)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_docs/blueprint/selectors.markdown(5 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
source/_docs/blueprint/selectors.markdown
158-158: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
574-574: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
1365-1365: Expected: 0 or 2; Actual: 6
Trailing spaces
(MD009, no-trailing-spaces)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (1)
source/_docs/blueprint/selectors.markdown (1)
Line range hint
153-1365: Overall documentation structure looks good!The addition of the
model_idfilter option is well documented across all relevant selectors. The structure and placement are consistent with the existing documentation.🧰 Tools
🪛 Markdownlint (0.37.0)
811-811: Expected: 0 or 2; Actual: 6
Trailing spaces(MD009, no-trailing-spaces)
Proposed change
Add model_id to device filters for device-picking selectors.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Add model_id filter to device selector frontend#23746
Add model_id filter to device selector core#135646
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
model_idfiltering option.model_idto limit selections based on specific model identifiers.