Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-02-11 00:52:43 +01:00
Code Issues Projects Releases Wiki Activity

Improve template number/select documentation (#1441)

Browse Source
This commit is contained in:
Oxan van Leeuwen 2021-09-04 04:47:03 +02:00 committed by GitHub
parent 5d6861ae0d
commit a19f1ca712
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
components/number/template.rst
View File

@ -14,7 +14,7 @@ using :ref:`lambdas <config-lambda>`.
number:
- platform: template
name: "Template number"
update_interval: never
optimistic: true
min_value: 0
max_value: 100
step: 1
@ -27,12 +27,12 @@ Configuration variables:
- **max_value** (**Required**, float): The maximum value this number can be.
- **step** (**Required**, float): The granularity with which the number can be set.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
Lambda to be evaluated every update interval to get the new value of the number.
Lambda to be evaluated every update interval to get the current value of the number.
- **set_action** (*Optional*, :ref:`Action <config-action>`): The action that should
be performed when the remote (like Home Assistant's frontend) requests to set the
number value. The new value is available to lambdas in the ``x`` variable.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
number. Defaults to ``60s``.
- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the number
by executing the ``lambda``. Defaults to ``60s``.
- **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
any command sent to the template number will immediately update the reported state.
Cannot be used with ``lambda``. Defaults to ``false``.
@ -45,9 +45,9 @@ Configuration variables:
- All other options from :ref:`Number <config-number>`.
``number.set`` Action
----------------------------------
---------------------
You can also publish a state to a template number from elsewhere in your YAML file
You can also set the number for the template number from elsewhere in your YAML file
with the :ref:`number-set_action`.
See Also

13
components/select/template.rst
View File

@ -14,7 +14,7 @@ using :ref:`lambdas <config-lambda>`.
select:
- platform: template
name: "Template select"
update_interval: never
optimistic: true
options:
- one
- two
@ -28,11 +28,12 @@ Configuration variables:
- **name** (**Required**, string): The name of the Select.
- **options** (**Required**, list): The list of options this Select has.
- **lambda** (*Optional*, :ref:`lambda <config-lambda>`):
Lambda to be evaluated every update interval to get the new option of the Select.
Lambda to be evaluated every update interval to get the current option of the select.
- **set_action** (*Optional*, :ref:`Action <config-action>`): The action that should
be performed when the remote (like Home Assistant's frontend) requests to set the Select option.
- **update_interval** (*Optional*, :ref:`config-time`): The interval to check the
Select ``lambda``. Defaults to ``60s``.
The new option is available to lambdas in the ``x`` variable.
- **update_interval** (*Optional*, :ref:`config-time`): The interval on which to update the select
by executing the ``lambda``. Defaults to ``60s``.
- **optimistic** (*Optional*, boolean): Whether to operate in optimistic mode - when in this mode,
any command sent to the Template Select will immediately update the reported state.
Cannot be used with ``lambda``. Defaults to ``false``.
@ -45,9 +46,9 @@ Configuration variables:
- All other options from :ref:`Select <config-select>`.
``select.set`` Action
----------------------------------
---------------------
You can also set an option to a Template Select from elsewhere in your YAML file
You can also set an option for the template select from elsewhere in your YAML file
with the :ref:`select-set_action`.
See Also