Changed Documentation for better comprehensibility (#15426)

This commit is contained in:
AlexSchmitz222 2020-11-08 13:53:38 +01:00 committed by GitHub
parent 353cfff422
commit 19503368e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,6 +1,6 @@
--- ---
title: AVM FRITZ!Box title: AVM FRITZ!SmartHome
description: Instructions on how to integrate the AVM Fritzbox Smart Home components. description: Instructions on how to integrate AVM Fritz!DECT components into Home Assistant.
ha_category: ha_category:
- Binary Sensor - Binary Sensor
- Climate - Climate
@ -12,13 +12,13 @@ ha_domain: fritzbox
ha_config_flow: true ha_config_flow: true
--- ---
The [AVM](https://en.avm.de) FRITZ!Box integration for Home Assistant allows you to integrate the switch and climate devices. The AVM FRITZ!SmartHome integration for Home Assistant allows you to integrate [FRITZ!DECT](https://en.avm.de/products/fritzdect/) devices like switches, sensors and thermostats.
There is currently support for the following device types within Home Assistant: There is currently support for the following device types within Home Assistant:
- Binary Sensor - Binary Sensor
- Climate - Climate
- [Sensor](#sensor) - Sensor
- Switch - Switch
#### Tested Devices #### Tested Devices
@ -33,7 +33,7 @@ There is currently support for the following device types within Home Assistant:
## Configuration ## Configuration
To add the AVM FRITZ!Box integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ!Box**. To add the AVM FRITZ!SmartHome integration to your installation, go to **Configuration** -> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **AVM FRITZ! SmartHome**.
If you have enabled SSDP discovery, its likely that you just have to confirm the detected device with username and password. If you have enabled SSDP discovery, its likely that you just have to confirm the detected device with username and password.
@ -48,18 +48,19 @@ fritzbox:
- password: YOUR_PASSWORD - password: YOUR_PASSWORD
``` ```
{% configuration %} {% configuration %}
devices: devices:
description: A list of FRITZ!Box devices. description: A list of FRITZ! devices.
type: map type: map
keys: keys:
host: host:
description: The hostname or IP address of the FRITZ!Box. description: The hostname or IP address of the FRITZ!Box. (e.g. fritz.box or 192.168.178.1)
required: false required: false
type: string type: string
default: fritz.box default: fritz.box
username: username:
description: The username for Smart Home access. description: The username for Smart Home access. **(User needs "Smart Home" persmission!)**
required: false required: false
type: string type: string
default: admin default: admin
@ -69,9 +70,10 @@ devices:
type: string type: string
{% endconfiguration %} {% endconfiguration %}
## Switch & Thermostat
To get AVM FRITZ!Box switch and thermostat follow the instructions above. ## Switches & Thermostats
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.
### Attributes ### Attributes
@ -91,9 +93,9 @@ There are several attributes that can be useful for automations and templates.
| `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function). | `total_consumption` | The total power consumption since the beginning of operation (only available if the device supports power meter function).
| `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function). | `total_consumption_unit` | The unit of the total_consumption (only available if the device supports power meter function).
## Sensor ## Sensors
To get AVM FRITZ!Box temperature sensor (e.g., FRITZ!DECT Repeater 100) follow the instructions for the [FRITZ!Box integration](#setup). To get AVM FRITZ!DECT sensors (e.g., FRITZ!DECT Repeater 100) follow the [configuration instructions](#configuration) above.
### Attributes ### Attributes