Re-ordered configuration then example. (#27368)

Added tooltips to the page and added aliases to support some terms referenced.

Re-styled navigation to MS format.
This commit is contained in:
Danny Tsang 2023-05-12 05:51:48 +01:00 committed by GitHub
parent 08b20cad13
commit 1bce76b8fa
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 14 deletions

View File

@ -72,6 +72,8 @@
Conditions are an optional part of an automation that will prevent an Conditions are an optional part of an automation that will prevent an
action from firing if they are not met. action from firing if they are not met.
link: /docs/scripts/conditions/ link: /docs/scripts/conditions/
aliases:
- conditions
- term: Cover - term: Cover
definition: >- definition: >-
@ -335,8 +337,9 @@
A service carries out one specific task, for example: turn on the light in the A service carries out one specific task, for example: turn on the light in the
living room. A service has targets and data and can be called by actions, a living room. A service has targets and data and can be called by actions, a
dashboard, or via voice command. dashboard, or via voice command.
link: /docs/scripts/service-calls/ link: /docs/scripts/service-calls/
aliases:
- services
- term: State - term: State
definition: |- definition: |-

View File

@ -14,14 +14,14 @@ ha_integration_type: helper
The Input Boolean helper integration allows you to define boolean values that The Input Boolean helper integration allows you to define boolean values that
can be controlled via the user interface and can be used within conditions of can be controlled via the user interface and can be used within conditions of
an automation. This can for example be used to disable or enable certain an {% term automation %}. This can for example be used to disable or enable certain
automations by using them in their conditions. automations by using them in their {% term conditions %}.
## Configuration ## Configuration
The preferred way to configure input boolean helpers is via the user interface, The preferred way to configure input boolean helpers is via the user interface,
in which they are known as Toggle Helpers. To add one, go to in which they are known as Toggle Helpers. To add one, go to
**{% my helpers title="Settings -> Devices & Services -> Helpers" %}** and click the add button; **{% my helpers title="Settings > Devices & Services > Helpers" %}** and click the add button;
next choose the **{% my config_flow_start domain=input_boolean title="Toggle" %}** option. next choose the **{% my config_flow_start domain=input_boolean title="Toggle" %}** option.
To be able to add **Helpers** via the user interface you should have To be able to add **Helpers** via the user interface you should have
@ -32,14 +32,6 @@ then you can use the UI.
Input booleans can also be configured via `configuration.yaml`: Input booleans can also be configured via `configuration.yaml`:
```yaml
# Example configuration.yaml entry
input_boolean:
notify_home:
name: Notify when someone arrives home
icon: mdi:car
```
{% configuration %} {% configuration %}
input_boolean: input_boolean:
description: Alias for the input. Multiple entries are allowed. description: Alias for the input. Multiple entries are allowed.
@ -61,9 +53,17 @@ input_boolean:
type: icon type: icon
{% endconfiguration %} {% endconfiguration %}
```yaml
# Example configuration.yaml entry
input_boolean:
notify_home:
name: Notify when someone arrives home
icon: mdi:car
```
## Services ## Services
This integration provides the following services to modify the state of the This integration provides the following {% term services %} to modify the state of the
`input_boolean` and a service to reload the configuration without restarting `input_boolean` and a service to reload the configuration without restarting
Home Assistant itself. Home Assistant itself.
@ -105,7 +105,7 @@ automation:
You can also set or change the status of an `input_boolean` by using 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 `input_boolean.turn_on`, `input_boolean.turn_off` or `input_boolean.toggle` in
your automations. your automation action.
```yaml ```yaml
service: input_boolean.turn_on service: input_boolean.turn_on