Add reconfigure flow for KNX #39164

farmio · 2025-05-23T09:16:51Z

Proposed change

Add documentation for the new reconfigure flow of KNX.

Type of change

Spelling, grammar or other readability improvements (current branch).
Adjusted missing or incorrect information in the current documentation (current branch).
Added documentation for a new integration I'm adding to Home Assistant (next branch).
- I've opened up a PR to add logos and icons in Brands repository.
Added documentation for a new feature I'm adding to Home Assistant (next branch).
Removed stale or deprecated documentation.

Additional information

Link to parent pull request in the codebase: Add reconfigure flow for KNX core#145067
Link to parent pull request in the Brands repository:
This PR fixes or closes issue: fixes #

Checklist

This PR uses the correct branch, based on one of the following:
- I made a change to the existing documentation and used the current branch.
- I made a change that is related to an upcoming version of Home Assistant and used the next branch.
The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

Documentation
- Updated and reorganized KNX integration documentation for improved clarity.
- Added a new section detailing how to reconfigure KNX connection settings via the integration settings UI.
- Enhanced and repositioned the "Import KNX Keyring" instructions.
- Removed redundant content and improved section headings for easier navigation.

netlify · 2025-05-23T09:16:55Z

✅ Deploy Preview for home-assistant-docs ready!

Name	Link
🔨 Latest commit	`35fb0ec`
🔍 Latest deploy log	https://app.netlify.com/projects/home-assistant-docs/deploys/68303e80d1bfe6000838c69c
😎 Deploy Preview	https://deploy-preview-39164--home-assistant-docs.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

coderabbitai · 2025-05-23T09:19:18Z

📝 Walkthrough

Walkthrough

The KNX integration documentation was reorganized to introduce a new "Reconfiguration" section with step-by-step instructions for updating connection settings. The "Import KNX Keyring" subsection was moved, expanded, and clarified, while redundant content was removed and section headings were updated for accuracy.

Changes

File	Change Summary
source/_integrations/knx.markdown	Added "Reconfiguration" section with instructions; moved and expanded "Import KNX Keyring"; removed redundancy; updated headings.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant HomeAssistantUI
    participant KNXIntegration

    User->>HomeAssistantUI: Open Integration Settings
    HomeAssistantUI->>User: Display KNX Integration Options
    User->>HomeAssistantUI: Select Reconfiguration / Import KNX Keyring
    HomeAssistantUI->>KNXIntegration: Apply New Settings/Keyring
    KNXIntegration-->>HomeAssistantUI: Confirm Update
    HomeAssistantUI-->>User: Show Success Message

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 7fc9339 and 35fb0ec.

📒 Files selected for processing (1)

source/_integrations/knx.markdown (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

source/_integrations/knx.markdown

⏰ 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

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.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

source/_integrations/knx.markdown (1)

140-144: Import KNX Keyring subsection aligns with existing style
The ### Import KNX Keyring heading and the inclusion of the integrations/option_flow.md snippet effectively guide users through uploading a new keyring. For extra clarity, you might explicitly mention the expected file extension (e.g., .knxkeys) in the descriptive text.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between bf1cc03 and 7fc9339.

📒 Files selected for processing (1)

source/_integrations/knx.markdown (1 hunks)

⏰ 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/_integrations/knx.markdown (1)

128-135: Section placement and heading levels look good
The new “Reconfiguration” section is correctly placed among other ##-level sections, and the numbered list syntax is valid Markdown. This clearly introduces the flow for reconfiguring the integration without breaking hierarchy.

marvin-w

Thanks @farmio

source/_integrations/knx.markdown

c0ffeeca7

Thank you, @farmio 👍

Add reconfigure flow for KNX

7fc9339

farmio requested a review from marvin-w as a code owner May 23, 2025 09:16

home-assistant bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch labels May 23, 2025

farmio mentioned this pull request May 23, 2025

Add reconfigure flow for KNX home-assistant/core#145067

Merged

19 tasks

coderabbitai bot reviewed May 23, 2025

View reviewed changes

marvin-w previously approved these changes May 23, 2025

View reviewed changes

c0ffeeca7 reviewed May 23, 2025

View reviewed changes

source/_integrations/knx.markdown Outdated Show resolved Hide resolved

tiny style tweak

35fb0ec

c0ffeeca7 dismissed marvin-w’s stale review via 35fb0ec May 23, 2025 09:23

c0ffeeca7 approved these changes May 23, 2025

View reviewed changes

silamon added the awaits-parent Awaits the merge of an parent PR label May 25, 2025

home-assistant bot added the parent-merged The parent PR has been merged already label Jul 14, 2025

farmio merged commit 07b0984 into home-assistant:next Jul 14, 2025
7 checks passed

home-assistant bot removed awaits-parent Awaits the merge of an parent PR parent-merged The parent PR has been merged already labels Jul 14, 2025

farmio deleted the knx-reconf-flow branch July 14, 2025 21:34

github-actions bot locked and limited conversation to collaborators Jul 15, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Add reconfigure flow for KNX #39164

Add reconfigure flow for KNX #39164

Uh oh!

farmio commented May 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

netlify bot commented May 23, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented May 23, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

marvin-w left a comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Uh oh!

Add reconfigure flow for KNX #39164

Add reconfigure flow for KNX #39164

Uh oh!

Conversation

farmio commented May 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed change

Type of change

Additional information

Checklist

Summary by CodeRabbit

Uh oh!

netlify bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for home-assistant-docs ready!

Uh oh!

coderabbitai bot commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

marvin-w left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

c0ffeeca7 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

farmio commented May 23, 2025 •

edited by coderabbitai bot

Loading

netlify bot commented May 23, 2025 •

edited

Loading

coderabbitai bot commented May 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)