Add documentation for AVM fritzbox smarthome component (#4076)

* Add documentation for fritzhome

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* change component name and configuration

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* followed review comments

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* another rename

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* remove default from host

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* add documentation for device attributes

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* bump to ha_release 0.65

Signed-off-by: Heiko Thiery <heiko.thiery@gmail.com>

* ✏️ Some spelling and grammar fixes

* ✏️ Grammar and spelling updates

* ✏️ Small grammar & spelling changes

* ⬆️ ha_release -> 0.68
This commit is contained in:
Heiko Thiery 2018-04-17 19:06:39 +02:00 committed by Franck Nijhof
parent 560108c659
commit 078167bb03
3 changed files with 113 additions and 0 deletions

View File

@ -0,0 +1,28 @@
---
layout: page
title: "Fritzbox Thermostat"
description: "Instructions on how to integrate the AVM Fritzbox thermostat."
date: 2017-11-12 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Climate
ha_release: 0.68
ha_iot_class: "Local Polling"
---
<p class='note'>
To get AVM fritzbox thermostat follow the instructions for the general [Fritzbox](/components/fritzbox/).
</p>
### {% linkable_title Attributes %}
The are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `low_battery` | The low battery state indication.

View File

@ -0,0 +1,54 @@
---
layout: page
title: "Fritzbox"
description: "Instructions on how to integrate the AVM Fritzbox Smart Home components."
date: 2018-02-18 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Hub
ha_release: 0.68
ha_iot_class: "Local Polling"
---
The [AVM](www.avm.de) Fritzbox component for Home Assistant allows you to integrate the switch and climate devices.
#### {% linkable_title Tested Devices %}
- [FRITZ!Box 6490 Cable](https://avm.de/produkte/fritzbox/fritzbox-6490-cable/)
- [FRITZ!DECT 200](https://avm.de/produkte/fritzdect/fritzdect-200/)
- [Eurotronic Comet DECT](https://www.eurotronic.org/produkte/comet-dect.html)
## {% linkable_title Setup %}
```yaml
# Example configuration.yaml entry
fritzbox:
devices:
- host: fritz.box
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% configuration %}
devices:
description: A list of Fritzbox devices.
required: true
type: map
keys:
host:
description: The hostname or IP address of the Fritzbox.
required: true
type: optional
username:
description: The username for Smart Home access.
required: true
type: string
password:
description: The password of the user.
required: true
type: string
{% endconfiguration %}

View File

@ -0,0 +1,31 @@
---
layout: page
title: "Fritzbox Switch"
description: "Instructions on how to integrate the AVM Fritzbox switch."
date: 2017-11-12 17:10
sidebar: true
comments: false
sharing: true
footer: true
logo: avm.png
ha_category: Switch
ha_release: 0.68
ha_iot_class: "Local Polling"
---
<p class='note'>
To get AVM Fritzbox switch follow the instructions for the general [Fritzbox](/components/fritzbox/).
</p>
### {% linkable_title Attributes %}
The are several attributes that can be useful for automations and templates.
| Attribute | Description |
| --------- | ----------- |
| `device_locked` | The state of the key lock at the device.
| `locked` | The state of the lock for configuring the device via the app or the Fritzbox web interface.
| `temperature_unit` | The unit of the temperature sensor (only available if the device support temperature sensor).
| `temperature` | The current temperature sensor reading (only available if the device supports temperature sensor).
| `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).