jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-30 12:46:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Added 'availability_template' to all Template Fan platform (#10312)

Browse Source 
* Added 'availability_template' to all Template Fan platform

* Fixed Syntax and default

* Removed optional parameter from example config

* Apply suggestions from code review

Co-Authored-By: Franck Nijhof <frenck@frenck.nl>
This commit is contained in:
Gil Peeters 2019-09-28 21:59:32 +10:00 committed by Charles Garwood
parent c752427e1b
commit acb0557228
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
source/_components/fan.template.markdown
View File

@ -17,6 +17,7 @@ To enable Template Fans in your installation, add the following to your
`configuration.yaml` file: `configuration.yaml` file:
{% raw %} {% raw %}
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
fan: fan:
@ -49,6 +50,7 @@ fan:
- '2' - '2'
- '3' - '3'
``` ```
{% endraw %} {% endraw %}
{% configuration %} {% configuration %}
@ -77,6 +79,11 @@ fan:
description: "Defines a template to get the direction of the fan. Valid value: 'forward'/'reverse'" description: "Defines a template to get the direction of the fan. Valid value: 'forward'/'reverse'"
required: false required: false
type: template type: template
availability_template:
description: Defines a template to get the `available` state of the component. If the template returns `true`, the device is `available`. If the template returns any other value, the device will be `unavailable`. If `availability_template` is not configured, the component will always be `available`.
required: false
type: template
default: true
turn_on: turn_on:
description: Defines an action to run when the fan is turned on. description: Defines an action to run when the fan is turned on.
required: true required: true