Add documentation for input_*.reload service. (#11415)

* input_text.reload docs update.

* Services docs update for input_boolean.

* input_datetime.reload sevice documentation update.

* input_number services doc update.

* input_select.reload service update.
This commit is contained in:
Alexei Chetroi 2019-12-09 15:15:53 -05:00 committed by Paulus Schoutsen
parent 7a6c66f6a5
commit 31a9b30011
5 changed files with 30 additions and 2 deletions

View File

@ -42,6 +42,18 @@ input_boolean:
type: icon type: icon
{% endconfiguration %} {% endconfiguration %}
### Services
This integration provides the following services to modify the state of the `input_boolean` and a service to reload the
configuration without restarting Home Assistant itself.
| Service | Data | Description |
| ------- | ---- | ----------- |
| `turn_on` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `on`
| `turn_off` | `entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_boolean` entities to `off`
| `toggle` | `entity_id(s)`<br>`area_id(s)` | Toggle the value of specific `input_boolean` entities
| `reload` | | Reload `input_boolean` configuration |
### Restore State ### Restore State
If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping. If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.

View File

@ -82,7 +82,7 @@ If you set a valid value for `initial` this integration will start with state se
### Services ### Services
Available service: `input_datetime.set_datetime`. Available service: `input_datetime.set_datetime` and `input_datetime.reload`.
Service data attribute | Format String | Description Service data attribute | Format String | Description
-|-|- -|-|-
@ -92,6 +92,8 @@ Service data attribute | Format String | Description
To set both the date and time in the same call, use `date` and `time` together, or use `datetime` by itself. Using `datetime` has the advantage that both can be set using one template. To set both the date and time in the same call, use `date` and `time` together, or use `datetime` by itself. Using `datetime` has the advantage that both can be set using one template.
`input_dateteime.reload` service allows one to reload `input_datetime`'s configuration without restarting Home Assistant itself.
## Automation Examples ## Automation Examples
The following example shows the usage of the `input_datetime` as a trigger in an The following example shows the usage of the `input_datetime` as a trigger in an

View File

@ -73,6 +73,18 @@ input_number:
type: icon type: icon
{% endconfiguration %} {% endconfiguration %}
### Services
This integration provides the following services to modify the state of the `input_number` and a service to reload the
configuration without restarting Home Assistant itself.
| Service | Data | Description |
| ------- | ---- | ----------- |
| `decrement` | `entity_id(s)`<br>`area_id(s)` | Decrement the value of specific `input_number` entities by `step`
| `increment` | `entity_id(s)`<br>`area_id(s)` | Increment the value of specific `input_number` entities by `step`
| `reload` | | Reload `input_number` configuration |
| `set_value` | `value`<br>`entity_id(s)`<br>`area_id(s)` | Set the value of specific `input_number` entities
### Restore State ### Restore State
If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping. If you set a valid value for `initial` this integration will start with state set to that value. Otherwise, it will restore the state it had prior to Home Assistant stopping.

View File

@ -74,6 +74,7 @@ This integration provides three services to modify the state of the `input_selec
| `set_options` | `options`<br>`entity_id(s)` | Set the options for specific `input_select` entities. | `set_options` | `options`<br>`entity_id(s)` | Set the options for specific `input_select` entities.
| `select_previous` | | Select the previous option. | `select_previous` | | Select the previous option.
| `select_next` | | Select the next option. | `select_next` | | Select the next option.
| `reload` | | Reload `input_select` configuration |
### Scenes ### Scenes

View File

@ -71,11 +71,12 @@ input_text:
### Services ### Services
This integration provides a single service to modify the state of the `input_text`. This integration provides a service to modify the state of the `input_text` and a service to reload the `input_text` configuration without restarting Home Assistant itself.
| Service | Data | Description | | Service | Data | Description |
| ------- | ---- | ----------- | | ------- | ---- | ----------- |
| `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities. | `set_value` | `value`<br>`entity_id(s)` | Set the value for specific `input_text` entities.
| `reload` | | Reload `input_text` configuration |
### Restore State ### Restore State