-
-
Notifications
You must be signed in to change notification settings - Fork 7.7k
Improvements to incomfort documentation #37101
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the documentation for the Incomfort integration in Home Assistant, introducing a new section titled "Supported devices" that details compatibility with OpenTherm thermostats, including specific Intergas appliance models and their manufacturing years. Additionally, a configuration section is added, outlining required and optional parameters for setup, including Changes
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/incomfort.markdown (2)
26-27
: Improve readability of the Supported devices section.While the content is informative, the readability could be improved by structuring it into bullet points.
Consider this structure:
### Supported devices -The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard. An example of such a thermostat is the [Comfort Touch Thermostat](https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/). The thermostats and LAN2RF gateway are often sold as a set. The gateway is suitable for use with Intergas Kombi Kompakt HRE and HReco appliances from year of manufacture 2014. If the Comfort Touch thermostat is used together with the gateway, then this will work in combination with Intergas Kombi Kompakt HRE, HReco, or Xtreme devices from year of manufacture 2017. +The Intergas Lan2RF Gateway connects thermostats based on the OpenTherm standard. + +**Compatible thermostats:** +- [Comfort Touch Thermostat](https://www.intergas-verwarming.nl/en/consumer/products/comfort-touch-thermostat/) +- The thermostats and LAN2RF gateway are often sold as a set + +**Compatibility matrix:** +- Gateway alone: + - Intergas Kombi Kompakt HRE and HReco appliances + - Year of manufacture: 2014 or later +- Gateway with Comfort Touch thermostat: + - Intergas Kombi Kompakt HRE, HReco, or Xtreme devices + - Year of manufacture: 2017 or later
44-57
: Enhance security-related information in configuration.While the configuration documentation is well-structured, consider adding security-related notes.
Add security notes about:
- Password handling for older devices with default 'intergas' password
- Recommendation to change default credentials
- Network security considerations
password: description: "The password to log into the gateway, is printed at the bottom of the Lan2RF Gateway or is `intergas` for some older devices." required: false type: string + note: > + For security reasons, it's recommended to change the default password if your device + uses 'intergas'. The gateway should be protected behind a firewall if exposed to the + internet.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/incomfort.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
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/incomfort.markdown (1)
44-57
: Consider adding a security note about default credentials.The configuration section is well-structured and provides clear information. However, since default credentials are mentioned (
admin
andintergas
), consider adding a security note recommending users to change default passwords if their device supports it.password: description: "The password to log into the gateway, is printed at the bottom of the Lan2RF Gateway or is `intergas` for some older devices." required: false type: string {% endconfiguration_basic %} +{:.note} +> For security reasons, if your device supports changing the default credentials, it is recommended to do so. +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/incomfort.markdown
(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/incomfort.markdown
[grammar] ~23-~23: Consider using the singular form after the singular determiner “This”.
Context: ...egration ha_config_flow: true --- This integrations links Home Assistant with your Intergas...
(AGREEMENT_SENT_START)
⏰ 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 (2)
source/_integrations/incomfort.markdown (2)
26-28
: Well-structured device compatibility information.The new "Supported devices" section provides clear and valuable information about compatible devices, including specific model numbers and manufacturing years. This helps users quickly determine if their devices are supported.
Line range hint
1-100
: Documentation structure follows best practices.The documentation is well-organized, uses appropriate templates, and includes all necessary sections with clear examples. It effectively follows Home Assistant documentation standards.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (3)
source/_integrations/incomfort.markdown (3)
44-57
: Consider adding a security note about changing default credentials.The configuration section is well-structured and clear. However, since default credentials are mentioned (
admin
andintergas
), consider adding a security recommendation to change these defaults if possible.password: description: "The password to log into the gateway, is printed at the bottom of the Lan2RF Gateway or is `intergas` for some older devices." required: false type: string + note: "For security, it is recommended to change default credentials if your device supports it."
61-64
: Consider expanding the troubleshooting section.While the current tip is helpful, consider adding:
- Common error messages users might encounter
- Steps to verify gateway connectivity
- How to identify gateway type/version
67-67
: Consider clarifying the update behavior.The section could be more specific about:
- Maximum expected delay for temperature updates
- Whether the 30-second interval is configurable
- Impact on Home Assistant's state updates
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/incomfort.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
🔇 Additional comments (2)
source/_integrations/incomfort.markdown (2)
23-23
: LGTM! Grammar issue has been fixed.The text now correctly uses "This integration links" instead of "This integrations links".
26-26
: Great addition of device compatibility information!The new section provides clear and detailed information about supported devices, including specific models, manufacturing years, and compatibility requirements. This helps users quickly determine if their setup is compatible.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice! Thank you, @jbouwh 👍
Proposed change
Small improvemnts to incomfort documentation
Type of change
current
branch).current
branch).next
branch).next
branch).Additional information
Checklist
current
branch.next
branch.Summary by CodeRabbit
host
,username
, andpassword
.