Add vars description

This commit is contained in:
Fabian Affolter 2016-01-26 12:46:38 +01:00
parent dacb712e69
commit 0d2103add7

View File

@ -11,16 +11,22 @@ logo: home-assistant.png
ha_category: Automation 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. 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.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
input_boolean: input_boolean:
notify_home: notify_home:
# Optional, friendly name of entry
name: Notify when someome arrives home name: Notify when someome arrives home
# Optional, value when Home Assistant starts
initial: off initial: off
# Optional, icon for entry
icon: mdi:car icon: mdi:car
``` ```
Configuration variables:
- **name** (*Optional*): Friendly name of entry.
- **initial** (*Optional*): Initial value when Home Assistant starts.
- **icon** (*Optional*): Icon for entry.
Pick an icon that you can find on [materialdesignicons.com](https://materialdesignicons.com/) to use for your input and prefix the name with `mdi:`. For example `mdi:car`, `mdi:ambulance`, or `mdi:motorbike`.