Sync config with the new config flow #37018
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. |
|
Warning Rate limit exceeded@cereal2nd has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 50 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe pull request updates the Velbus integration documentation in the source markdown file, focusing on improving the configuration instructions for Velbus device connections. The changes provide more detailed and structured guidance on connecting via USB and TCP/IP methods, including specific configuration parameters, connection testing procedures, and examples for different device types like Signum and Velser. Changes
Sequence DiagramsequenceDiagram
participant User
participant Velbus Device
participant Home Assistant
User->>Home Assistant: Configure Velbus Integration
alt USB Connection
User->>Home Assistant: Select USB Interface
Home Assistant->>Velbus Device: Test Connection
else TCP/IP Connection
User->>Home Assistant: Provide Host, Port, Password
Home Assistant->>Velbus Device: Establish Secure Connection
end
Velbus Device-->>Home Assistant: Connection Established
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 (5)
source/_integrations/velbus.markdown (5)
37-42: Fix grammar and spelling issues in the introduction.Please address the following issues:
- Add a comma after "During the setup"
- Fix the spelling of "choises" to "choices"
-During the setup you will be shown 2 choises on ways to connect to the Velbus bus: +During the setup, you will be shown 2 choices on ways to connect to the Velbus bus:🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...## Configuration parameters During the setup you will be shown 2 choises on ways to ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
44-52: Fix terminology, grammar, and formatting issues in the USB section.Please address the following issues:
- Use "USB" instead of "usb" in line 47
- Fix "its" to "it's" in line 50
- Remove the extra blank line at line 52
-The interface usb devices are automatically detected and shown in a list. +The interface USB devices are automatically detected and shown in a list. -There will be a connection test to make sure the connection is working, and if its working the integration will be added to Home Assistant. +There will be a connection test to make sure the connection is working, and if it's working, the integration will be added to Home Assistant.🧰 Tools
🪛 LanguageTool
[grammar] ~50-~50: Did you mean “it’s” (curly apostrophe) or “it's” (straight apostrophe)?
Context: ... sure the connection is working, and if its working the integration will be added t...(ITS_IT_S)
[uncategorized] ~50-~50: A comma might be missing here.
Context: ...e the connection is working, and if its working the integration will be added to Home A...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
🪛 Markdownlint (0.37.0)
52-52: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
🪛 GitHub Actions: home-assistant.io Test
[error] 47-47: Incorrect usage of the term: "usb", use "USB" instead
53-67: Fix preposition usage in the TCP/IP introduction.Change "in your network" to "on your network" for better clarity.
-The TCP/IP connection is a way to connect to the Velbus bus. You will need a Velbus TCP/IP interface available in your network. +The TCP/IP connection is a way to connect to the Velbus bus. You will need a Velbus TCP/IP interface available on your network.🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...eed a Velbus TCP/IP interface available in your network. There are a couple of pa...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
🪛 Markdownlint (0.37.0)
58-58: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
68-80: Fix IP terminology in Signum and Velser examples.Replace "ip" with "IP" in the host descriptions.
-host: your signum ip address +host: your signum IP address -host: your velser ip address +host: your velser IP address🧰 Tools
🪛 GitHub Actions: home-assistant.io Test
[error] 71-71: Incorrect usage of the term: "ip", use "IP" instead
[error] 78-78: Incorrect usage of the term: "ip", use "IP" instead
82-87: Fix terminology in Home Assistant add-on example.Please address the following terminology issues:
- Replace "hassio addon" with "Home Assistant add-on"
- Replace "hassio" with "Home Assistant"
- Replace "ip" with "IP"
-#### Example: hassio addon +#### Example: Home Assistant add-on -host: your hassio ip address +host: your Home Assistant IP address🧰 Tools
🪛 GitHub Actions: home-assistant.io Test
[error] 82-82: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 82-82: Incorrect usage of the term: "addon", use "add-on" instead
[error] 85-85: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 85-85: Incorrect usage of the term: "ip", use "IP" instead
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/velbus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/velbus.markdown
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...## Configuration parameters During the setup you will be shown 2 choises on ways to ...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~50-~50: Did you mean “it’s” (curly apostrophe) or “it's” (straight apostrophe)?
Context: ... sure the connection is working, and if its working the integration will be added t...
(ITS_IT_S)
[uncategorized] ~50-~50: A comma might be missing here.
Context: ...e the connection is working, and if its working the integration will be added to Home A...
(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~55-~55: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...eed a Velbus TCP/IP interface available in your network. There are a couple of pa...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
🪛 Markdownlint (0.37.0)
source/_integrations/velbus.markdown
52-52: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
58-58: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/velbus.markdown
[error] 47-47: Incorrect usage of the term: "usb", use "USB" instead
[error] 71-71: Incorrect usage of the term: "ip", use "IP" instead
[error] 78-78: Incorrect usage of the term: "ip", use "IP" instead
[error] 82-82: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 82-82: Incorrect usage of the term: "addon", use "add-on" instead
[error] 85-85: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 85-85: Incorrect usage of the term: "ip", use "IP" instead
⏰ 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/velbus.markdown (1)
37-87: Well-structured documentation with comprehensive examples!The documentation provides clear instructions for both USB and TCP/IP connection methods, with detailed examples for different scenarios. The structure is logical and easy to follow.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: A comma might be missing here.
Context: ...## Configuration parameters During the setup you will be shown 2 choises on ways to ...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[grammar] ~50-~50: Did you mean “it’s” (curly apostrophe) or “it's” (straight apostrophe)?
Context: ... sure the connection is working, and if its working the integration will be added t...(ITS_IT_S)
[uncategorized] ~50-~50: A comma might be missing here.
Context: ...e the connection is working, and if its working the integration will be added to Home A...(AI_EN_LECTOR_MISSING_PUNCTUATION_COMMA)
[uncategorized] ~55-~55: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...eed a Velbus TCP/IP interface available in your network. There are a couple of pa...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
🪛 Markdownlint (0.37.0)
52-52: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
58-58: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
🪛 GitHub Actions: home-assistant.io Test
[error] 47-47: Incorrect usage of the term: "usb", use "USB" instead
[error] 71-71: Incorrect usage of the term: "ip", use "IP" instead
[error] 78-78: Incorrect usage of the term: "ip", use "IP" instead
[error] 82-82: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 82-82: Incorrect usage of the term: "addon", use "add-on" instead
[error] 85-85: Incorrect usage of the term: "hassio", use "Home Assistant" instead
[error] 85-85: Incorrect usage of the term: "ip", use "IP" instead
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/velbus.markdown (3)
37-42: Fix grammar and spelling in the configuration introduction.Please apply the following corrections:
- "choises" should be "choices"
- Add a comma after "During the setup"
-During the setup you will be shown 2 choises on ways to connect to the Velbus bus: +During the setup, you will be shown 2 choices on ways to connect to the Velbus bus:🧰 Tools
🪛 LanguageTool
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...## Configuration parameters During the setup you will be shown 2 choises on ways to ...(AI_HYDRA_LEO_MISSING_COMMA)
44-50: Fix grammar in the USB connection section.The content is clear and well-structured, but there's a grammar error that needs to be fixed.
-There will be a connection test to make sure the connection is working, and if its working the integration will be added to Home Assistant. +There will be a connection test to make sure the connection is working, and if it's working the integration will be added to Home Assistant.🧰 Tools
🪛 LanguageTool
[grammar] ~50-~50: Did you mean “it’s” (curly apostrophe) or “it's” (straight apostrophe)?
Context: ... sure the connection is working, and if its working the integration will be added t...(ITS_IT_S)
52-52: Fix markdown formatting issues.Please address the following markdown formatting issues:
- Remove extra blank line at line 52
- Add blank lines around the parameter list (lines 58-61)
Also applies to: 58-61
🧰 Tools
🪛 Markdownlint (0.37.0)
52-52: Expected: 1; Actual: 2
Multiple consecutive blank lines(MD012, no-multiple-blanks)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/velbus.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/velbus.markdown
[uncategorized] ~39-~39: Possible missing comma found.
Context: ...## Configuration parameters During the setup you will be shown 2 choises on ways to ...
(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~50-~50: Did you mean “it’s” (curly apostrophe) or “it's” (straight apostrophe)?
Context: ... sure the connection is working, and if its working the integration will be added t...
(ITS_IT_S)
🪛 Markdownlint (0.37.0)
source/_integrations/velbus.markdown
52-52: Expected: 1; Actual: 2
Multiple consecutive blank lines
(MD012, no-multiple-blanks)
58-58: null
Lists should be surrounded by blank lines
(MD032, blanks-around-lists)
🪛 GitHub Actions: home-assistant.io Test
source/_integrations/velbus.markdown
[error] 82-82: Incorrect usage of the term: "hassio", use "Home Assistant" instead
⏰ 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 (3)
source/_integrations/velbus.markdown (3)
53-66: LGTM! Clear and well-structured TCP/IP configuration documentation.The TCP/IP connection parameters are well-documented with clear explanations for each parameter.
🧰 Tools
🪛 Markdownlint (0.37.0)
58-58: null
Lists should be surrounded by blank lines(MD032, blanks-around-lists)
68-74: LGTM! Clear example configuration for Signum.The example provides all necessary parameters with clear values.
75-80: LGTM! Clear example configuration for Velser.The example provides all necessary parameters with appropriate values.
Proposed change
Line up the docu with the configflow rework
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit