mirror of
https://github.com/esphome/esphome-docs.git
synced 2024-11-15 10:45:41 +01:00
64 lines
2.6 KiB
ReStructuredText
64 lines
2.6 KiB
ReStructuredText
Template Select
|
|
===============
|
|
|
|
.. seo::
|
|
:description: Instructions for setting up Template Select(s) with ESPHome.
|
|
:image: description.svg
|
|
|
|
The ``template`` Select platform allows you to create a Select with templated values
|
|
using :ref:`lambdas <config-lambda>`.
|
|
|
|
.. code-block:: yaml
|
|
|
|
# Example configuration entry
|
|
select:
|
|
- platform: template
|
|
name: "Template select"
|
|
optimistic: true
|
|
options:
|
|
- one
|
|
- two
|
|
- three
|
|
initial_option: two
|
|
|
|
|
|
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 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.
|
|
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``.
|
|
- **restore_value** (*Optional*, boolean): Saves and loads the state to RTC/Flash.
|
|
Cannot be used with ``lambda``. Defaults to ``false``.
|
|
- **initial_option** (*Optional*, string): The option to set the option to on setup if not
|
|
restored with ``restore_value``.
|
|
Cannot be used with ``lambda``. Defaults to the first option in the ``options`` list.
|
|
- **id** (*Optional*, :ref:`config-id`): Manually specify the ID used for code generation.
|
|
- All other options from :ref:`Select <config-select>`.
|
|
|
|
.. note::
|
|
|
|
If you don't set a ``lambda`` and ``optimistic`` is ``false`` (default), updates to the select component state will need to be taken care of as part of your ``set_action`` using ``id(my_select).publish_state(x);`` (in a lambda). Do not use :ref:`select-set_action` here, as this would generate a loop. Also, don't use ``id(my_select).state = x`` as this won't have the desired effect (e.g. HA won't update with the change).
|
|
|
|
``select.set`` Action
|
|
---------------------
|
|
|
|
You can also set an option for the template select from elsewhere in your YAML file
|
|
with the :ref:`select-set_action`.
|
|
|
|
See Also
|
|
--------
|
|
|
|
- :ref:`automation`
|
|
- :apiref:`template/select/template_select.h`
|
|
- :ghedit:`Edit`
|