home-assistant.io/source/_components/input_select.markdown
Jan Losinski 6a1c90b51f input_select: documentation for services and scene (#1546)
This adds documentation on how to use the input_select component
services and how to use it in a scene.

This is related to bug home-assistant/home-assistant#4673

Signed-off-by: Jan Losinski <losinski@wh2.tu-dresden.de>
2016-12-07 05:36:52 -08:00

2.5 KiB

layout title description date sidebar comments sharing footer logo ha_category ha_release
page Input Select Instructions how to integrate the Input Select component into Home Assistant. 2016-02-02 17:00 true false true true home-assistant.png Automation 0.13

The input_select component allows the user to define a list of values that can be selected via the frontend and can be used within conditions of automation. When a user selects a new item, a state transition event is generated. This state event can be used in an automation trigger.

To enable this platform, add the following lines to your configuration.yaml:

# Example configuration.yaml entry
input_select:
  who_cooks:
    name: Who cooks today
    options:
     - Paulus
     - Anne Therese
    initial: Anne Therese
    icon: mdi:panda
  living_room_preset:
    options:
      - Visitors
      - Visitors with kids
      - Home Alone

Configuration variables:

  • [alias] (Required): Alias for the input.
  • name (Optional): Friendly name of the input.
  • options array: List of options to choose from
  • initial (Optional): Initial value when Home Assistant starts.
  • icon (Optional): Icon for entry.

Pick an icon that you can find on materialdesignicons.com to use for your input and prefix the name with mdi:. For example mdi:car, mdi:ambulance, or mdi:motorbike.

{% linkable_title Services %}

This components provide three services to modify the state of the input_select:

  • input_select.select_option: This can be used to select a specific option. The option is passed as option attribute in the service data.
  • input_select.select_previous: Select the previous option.
  • input_select.select_next: Select the next option.

The following example shows the usage of the input_select.select_option service in an automation:

# Example configuration.yaml entry
automation:
  - alias: example automation
    trigger:
      platform: event
      event_type: MY_CUSTOM_EVENT
    action:
      - service: input_select.select_option
        data:
          entity_id: input_select.who_cooks
          option: Paulus

{% linkable_title Scenes %}

To specify a target option in a Scene you have to specify the target as option attribute:

# Example configuration.yaml entry
scene:
  - name: Example1
    entities:
      input_select.who_cooks:
        option: Paulus