Michael a6b320840f
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>
2024-10-25 08:13:07 +02:00

6.3 KiB

title, description, ha_category, ha_release, ha_iot_class, ha_domain, ha_config_flow, ha_ssdp, ha_platforms, ha_codeowners, ha_integration_type, ha_quality_scale
title description ha_category ha_release ha_iot_class ha_domain ha_config_flow ha_ssdp ha_platforms ha_codeowners ha_integration_type ha_quality_scale
AVM FRITZ!SmartHome Instructions on how to integrate AVM Smart Home (former AVM FRITZ!DECT) components into Home Assistant.
Binary sensor
Button
Climate
Light
Sensor
Switch
0.68 Local Polling fritzbox true true
binary_sensor
button
climate
cover
diagnostics
light
sensor
switch
@mib1185
@flabbamann
hub gold

The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate AVM 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

{% include integrations/config_flow.md %}

{% note %} 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 %}

Light bulbs

Light bulbs like the FRITZ!DECT 500 or Magenta SmartHome LED E27 Color will be integrated as {% term light %} entities.

{% note %} The FRITZ!DECT 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 %}

Plugs

Plugs like the FRITZ!DECT 200 or FRITZ!DECT 210 will be integrated as {% term switch %} entities.

Further there are additional {% term sensor %} and {% term binary_sensor "binary sensor" %} entities created for each device, based on its capabilities:

  • Button lock via UI
  • Button lock on device
  • Electric Current
  • Power Consumption
  • Temperature
  • Total Energy
  • Voltage

Shutter drivers

Shutter drivers like the 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, FRITZ!DECT 302 or 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
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).

Further there are additional {% term sensor %} and {% term binary_sensor "binary sensor" %} entities created for each device, based on its capabilities:

  • 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

Other devices

Some devices like the FRITZ!DECT 440 can't be controlled via this integration, but its sensors can still be integrated.

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:

  • Battery
  • Button lock via UI
  • Button lock on device
  • Humidity
  • Temperature

Troubleshooting

In any case, when reporting an issue, please enable debug logging, 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 data. If you have collected the debug log and the diagnostics data, provide them with the issue report.