Some improvements to the AVM FRITZ!Smarthome docs #39997
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
📝 WalkthroughWalkthroughThe documentation for the Fritzbox integration was updated to use new product URLs, reorganize and rename device lists according to current branding, clarify mesh setup integration guidance, introduce a dedicated "Username" section, and improve formatting. No changes were made to code or exported entities; all modifications are documentation-related. Changes
Sequence Diagram(s)No sequence diagram generated since the changes are limited to documentation updates. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
source/_integrations/fritzbox.markdown (3)
31-31: Grammar & clarity – rephrase the opening sentenceThe current wording is a bit hard to parse (“…as also trigger so called smart home templates…”). A small rewrite makes it flow better and removes the “so called” filler.
-The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [AVM Smart Home](https://en.fritz.com/products/smart-home/) (_former AVM FRITZ!DECT_) devices like plugs, thermostats or shutter drivers as also trigger so called smart home templates (_contains settings for Smart Home devices of the same type_). +The AVM FRITZ!SmartHome integration for Home Assistant lets you integrate [AVM Smart Home](https://en.fritz.com/products/smart-home/) devices—such as plugs, thermostats, or shutter drivers—and also trigger so-called smart-home templates (pre-configured settings for devices of the same type).
82-82: Typo – replace “eq.” with “e.g.”-... devices like the [FRITZ!Smart Control 350][fritzdect_350] door/window contact sensors or the [FRITZ!Smart Control 440][fritzdect_440] buttons (_see the [other devices](#other-devices) section for details_). +... devices such as the [FRITZ!Smart Control 350][fritzdect_350] door/window contact sensors or the [FRITZ!Smart Control 440][fritzdect_440] buttons (_see the [other devices](#other-devices) section for details_).
138-138: Typo – “e.g.” instead of “eq.” + plural pronoun-Event based devices like motion detection sensors or window/door contacts or buttons (_eq. [FRITZ!Smart Control 350][fritzdect_350] or the [FRITZ!Smart Control 440][fritzdect_440]_) can't be controlled nor used via this integration, but its sensors can still be integrated. +Event-based devices such as motion detectors, window/door contacts, or buttons (_e.g._, [FRITZ!Smart Control 350][fritzdect_350] or [FRITZ!Smart Control 440][fritzdect_440]_) can't be controlled via this integration, but their sensors can still be integrated.
📜 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
📒 Files selected for processing (1)
source/_integrations/fritzbox.markdown(5 hunks)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (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/fritzbox.markdown (3)
35-44: List indentation – keep sub-items consistently indentedMarkdown requires two spaces (or a tab) before a nested “-” to keep it inside its parent list item.
Lines 44 (“FRITZ!Smart Gateway”) is at the root level, so visually it belongs to the top list and renders fine. If you intended it to be a peer of “FRITZ!Box routers”/“FRITZ!SmartHome devices”, no change is needed. Otherwise indent it by two spaces.No change required if the current rendering is intentional.
59-60: Mesh note looks greatGood call-out. Clear wording and the link resolves to FRITZ! documentation. 👍
75-78: Config description link is accurateThe anchor switch from “#prerequisites” to “#username” matches the new dedicated section – nice touch.
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (1)
source/_integrations/fritzbox.markdown (1)
138-138: Use “cannot” instead of “can not”Same grammar issue flagged in previous review—please switch to the single-word form for consistency.
-Event based devices like motion detection sensors or window/door contacts or buttons (_eq. [FRITZ!Smart Control 350][fritzdect_350] or the [FRITZ!Smart Control 440][fritzdect_440]_) can not be controlled or used via this integration, but its sensors can still be integrated. +Event-based devices such as motion sensors, door/window contacts, or buttons (e.g., [FRITZ!Smart Control 350][fritzdect_350] or [FRITZ!Smart Control 440][fritzdect_440]) cannot be controlled or used via this integration, but their sensors can still be integrated.
🧹 Nitpick comments (2)
source/_integrations/fritzbox.markdown (2)
31-31: Rephrase awkward sentence for clarityThe construction “as also trigger so called smart home templates” is grammatically off and hard to parse. A concise alternative:
-The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [AVM Smart Home](https://en.fritz.com/products/smart-home/) (_former AVM FRITZ!DECT_) devices like plugs, thermostats or shutter drivers as also trigger so called smart home templates (_contains settings for Smart Home devices of the same type_). +The AVM FRITZ!SmartHome integration for Home Assistant lets you integrate [AVM Smart Home](https://en.fritz.com/products/smart-home/) devices—such as plugs, thermostats, and shutter drivers—and trigger so-called Smart Home templates (preset configurations for devices of the same type).
59-60: Minor wording tweak for the mesh noteConsider adding “only” before “be added” to emphasize exclusivity and replace the passive voice:
-Please note that in a [mesh](https://en.fritz.com/service/knowledge-base/dok/FRITZ-Box-7590/3329_Mesh-with-FRITZ/) setup, only the FRITZ!Box with the mesh master role should be added with the AVM FRITZ!SmartHome integration. +In a [mesh](https://en.fritz.com/service/knowledge-base/dok/FRITZ-Box-7590/3329_Mesh-with-FRITZ/) setup, **add only** the FRITZ!Box that has the mesh-master role to the AVM FRITZ!SmartHome integration.
📜 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
📒 Files selected for processing (1)
source/_integrations/fritzbox.markdown(5 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/fritzbox.markdown
[style] ~138-~138: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...ITZ!Smart Control 440][fritzdect_440]_) can not be controlled or used via this integrat...
(CAN_NOT_PREMIUM)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This comment was marked as outdated.
This comment was marked as outdated.
Sorry, something went wrong.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull Request Overview
This PR revises the AVM FRITZ!Smarthome documentation by updating links to the new fritz.com domain, renaming and regrouping devices, and adding notes for mesh setups and event-based device limitations
- Added a note to only add the mesh master FRITZ!Box in mesh setups
- Updated all AVM product links to use the
https://en.fritz.combase URL - Renamed/reorganized devices (e.g., FRITZ!Smart Gateway, FRITZ!Smart Energy/Thermo) and improved event-based device descriptions
Comments suppressed due to low confidence (3)
source/_integrations/fritzbox.markdown:31
- [nitpick] This sentence is hard to follow and has a grammar issue. Consider rephrasing to: "…devices like plugs, thermostats, or shutter drivers, and can also trigger so-called smart home templates."
The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [AVM Smart Home](https://en.fritz.com/products/smart-home/) (_former AVM FRITZ!DECT_) devices like plugs, thermostats or shutter drivers as also trigger so called smart home templates (_contains settings for Smart Home devices of the same type_).
source/_integrations/fritzbox.markdown:82
- Avoid contractions in documentation; replace "can't" with "cannot" for a more formal tone and consistency with the style guide.
Since the API of the FRITZ!Box does not provide a push mechanism, this integration polls the data every 30 seconds from the FRITZ!Box. Because of this, the integration can't support the main features of event-based devices like the [FRITZ!Smart Control 350][fritzdect_350] door/window contact sensors or the [FRITZ!Smart Control 440][fritzdect_440] buttons (_see the [other devices](#other-devices) section for details_).
source/_integrations/fritzbox.markdown:51
- The list item "Magenta SmartHome LED E27 warmwhite" below remains unindented and appears at the wrong level. Nest it under this heading for proper Markdown hierarchy.
- Smart home devices from other vendors
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Proposed change
https://en.fritz.com(formerhttps://en.avm.de)Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit