mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-05-05 18:48:59 +00:00
0e4bf58c43
I found it difficult to understand restore state at first. Once I found out that I /didn't/ need to do anything it became obvious what the paragraph was going for. I've re-written the language from a "what do you need to do" perspective rather than a "this is why you don't need to do anything" perspective.
81 lines
2.6 KiB
Markdown
81 lines
2.6 KiB
Markdown
---
|
|
layout: page
|
|
title: "Input Boolean"
|
|
description: "Instructions on how to integrate the Input Boolean component into Home Assistant."
|
|
date: 2016-01-17 16:58
|
|
sidebar: true
|
|
comments: false
|
|
sharing: true
|
|
footer: true
|
|
logo: home-assistant.png
|
|
ha_category: Automation
|
|
---
|
|
|
|
The `input_boolean` component allows the user to define boolean values that can be controlled via the frontend and can be used within conditions of automation. This can for example be used to disable or enable certain automations.
|
|
|
|
To enable input booleans in your installation, add the following lines to your `configuration.yaml`:
|
|
|
|
```yaml
|
|
# Example configuration.yaml entry
|
|
input_boolean:
|
|
notify_home:
|
|
name: Notify when someone arrives home
|
|
initial: off
|
|
icon: mdi:car
|
|
```
|
|
|
|
{% configuration %}
|
|
input_boolean:
|
|
description: Alias for the input. Multiple entries are allowed.
|
|
required: true
|
|
type: map
|
|
keys:
|
|
name:
|
|
description: Friendly name of the input.
|
|
required: false
|
|
type: String
|
|
initial:
|
|
description: Initial value when Home Assistant starts.
|
|
required: false
|
|
type: boolean
|
|
default: false
|
|
icon:
|
|
description: Icon to display for the component. Refer to the [Customizing devices](/docs/configuration/customizing-devices/#possible-values) page for possible values.
|
|
required: false
|
|
type: icon
|
|
{% endconfiguration %}
|
|
|
|
### {% linkable_title Restore State %}
|
|
|
|
This component will automatically restore the state it had prior to Home Assistant stopping as long as you have the `recorder` component enabled and your entity does **not** have a set value for `initial`. To disable this feature, set a valid value for `initial`. Additional information can be found in the [Restore state](/components/recorder/#restore-state) section of the [`recorder`](/components/recorder/) component documentation.
|
|
|
|
## {% linkable_title Automation Examples %}
|
|
|
|
Here's an example of an automation using the above `input_boolean`. This action will only occur if the switch is on.
|
|
|
|
```yaml
|
|
automation:
|
|
alias: Arriving home
|
|
trigger:
|
|
platform: state
|
|
entity_id: binary_sensor.motion_garage
|
|
to: 'on'
|
|
condition:
|
|
condition: state
|
|
entity_id: input_boolean.notify_home
|
|
state: 'on'
|
|
action:
|
|
service: notify.pushbullet
|
|
data:
|
|
title: ""
|
|
message: "Honey, I'm home!"
|
|
```
|
|
|
|
You can also set or change the status of an `input_boolean` by using `input_boolean.turn_on`, `input_boolean.turn_off` or `input_boolean.toggle` in your automations.
|
|
|
|
```yaml
|
|
- service: input_boolean.turn_on
|
|
data:
|
|
entity_id: input_boolean.notify_home
|
|
```
|