Skip to content

Added 'availability_template' to Template Vacuum platform #10309

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cgarwood merged 4 commits into from
Sep 28, 2019
Merged

Added 'availability_template' to Template Vacuum platform #10309

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa305cc
Added 'availability_template' to Template Vacuum platform
grillp Sep 8, 2019
ab96f4d
Fixed Syntax and default
grillp Sep 8, 2019
2d4665b
Removed optional parameter from example config
grillp Sep 10, 2019
fc64510
Apply suggestions from code review
grillp Sep 10, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion source/_components/vacuum.template.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,20 @@ return_to_base, clean_spot, locate and set_fan_speed commands of a vacuum.
To enable Template Vacuums in your installation, add the following to your
`configuration.yaml` file:

{% raw %}

```yaml
# Example configuration.yaml entry
vacuum:
- platform: template
vacuums:
living_room_vacuum:
start:
service: script.vacuum_start
service: script.vacuum_start
Comment thread
grillp marked this conversation as resolved.
```

{% endraw %}

{% configuration %}
vacuums:
description: List of your vacuums.
Expand All @@ -47,6 +51,11 @@ vacuum:
description: Defines a template to get the fan speed of the vacuum.
required: false
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
start:
description: Defines an action to run when the vacuum is started.
required: true
Expand Down Expand Up @@ -117,6 +126,7 @@ vacuum:
This example shows how to use templates to specify the state of the vacuum.

{% raw %}

```yaml
vacuum:
- platform: template
Expand Down Expand Up @@ -144,4 +154,5 @@ vacuum:
- Medium
- High
```

{% endraw %}