Home-Assistant
/
home-assistant.io
mirror of https://github.com/home-assistant/home-assistant.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
home-assistant.io/source/_integrations/fritzbox.markdown

7.5 KiB
Raw Permalink Blame History

title description ha_category ha_release ha_iot_class ha_domain ha_config_flow ha_ssdp ha_platforms ha_codeowners ha_integration_type
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

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

Prerequisites

Please note that in a mesh setup, only the FRITZ!Box with the mesh master role should be added with the AVM FRITZ!SmartHome integration.

Username

It is recommended to create a separate user to connect Home Assistant to your FRITZ!Box. To create a user, in the FRITZ!Box go to System > FRITZ!Box Users > Users > Add User. Make sure the user has the Smart Home permission.

{% note %} If you still want to use the predefined user, please note that as of 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 visit 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 %}

{% include integrations/config_flow.md %}

{% configuration_basic %} Host: description: "The hostname or IP address of your FRITZ!Box router." Username: description: "Name of the user to connect Home Assistant to your FRITZ!Box (see Username)" Password: description: "Password for the user to connect Home Assistant to your FRITZ!Box (see Username)" {% endconfiguration_basic %}

Data fetching and limitations

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 door/window contact sensors or the FRITZ!Smart Control 440 buttons (see the other devices section for details).

Devices

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!Smart Energy 200 or FRITZ!Smart Energy 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 Homepilot 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!Smart Thermo series or Eurotronic Comet DECT will be integrated as {% term climate %} entities.

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

  • Battery
  • Battery low
  • Button lock via UI
  • Button lock on device
  • Comfort Temperature
  • Current Scheduled Preset
  • Eco Temperature
  • Holiday mode
  • Next Scheduled Change Time
  • Next Scheduled Preset
  • Next Scheduled Temperature
  • Open window detected
  • Summer mode

Other devices

Event based devices like motion detection sensors or window/door contacts or buttons (for example, FRITZ!Smart Control 350 or the FRITZ!Smart Control 440) cannot be controlled or used via this integration, but their 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
  • Battery low
  • Button lock via UI
  • Button lock on device
  • Humidity
  • Open window detected
  • 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.

Remove the integration

{% include integrations/remove_device_service.md %}

If you don't use the separate created FRITZ!Box user anymore, than remove it from the FRITZ!Box under to System > FRITZ!Box Users > Users.