Update stiebel_eltron.markdown #37105
Conversation
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request modifies the configuration options for the STIEBEL ELTRON integration in Home Assistant. The changes introduce two new parameters, Changes
Sequence DiagramsequenceDiagram
participant User
participant HomeAssistant
participant StiebelEltronISG
User->>HomeAssistant: Configure integration
User->>HomeAssistant: Provide host (required)
User->>HomeAssistant: Optionally specify port
HomeAssistant->>StiebelEltronISG: Establish connection
StiebelEltronISG-->>HomeAssistant: 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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/stiebel_eltron.markdown (3)
63-64: Enhance the configuration example with additional guidance.Consider improving the example configuration by:
- Using a more descriptive placeholder (e.g.,
192.168.1.123orisg.local)- Adding a comment indicating that
portis optional with default value 502stiebel_eltron: name: LWZ504e - host: IP_ADDRESS - port: 502 + host: 192.168.1.123 # IP address or hostname of your ISG + port: 502 # Optional, defaults to 502
73-81: Add validation rules for configuration parameters.The documentation would benefit from additional information about:
- Valid formats for the
hostparameter (IP address or hostname)- Valid range for the
portparameter (typically 1-65535)host: description: The hostname or IP of the stiebel eltron ISG. required: true type: string + example: "192.168.1.123 or isg.local" port: description: The port of the stiebel eltron ISG. required: false default: 502 type: integer + validation: "1-65535"
Line range hint
1-81: Document relationship with modbus integration.Since these changes are related to modbus integration updates, consider adding a note about the relationship between this integration and the modbus integration. This would help users understand the underlying architecture and troubleshoot any connection issues.
Add a note in the introduction section:
It requires the following components: - Compatible STIEBEL ELTRON unit (see "Compatibility overview" in [Software Documentation Modbus TCP/IP](https://www.stiebel-eltron.ch/content/dam/ste/ch/de/downloads/kundenservice/smart-home/Modbus/Modbus%20Bedienungsanleitung.pdf)) - [ISG web](https://www.stiebel-eltron.com/en/home/products-solutions/renewables/controller_energymanagement/internet_servicegateway/isg_web.html), with the [Modbus module](https://www.stiebel-eltron.ch/de/home/service/smart-home/modbus.html) enabled - IP network connection to the ISG web + +This integration communicates with your ISG web using the Modbus TCP protocol. No additional modbus configuration is required as this integration handles the communication internally.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/stiebel_eltron.markdown(2 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
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
|
This change to the docs, does it only apply after the code change is merged home-assistant/core#136482? |
The documentation applies to the config after the change, but the current state is already broken. The modbus part does not work anymore. |
ok. In this case, this docs PR should target the |
|
I'm drafting this PR, as changes are needed. Please undraft it, once the changes have been implemented and the PR is ready for review again. |
Proposed change
The current configuration example is broken due to changes in the modbus integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
hostandportconfiguration options for STIEBEL ELTRON ISG integrationhubparameter from configuration options