Simone Chemelli b0fc0dd91c
Add Fritz missing info for device profiles and port forwards (#18431)
* Add info for device profiles and port forwards

* Update source/_integrations/fritz.markdown

Co-authored-by: Franck Nijhof <frenck@frenck.nl>

Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2021-07-08 21:14:16 +02:00

3.7 KiB

title, description, ha_category, ha_release, ha_domain, ha_config_flow, ha_codeowners, ha_iot_class, ha_platforms, ha_ssdp
title description ha_category ha_release ha_domain ha_config_flow ha_codeowners ha_iot_class ha_platforms ha_ssdp
AVM FRITZ!Box Tools Instructions on how to integrate AVM FRITZ!Box based routers into Home Assistant.
Presence Detection
Binary Sensor
Sensor
0.10 fritz true
@mammuth
@AaronDavidSchneider
@chemelli74
Local Polling
binary_sensor
device_tracker
sensor
switch
true

The AVM FRITZ!Box Tools integration allows you to control your AVM FRITZ!Box based router.

There is support for the following platform types within Home Assistant:

  • Device tracker - presence detection by looking at connected devices.
  • Binary sensor - connectivity status.
  • Sensor - external IP address and uptime.
  • Switch - call deflection, port forward, device profile and Wi-Fi networks.

{% include integrations/config_flow.md %}

TR-064 needs to be enabled in the FRITZ!Box network settings for Home Assistant to login and read device info.

Username

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.

Services

Currently supported services are Platform specific:

  • fritz.reconnect
  • fritz.reboot

Platform Services

Service fritz.reboot

Reboot the router.

Service data attribute Optional Description
entity_id no Only act on a specific router

Service fritz.reconnect

Disconnect and reconnect the router to the Internet. If you have a dynamic IP address, most likely it will change.

Service data attribute Optional Description
entity_id no Only act on a specific router

Integration Options

It is possible to change some behaviors through the integration options. These can be changed at AVM FRITZ!Box Tools -> Configure on the Integrations page.

  • Consider home: Number of seconds that must elapse before considering a disconnected device "not at home".

Additional info

Device Profile

Device profiles are designed for advanced users, thus they are disabled by default. You need to enable the wanted entities manually.

Device Tracker

Note 1: All devices to be tracked, even the new detected, are disabled by default. You need to enable the wanted entities manually.

Note 2: If you don't want to automatically track newly detected devices, disable the integration system option Enable new added entities.

Port Forward

Due to security reasons, AVM implemented the ability to enable/disable a port forward rule only from the host involved in the rule. As a result, this integration will create entities only for rules that have your Home Assistant host as a destination.