Qortora · Search · Indexed page

www.home-assistant.ioFetched 2026-08-13T19:50:20Z

Selectors - Home Assistant

Documentation on available selectors.

Open original source · Full cached text

Selectors - Home Assistant 2026.8.1 Getting started Documentation Installation Automations Dashboards Voice assistants Device organization Energy management Templating Configuration using the YAML file Our hardware Home Assistant Green Connect ZBT-2 Connect ZWA-2 Voice Preview Edition Integrations Blog Need help? On this page Action selector App selector Area selector Example area selectors Attribute selector Assist pipeline selector Backup location selector Boolean selector Choose selector Example choose selector Color temperature selector Condition selector Config entry selector Constant selector Conversation agent selector Country selector Date selector Date & time selector Device selector Example device selector Duration selector Entity selector Example entity selector Floor selector Example floor selectors Icon selector Label selector Language selector Location selector Media selector Number selector Example number selectors Object selector QR code selector RGB color selector Select selector State selector Statistic selector Target selector Example target selectors Template selector Text selector Theme selector Time selector Trigger selector Example - Merging with existing triggers Home ▸ Documentation ▸ Blueprint Selectors Selectors can be used to specify what values are accepted for a blueprint input. The selector also defines how the input is shown in the user interface. Some selectors can, for example, show a toggle button to turn something on or off, while another select can filter a list of devices to show only devices that have motion-sensing capabilities. Having good selectors set on your blueprint automation inputs makes a blueprint easier to use from the UI. The following selectors are currently available: Action selector App selector Area selector Attribute selector Assist pipeline selector Backup location selector Boolean selector Choose selector Color temperature selector Condition selector Config entry selector Constant selector Conversation agent selector Country selector Date selector Date & time selector Device selector Duration selector Entity selector Floor selector Icon selector Label selector Language selector Location selector Media selector Number selector Object selector QR code selector RGB color selector Select selector State selector Statistic selector Target selector Template selector Text selector Theme selector Time selector Trigger selector Example - Merging with existing triggers Interactive demos of each of these selectors can be found on the Home Assistant Design portal. If no selector is defined, a text input for a single line will be shown. Action selector The action selector allows you to input one or more sequences of actions. On the user interface, the action part of the automation editor will be shown. The value of the input will contain a list of actions to perform. This selector does not have any other options; therefore, it only has its key. action: The output of this selector is a list of actions. For example: # Example action selector output result - action: scene.turn_on target: entity_id: scene.watching_movies metadata: {} App selector This can only be used on a Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users. installation. For Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI compatible runtime can be used, but the documentation focus is on Docker. [Learn more] installations, an error will be displayed. The app selector (formerly known as add-on selector) allows you to input an app slug. On the user interface, it will list all installed Home Assistant apps and use the slug of the selected app. This selector does not have any other options; therefore, it only has its key. # Example app selector app: The output of this selector is the slug of the selected app. For example: core_ssh. Area selector The area selector shows an area finder that can pick a single or multiple areas based on the selector configuration. The value of the input will be the area ID, or a list of area IDs, based on if multiple is set to true. An area selector can filter the list of areas, based on properties of the devices and entities that are assigned to those areas. For example, the areas list could be limited to areas with entities provided by the ZHA integration. In its most basic form, this selector doesn’t require any options, which will show all areas. area: Configuration Variables Looking for your configuration file? device list (Optional) When device options are provided, the list of areas is filtered by areas that at least provide one device that matches the given conditions. Can be either an object or a list of objects. integration string (Optional) Can be set to an integration domain. Limits the list of areas that provide devices by the set integration domain, for example, zha. manufacturer string (Optional) When set, it limits the list of areas that provide devices by the set manufacturer name. model string (Optional) When set, it limits the list of areas that provide devices that have the set model. model_id string (Optional) When set, the list of areas is limited to areas with devices that have the set model ID. entity list (Optional) When entity options are provided, the list of areas is filtered by areas that at least provide one entity that matches the given conditions. Can be either a object or a list of object. integration string (Optional) Can be set to an integration domain. Limits the list of areas that provide entities by the set integration domain, for example, zha. domain string | list (Optional) Limits the list of areas that provide entities of a certain domain(s), for example, light or binary_sensor. Can be either a string with a single domain, or a list of string domains to limit the selection to. device_class device_class | list (Optional) Limits the list of areas to areas that have entities with a certain device class(es), for example, motion or window. Can be either a string with a single device_class, or a list of string device_class to limit the selection to. supported_features list (Optional) Limits the list of areas to areas that have entities with a certain supported feature, for example, light.LightEntityFeature.TRANSITION or climate.ClimateEntityFeature.TARGET_TEMPERATURE. Should be a list of features. For a list of supported features for each entity type, refer to the entity documentation. multiple boolean (Optional, default: false) Allows selecting multiple areas. If set to true, the resulting value of this selector will be a list instead of a single string value. reorder boolean (Optional, default: false) Allows reordering of areas (only applies if multiple is set to true). The output of this selector is the area ID, or (in case multiple is set to true) a list of area IDs. # Example area selector output result, when multiple is set to false living_room # Example area selector output result, when multiple is set to true - living_room - kitchen Example area selectors An example area selector only shows areas that provide one or more lights or switches provided by the ZHA integration. area: entity: integration: zha domain: - light - switch Another example uses the area selector, which only shows areas that provide one or more remote controls provided by the deCONZ integration. Multiple areas can be selected. area: multiple: true device: - integration: deconz manufacturer: IKEA of Sweden model: TRADFRI remote control Attribute selector The attributes selector shows a list of state attributes from a provided entity of which one can be selected. This allows for selecting, for example, the “Effect” attribute from a light entity, or the “Next dawn” attribute from the sun entity. Configuration Variables Looking for your configuration file? entity_id string Required The entity ID of which a state attribute can be selected from. The output of this selector is the selected attribute key (not the translated or prettified name shown in the frontend). For example: next_dawn. Assist pipeline selector The assist pipeline selector shows all available assist pipelines (assistants) of which one can be selected. This selector does not have any other options; therefore, it only has its key. assist_pipeline: Backup location selector This can only be used on an installation with a Home Assistant Operating SystemHome Assistant OS, the Home Assistant Operating System, is an embedded, minimalistic, operating system designed to run the Home Assistant ecosystem on single board computers (like the Raspberry Pi) or Virtual Machines. It includes Home Assistant Core, the Home Assistant Supervisor, and supports apps. Home Assistant Supervisor keeps it up to date, removing the need for you to manage an operating system. Home Assistant Operating System is the recommended installation type for most users.. For Home Assistant ContainerHome Assistant Container is a standalone container-based installation of Home Assistant Core. Any OCI compatible runtime can be used, but the documentation focus is on Docker. [Learn more] installations, an error will be displayed. The backup location selector shows a list of places a backup could go, depending on what you have configured in storage. The output of this selector is the name of the selected network storage. It may also be the value /backup, if the user chooses to use the local data disk option instead of one of the configured network storage locations. backup_location: Boolean selector The boolean selector shows a toggle that allows you to turn on or off the selected option. The boolean selector is suitable for adding feature switches to, for example, blueprints. This selector does not have any other options; therefore, it only has its key. boolean: The output of this selector is true when the toggle is on, false otherwise. Choose selector The choose selector allows you to present multiple selectors to the user for a single field, and the user can pick a desired selector and enter a value using that selection. choose: Configuration Variables Looking for your configuration file? choices map Required A dictionary of choices for the choose option. Each key in the dictionary represents one selector choice, and the string value of the key will be displayed in the selector picker. Each entry is itself another dictionary, with one mandatory key of “selector”, and the value of that key is any other valid selector definition. The output of a choose selector is an object with one key called ‘active_choice’ representing which selector was chosen, and one key per selector choice representing the value entered for that choice. Example choose selector An example choose selector that allows user to either select an icon from a dropdown, or enter an arbitrary template. choose: choices: Icon: selector: icon: {} Template: selector: template: {} Following this example, if the user entered a value in both selectors, but submitted with ‘Icon’ option selected, the output might be: active_choice: Icon Icon: mdi:light Template: "{{ something else }}" Color temperature selector The color temperature selector allows you to select a color temperature from a gradient using a slider. color_temp: Configuration Variables Looking for your configuration file? unit string (Optional, default: mired) The chosen unit for the color temperature. This can be either kelvin or mired. mired is the default for historical reasons. min integer (Optional) The minimum color temperat…