|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "FRITZ!Box" |
| 4 | +description: "Instructions how to integrate an AVM FRITZ!Box monitor into Home Assistant." |
| 5 | +date: 2017-01-17 22:00 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: avm.png |
| 11 | +ha_category: System Monitor |
| 12 | +ha_release: 0.36 |
| 13 | +ha_iot_class: "Local Polling" |
| 14 | +--- |
| 15 | + |
| 16 | + |
| 17 | +The `fritzbox_netmonitor` sensor monitors the network statistics exposed by [AVM Fritz!Box](http://avm.de/produkte/fritzbox/) routers. |
| 18 | + |
| 19 | +<p class='note warning'> |
| 20 | +It might be necessary to install additional packages: <code>$ sudo apt-get install libxslt-dev libxml2-dev python3-lxml</code> |
| 21 | +If you are working with the All-in-One installation, you may also need to execute also within your virtual environment the command <code> pip install lxml</code>; be patient this will take a while.</p> |
| 22 | + |
| 23 | +To use the Fritz!Box network monitor in your installation, add the following to your `configuration.yaml` file: |
| 24 | + |
| 25 | +```yaml |
| 26 | +# Example configuration.yaml entry |
| 27 | +sensor: |
| 28 | + - platform: fritzbox_netmonitor |
| 29 | +``` |
| 30 | +
|
| 31 | +Configuration variables: |
| 32 | +
|
| 33 | +- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1. |
| 34 | +
|
| 35 | +The following statistics will be exposed as attributes. |
| 36 | +
|
| 37 | +|Attribute |Description | |
| 38 | +|:-----------------|:------------------------------------------------------------| |
| 39 | +|is_linked |True if the FritzBox is physically linked to the provider | |
| 40 | +|is_connected |True if the FritzBox has established an internet-connection | |
| 41 | +|wan_access_type |Connection-type, can be `DSL` or `Cable` | |
| 42 | +|external_ip |External ip address | |
| 43 | +|uptime |Uptime in seconds | |
| 44 | +|bytes_sent |Bytes sent | |
| 45 | +|bytes_received |Bytes received | |
| 46 | +|max_byte_rate_up |Maximum upstream-rate in bytes/s | |
| 47 | +|max_byte_rate_down|Maximum downstream-rate in bytes/s | |
| 48 | + |
| 49 | +The sensor's state corresponds to the `is_linked` attribute and is either `online`, `offline`, or `unavailable` (in case connection to the router is lost). |
0 commit comments