home-assistant.io/source/_integrations/input_text.markdown

title, description, logo, ha_category, ha_release, ha_qa_scale

title	description	logo	ha_category	ha_release	ha_qa_scale
Input Text	Instructions on how to integrate the Input Text integration into Home Assistant.	home-assistant.png	Automation	0.53	internal

The input_text integration allows the user to define values that can be controlled via the frontend and can be used within conditions of automation. Changes to the value stored in the text box generate state events. These state events can be utilized as automation triggers as well. It can also be configured in password mode (obscured text).

# Example configuration.yaml entries
input_text:
  text1:
    name: Text 1
    initial: Some Text
  text2:
    name: Text 2
    min: 8
    max: 40
  text3:
    name: Text 3
    pattern: '[a-fA-F0-9]*'
  text4:
    name: Text 4
    mode: password

{% configuration %} input_text: description: Alias for the input. Multiple entries are allowed. required: true type: map keys: name: description: Friendly name of the text input. required: false type: string min: description: Minimum length for the text value. required: false type: integer default: 0 max: description: Maximum length for the text value. 255 is the maximum number of characters allowed in an entity state. required: false type: integer default: 100 initial: description: Initial value when Home Assistant starts. required: false type: string default: empty icon: description: Icon to display in front of the input element in the frontend. required: false type: icon pattern: description: Regex pattern for client side validation. required: false type: string default: empty mode: description: Can specify text or password. Elements of type "password" provide a way for the user to securely enter a value. required: false type: string default: text {% endconfiguration %}

Services

This integrations provide three services to modify the state of the input_text.

Service	Data	Description
set_value	value entity_id(s)	Set the value for specific input_text entities.

Restore State

This integration will automatically restore the state it had prior to Home Assistant stopping as long as your entity does not have a set value for initial. To disable this feature, set a valid value for initial.

Automation Examples

Here's an example using input_text in an action in an automation.

{% raw %}

# Example configuration.yaml entry using 'input_text' in an action in an automation
input_select:
  scene_bedroom:
    name: Scene
    options:
      - Select
      - Concentrate
      - Energize
      - Reading
      - Relax
      - 'OFF'
    initial: 'Select'
input_text:
  bedroom:
    name: Brightness
    
automation:
  - alias: Bedroom Light - Custom
    trigger:
      platform: state
      entity_id: input_select.scene_bedroom
    action:
      - service: input_text.set_value
        # Again, note the use of 'data_template:' rather than the normal 'data:' if you weren't using an input variable.
        data_template:
          entity_id: input_text.bedroom
          value: "{{ states('input_select.scene_bedroom') }}"

{% endraw %}