From a6b320840fbdb849259d6e1faa69caee84f2c840 Mon Sep 17 00:00:00 2001 From: Michael <35783820+mib1185@users.noreply.github.com> Date: Fri, 25 Oct 2024 08:13:07 +0200 Subject: [PATCH] Overhaul AVM FRITZ!SmartHome docs (#35293) * rework * add terminology tooltips * fix binary sensor tooltip * fine tuning * add troubleshooting section * Tiny tweaks --------- Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com> --- source/_integrations/fritzbox.markdown | 144 ++++++++++++++----------- 1 file changed, 79 insertions(+), 65 deletions(-) diff --git a/source/_integrations/fritzbox.markdown b/source/_integrations/fritzbox.markdown index ee2a0d2c2c8..a6887e9ed53 100644 --- a/source/_integrations/fritzbox.markdown +++ b/source/_integrations/fritzbox.markdown @@ -1,6 +1,6 @@ --- title: AVM FRITZ!SmartHome -description: Instructions on how to integrate AVM Fritz!DECT components into Home Assistant. +description: Instructions on how to integrate AVM Smart Home (former AVM FRITZ!DECT) components into Home Assistant. ha_category: - Binary sensor - Button @@ -29,103 +29,117 @@ ha_integration_type: hub ha_quality_scale: gold --- -The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [FRITZ!DECT](https://en.avm.de/products/smart-home/) devices like switches, sensors and thermostats. - -There is currently support for the following device types within Home Assistant: - -- Binary sensor -- Climate -- Cover -- Light -- Sensor -- Switch - -Additionally, we also support to trigger smarthome templates. +The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [AVM Smart Home](https://en.avm.de/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_). #### Tested devices -- [FRITZ!Box 5590 Fiber](https://en.avm.de/products/fritzbox/fritzbox-5590-fiber/) +- [FRITZ!Box 5590 Fiber][fritzbox_5590_fiber] - FRITZ!Box 6490 Cable -- [FRITZ!Box 6591 Cable](https://en.avm.de/products/fritzbox/fritzbox-6591-cable/) -- [FRITZ!Box 7590](https://en.avm.de/products/fritzbox/fritzbox-7590/) -- [FRITZ!Box 7590 AX](https://en.avm.de/products/fritzbox/fritzbox-7590-ax/) +- [FRITZ!Box 6591 Cable][fritzbox_6591_cable] +- [FRITZ!Box 7590][fritzbox_7590] +- [FRITZ!Box 7590 AX][fritzbox_7590_ax] +- [FRITZ!Box 7530 AX][fritzbox_7530_ax] - FRITZ!Box 7490 - FRITZ!Box 7430 -- [FRITZ!DECT 200](https://en.avm.de/products/fritzdect/fritzdect-200/) -- [FRITZ!DECT 210](https://en.avm.de/products/fritzdect/fritzdect-210/) -- [FRITZ!DECT 301](https://en.avm.de/products/fritzdect/fritzdect-301/) -- [FRITZ!DECT 302](https://en.avm.de/products/fritzdect/fritzdect-302/) -- [FRITZ!DECT 500](https://en.avm.de/products/fritzdect/fritzdect-500/) -- [Eurotronic Comet DECT](https://eurotronic.org/produkte/dect-ule-heizkoerperthermostat/comet-dect/) -- [Magenta SmartHome LED E27 Color](https://www.smarthome.de/geraete/smarthome-led-lampe-e27-farbig-weiss) +- [FRITZ!DECT 200][fritzdect_200] +- [FRITZ!DECT 210][fritzdect_210] +- [FRITZ!DECT 301][fritzdect_301] +- [FRITZ!DECT 302][fritzdect_302] +- [FRITZ!DECT 500][fritzdect_500] +- [Eurotronic Comet DECT][eurotronic_comet_dect] +- [Magenta SmartHome LED E27 Color][magenta_led_e27_color] - Magenta SmartHome LED E27 warmwhite -- [Rademacher RolloTron DECT 1213](https://www.rademacher.de/shop/rollladen-sonnenschutz/elektrischer-gurtwickler/rollotron-dect-1213) +- [Rademacher RolloTron DECT 1213][rademacher_rollotron_dect_1213] {% include integrations/config_flow.md %} {% note %} -The configuration in the UI asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting System -> FRITZ!Box Users -> Users. The username starts with "fritz" followed by four random numbers. Under properties on the right it says "created automatically". Prior to FRITZ!OS 7.24 the default username was "admin". +The configuration asks for a username. Starting from FRITZ!OS 7.24 the FRITZ!Box creates a random username for the admin user if you didn't set one yourself. This can be found after logging into the FRITZ!Box and visiting **System** > **FRITZ!Box Users** > **Users**. The username starts with `fritz` followed by four random numbers. Under **Properties** on the right, it says **created automatically**. Prior to FRITZ!OS 7.24, the default username was `admin`. {% endnote %} -## Switches & thermostats +### Light bulbs -To get AVM FRITZ!DECT switches (e.g. FRITZ!DECT 400/440) or thermostats (e.g. FRITZ!DECT 301) follow the [configuration instructions](#configuration) above. +Light bulbs like the [FRITZ!DECT 500][fritzdect_500] or [Magenta SmartHome LED E27 Color][magenta_led_e27_color] will be integrated as {% term light %} entities. -### Attributes +{% note %} +The [FRITZ!DECT 500][fritzdect_500] light bulb supports only 36 colors. When a color is picked in Home Assistant that is not supported by the device, a color that comes close will be activated. +{% endnote %} -There are several attributes that can be useful for automations and templates. +### Plugs -| Attribute | Description | -| --------- | ----------- | -| `device_locked` | The state of the key lock at the device. -| `locked` | The state of the lock for configuring the device via the app or the FRITZ!Box web interface. -| `low_battery` | The low battery state indication. -| `battery_level` | The battery level (only available since Fritz!OS 7). -| `holiday_mode` | The state of the holiday mode (only available since Fritz!OS 7). -| `summer_mode` | The state of the summer mode (only available since Fritz!OS 7). -| `window_open` | The state of the window open detection (only available since Fritz!OS 7). +Plugs like the [FRITZ!DECT 200][fritzdect_200] or [FRITZ!DECT 210][fritzdect_210] will be integrated as {% term switch %} entities. -## Sensors +Further there are additional {% term sensor %} and {% term binary_sensor "binary sensor" %} entities created for each device, based on its capabilities: -To get AVM FRITZ!DECT sensors (e.g., FRITZ!DECT Repeater 100) follow the [configuration instructions](#configuration) above. - -There are multiple sensors defined, the availability depends on the features of the connected FRITZ!DECT devices - -- Battery -- Comfort Temperature -- Current Scheduled Preset -- Eco Temperature +- Button lock via UI +- Button lock on device - Electric Current -- Humidity -- Next Scheduled Change Time -- Next Scheduled Preset -- Next Scheduled Temperature - Power Consumption - Temperature - Total Energy - Voltage -### Attributes +### Shutter drivers -There are several attributes that can be useful for automations and templates. +Shutter drivers like the [Rademacher RolloTron DECT 1213][rademacher_rollotron_dect_1213] will be integrated as {% term cover %} entities. + +### Templates + +Self defined templates within the FRITZ!Box smart home configuration menu, will be integrated as {% term button %} entities and those can be triggered from within Home Assistant. + +### Thermostats + +Thermostats like the [FRITZ!DECT 301][fritzdect_301], [FRITZ!DECT 302][fritzdect_302] or [Eurotronic Comet DECT][eurotronic_comet_dect] will be integrated as {% term climate %} entities. + +These entities can have several attributes that can be useful for {% term automations %} and {% term templates %}: | Attribute | Description | | --------- | ----------- | -| `device_locked` | The state of the key lock at the device. -| `locked` | The state of the lock for configuring the device via the app or the FRITZ!Box web interface. +| `battery_low` | The low battery state indication. | +| `battery_level` | The battery level (only available since Fritz!OS 7). | +| `holiday_mode` | The state of the holiday mode (only available since Fritz!OS 7). | +| `summer_mode` | The state of the summer mode (only available since Fritz!OS 7). | +| `window_open` | The state of the window open detection (only available since Fritz!OS 7). | -## Light +Further there are additional {% term sensor %} and {% term binary_sensor "binary sensor" %} entities created for each device, based on its capabilities: -To get AVM FRITZ!DECT lightbulbs (e.g., FRITZ!DECT 500) follow the [configuration instructions](#configuration) above. +- Battery +- Button lock via UI +- Button lock on device +- Comfort Temperature +- Current Scheduled Preset +- Eco Temperature +- Next Scheduled Change Time +- Next Scheduled Preset +- Next Scheduled Temperature -{% note %} -The FRITZ!DECT 500 lightbulb supports only 36 colors. When a color is picked in Home Assistant that is not supported by the device, a color that comes close will be activated. -{% endnote %} +### Other devices -## Cover +Some devices like the [FRITZ!DECT 440][fritzdect_440] can't be controlled via this integration, but its sensors can still be integrated. -To get AVM FRITZ!DECT compatible covers (e.g., Rademacher RolloTron DECT 1213) follow the [configuration instructions](#configuration) above. +The availability of these {% term sensor %} and {% term binary_sensor "binary sensor" %} entities depends on the features and capabilities of the connected device and can be one or multiple of: -## Template +- Battery +- Button lock via UI +- Button lock on device +- Humidity +- Temperature -To get AVM FRITZ! Templates (e.g., for your heating schedule) follow the [configuration instructions](#configuration) above. +[fritzbox_5590_fiber]: https://en.avm.de/products/fritzbox/fritzbox-5590-fiber +[fritzbox_6591_cable]: https://en.avm.de/products/fritzbox/fritzbox-6591-cable +[fritzbox_7590]: https://en.avm.de/products/fritzbox/fritzbox-7590 +[fritzbox_7590_ax]: https://en.avm.de/products/fritzbox/fritzbox-7590-ax +[fritzbox_7530_ax]: https://en.avm.de/products/fritzbox/fritzbox-7530-ax +[fritzdect_200]: https://en.avm.de/products/smart-home/fritzdect-200 +[fritzdect_210]: https://en.avm.de/products/smart-home/fritzdect-210 +[fritzdect_301]: https://en.avm.de/products/smart-home/fritzdect-301 +[fritzdect_302]: https://en.avm.de/products/smart-home/fritzdect-302 +[fritzdect_440]: https://en.avm.de/products/smart-home/fritzdect-440 +[fritzdect_500]: https://en.avm.de/products/smart-home/fritzdect-500 +[eurotronic_comet_dect]: https://eurotronic.org/produkte/dect-ule-heizkoerperthermostat/comet-dect +[magenta_led_e27_color]: https://www.smarthome.de/geraete/smarthome-led-lampe-e27-farbig-weiss +[rademacher_rollotron_dect_1213]: https://www.rademacher.de/shop/rollladen-sonnenschutz/elektrischer-gurtwickler/rollotron-dect-1213 + +## Troubleshooting + +In any case, when reporting an issue, please enable [debug logging](/docs/configuration/troubleshooting/#debug-logs-and-diagnostics), restart the integration, and as soon as the issue re-occurs stop the debug logging again (_download of debug log file will start automatically_). Further _if still possible_, please also download the [diagnostics](/integrations/diagnostics) data. If you have collected the debug log and the diagnostics data, provide them with the issue report.