Home Assistant

https://www.home-assistant.io/docs/
Admin
Home Assistant is an open-source home automation platform that enables users to control, automate,...
Tokens:205,728
Snippets:1,735
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Example: !include_dir_merge_named - Original configuration.yaml

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Original configuration.yaml with groups defined inline. This is the starting point for splitting into a directory.

```yaml
group:
  bedroom:
    name: "Bedroom"
    entities:
      - light.bedroom_lamp
      - light.bedroom_overhead
  hallway:
    name: "Hallway"
    entities:
      - light.hallway
      - thermostat.home
  front_yard:
    name: "Front Yard"
    entities:
      - light.front_porch
      - light.security
      - light.pathway
      - sensor.mailbox
      - camera.front_porch
```

--------------------------------

### YAML action example: light.turn_on with brightness and rgb_color

Source: https://www.home-assistant.io/docs/tools/dev-tools

Example YAML for performing the light.turn_on action in YAML mode. It targets light.bedroom and sets brightness to 255 and rgb_color to [255, 0, 0]. This example is shown when selecting 'Fill example data'.

```yaml
action: light.turn_on
target:
  entity_id: light.bedroom
data:
  brightness: 255
  rgb_color: [255, 0, 0]

```

--------------------------------

### Media selector example output with multiple

Source: https://www.home-assistant.io/docs/blueprint/selectors

Example output when multiple is set to true, showing a list of media objects.

```yaml
- media_content_id: media-source://media_source/local/image1.jpg
  media_content_type: image/jpeg
  metadata:
    title: image1.jpg
- media_content_id: media-source://media_source/local/image2.jpg
  media_content_type: image/jpeg
  metadata:
    title: image2.jpg

```

--------------------------------

### states() function: example output

Source: https://www.home-assistant.io/docs/templating/states

Example output of the states() function for the light.kitchen entity, showing the state as 'on'.

```text
The kitchen light is on.
```

--------------------------------

### Included package file content example

Source: https://www.home-assistant.io/docs/configuration/packages

Shows the content of the `my_package.yaml` file that is included by the previous example.

```yaml
switch:
  - platform: rest
    ...
light:
  - platform: rpi
    ...

```

--------------------------------

### Result of the template example

Source: https://www.home-assistant.io/docs/configuration/templating

The output of the template example when the device_tracker.frenck is not home. The template renders the message with the current state of the device tracker.

```text
Frenck is at gym.

```

--------------------------------

### Media selector example output

Source: https://www.home-assistant.io/docs/blueprint/selectors

Example output of the media selector, including entity_id, media content details, and metadata.

```yaml
entity_id: media_player.living_room
media_content_id: media-source://tts/cloud?message=TTS+Message&language=en-US&gender=female
media_content_type: provider
metadata:
  title: TTS Message
  thumbnail: https://brands.home-assistant.io/_/cloud/logo.png
  media_class: app
  children_media_class: null
  navigateIds:
    - {}
    - media_content_type: app
      media_content_id: media-source://tts
    - media_content_type: provider
      media_content_id: >-
        media-source://tts/cloud?message=TTS+Message&language=en-US&gender=female

```

--------------------------------

### Example package file structure

Source: https://www.home-assistant.io/docs/configuration/packages

Example content for `packages/subsystem1/functionality1.yaml` when using `!include_dir_merge_named`. The top-level key `subsystem1_functionality1` is the package name, and the content is indented under it.

```yaml
subsystem1_functionality1:
  input_boolean:
  ...
  binary_sensor:
  ...
  automation:

```

--------------------------------

### Target selector with action example

Source: https://www.home-assistant.io/docs/blueprint/selectors

Example showing how to use the target selector with the `target` property of an action in a script sequence.

```yaml
actions:
  - action: light.turn_on
    target: !input lights

```

--------------------------------

### YAML automation example for configuration.yaml

Source: https://www.home-assistant.io/docs/automation/yaml

Example of a YAML-based automation that can be added to configuration.yaml. It includes multiple automation rules with triggers, conditions, and actions, such as turning on lights at sunset, turning off lights when everyone leaves, and sending notifications.

```yaml
# Example of entry in configuration.yaml
automation my_lights:
  # Turns on lights 1 hour before sunset if people are home
  # and if people get home between 16:00-23:00
  - alias: "Rule 1 Light on in the evening"
    triggers:
      # Prefix the first line of each trigger configuration
      # with a '-' to enter multiple
      - trigger: sun
        event: sunset
        offset: "-01:00:00"
      - trigger: state
        entity_id: all
        to: "home"
    conditions:
      # Prefix the first line of each condition configuration
      # with a '-'' to enter multiple
      - condition: state
        entity_id: all
        state: "home"
      - condition: time
        after: "16:00:00"
        before: "23:00:00"
    actions:
      # With a single action entry, we don't need a '-' before action - though you can if you want to
      - action: homeassistant.turn_on
        target:
          entity_id: light.living_room

  # Turn off lights when everybody leaves the house
  - alias: "Rule 2 - Away Mode"
    triggers:
      - trigger: state
        entity_id: all
        to: "not_home"
    actions:
      - action: light.turn_off
        target:
          entity_id: all

  # Notify when Paulus leaves the house in the evening
  - alias: "Leave Home notification"
    triggers:
      - trigger: zone
        event: leave
        zone: zone.home
        entity_id: device_tracker.paulus
    conditions:
      - condition: time
        after: "20:00"
    actions:
      - action: notify.notify
        data:
          message: "Paulus left the house"

  # Send a notification via Pushover with the event of a Xiaomi cube. Custom event from the Xiaomi integration.
  - alias: "Xiaomi Cube Action"
    initial_state: false
    triggers:
      - trigger: event
        event_type: cube_action
        event_data:
          entity_id: binary_sensor.cube_158d000103a3de
    actions:
      - action: notify.pushover
        data:
          title: "Cube event detected"
          message: "Cube has triggered this event: {{ trigger.event }}"
```

--------------------------------

### Configure auth_providers in configuration.yaml

Source: https://www.home-assistant.io/docs/authentication/providers

Example YAML configuration for authentication providers. Always include type: homeassistant as a fallback to avoid lockout and unauthenticated access. This example adds trusted_networks for the 192.168.0.0/24 network.

```yaml
homeassistant:
  auth_providers:
    - type: homeassistant
    - type: trusted_networks
      trusted_networks:
        - 192.168.0.0/24
```

--------------------------------

### strip method example

Source: https://www.home-assistant.io/docs/templating/python-methods

Removes whitespace from the start and end of a piece of text.

```jinja
'{{ '  hello world  '.strip() }}'
```

```text
'hello world'
```

--------------------------------

### Example: !include_dir_list - configuration.yaml after

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Configuration.yaml using `!include_dir_list` to include all files in the automation/presence/ directory.

```yaml
automation: !include_dir_list automation/presence/
```

--------------------------------

### Example: !include_dir_list - configuration.yaml before

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Original configuration.yaml with two automation entries that will be replaced by a directory include.

```yaml
automation:
  - alias: "Automation 1"
    triggers:
      - trigger: state
        entity_id: device_tracker.iphone
        to: "home"
    actions:
      - action: light.turn_on
        target:
          entity_id: light.entryway
  - alias: "Automation 2"
    triggers:
      - trigger: state
        entity_id: device_tracker.iphone
        from: "home"
    actions:
      - action: light.turn_off
        target:
          entity_id: light.entryway
```

--------------------------------

### Include package configuration example

Source: https://www.home-assistant.io/docs/configuration/packages

Shows how to include a package from a separate YAML file using `!include` in the main `configuration.yaml`.

```yaml
homeassistant:
  ...
  packages:
    pack_1: !include my_package.yaml

```

--------------------------------

### Countdown to future date with time_until

Source: https://www.home-assistant.io/docs/templating/dates-and-times

Use time_until with a future datetime to get a human-readable countdown. The example parses a date string with strptime and displays the time until Christmas.

```jinja
{% set birthday = strptime('2026-12-25', '%Y-%m-%d') %}
Christmas: {{ time_until(birthday) }}
```

```text
Christmas: 8 months
```

--------------------------------

### If-then YAML example

Source: https://www.home-assistant.io/docs/scripts

YAML configuration for an If-then block. It checks if no one is home, then starts the vacuum, otherwise sends a notification. Use this as a template for conditional actions in automations or scripts.

```yaml
if:
  - alias: "If no one is home"
    condition: state
    entity_id: zone.home
    state: "0"
then:
  - alias: "Then start cleaning already!"
    action: vacuum.start
    target:
      area_id: living_room
else:
  - action: notify.notify
    data:
      message: "Skipped cleaning, someone is home!"
```

--------------------------------

### Example: !include_dir_named - configuration.yaml before

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Original configuration.yaml with Alexa intents that will be replaced by a directory include.

```yaml
alexa:
  intents:
    LocateIntent:
      actions:
        action: notify.pushover
        data:
          message: "Your location has been queried via Alexa."
      speech:
        type: plaintext
        text: >
          {%- for state in states.device_tracker -%}
            {%- if state.name.lower() == User.lower() -%}
              {{ state.name }} is at {{ state.state }}
            {%- endif -%}
          {%- else -%}
            I am sorry. Pootie! I do not know where {{User}} is.
          {%- endfor -%}
    WhereAreWeIntent:
      speech:
        type: plaintext
        text: >
          {%- if is_state('device_tracker.iphone', 'home') -%}
            iPhone is home.
          {%- else -%}
            iPhone is not home.
          {% endif %}
```

--------------------------------

### Inline package configuration example

Source: https://www.home-assistant.io/docs/configuration/packages

Shows how to define a package inline in the main `configuration.yaml` file, including switch and light platforms.

```yaml
homeassistant:
  ...
  packages:
    pack_1:
      switch:
        - platform: rest
          ...
      light:
        - platform: rpi
          ...

```

--------------------------------

### Meta variables output format

Source: https://www.home-assistant.io/docs/authentication/providers

Example of the standard output format for meta variables when meta: true is enabled. Variables are printed as key = value lines; leading/trailing whitespace and lines starting with # are ignored.

```txt
name = John Doe
group = system-users
local_only = true
```

--------------------------------

### Macro that returns a value using as_function

Source: https://www.home-assistant.io/docs/templating/custom-templates

Defines a macro that takes a special 'returns' argument and uses the as_function filter to make it return a boolean. The example checks if an entity ID starts with 'switch.' and outputs a message accordingly.

```jinja
{% macro macro_is_switch(entity_name, returns) -%}
  {% do returns(entity_name.startswith('switch.')) %}
{% endmacro -%}
{% set is_switch = macro_is_switch | as_function -%}
{% set result = "It's a switch!" if is_switch('switch.my_switch')
else "Not a switch!" -%}
{{ result }}
```

```text
It's a switch!
```

--------------------------------

### YAML example: flash_light and flash_hallway_light scripts

Source: https://www.home-assistant.io/docs/scripts

Two scripts: flash_light repeats a light toggle a specified number of times using the repeat block with a template count, and flash_hallway_light calls flash_light with light=hallway and count=3. The count template is rendered when the repeat starts.

```yaml
flash_light:
  mode: restart
  sequence:
    - action: light.turn_on
      target:
        entity_id: "light.{{ light }}"
    - alias: "Cycle light 'count' times"
      repeat:
        count: "{{ count | int * 2 - 1 }}"
        sequence:
          - delay: 2
          - action: light.toggle
            target:
              entity_id: "light.{{ light }}"
flash_hallway_light:
  sequence:
    - alias: "Flash hallway light 3 times"
      action: script.flash_light
      data:
        light: hallway
        count: 3
```

--------------------------------

### Example: !include_dir_named - configuration.yaml after

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Configuration.yaml using `!include_dir_named` to include all files in the alexa/ directory.

```yaml
alexa:
  intents: !include_dir_named alexa/
```

--------------------------------

### Example: !include_dir_merge_list - Split configuration.yaml and automation/presence.yaml

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

The configuration.yaml is replaced with a single line using !include_dir_merge_list, and the automations are moved to automation/presence.yaml. Each file must contain a list of entries.

```yaml
automation: !include_dir_merge_list automation/
```

```yaml
- alias: "Automation 1"
  triggers:
    - trigger: state
      entity_id: device_tracker.iphone
      to: "home"
  actions:
    - action: light.turn_on
      target:
        entity_id: light.entryway
- alias: "Automation 2"
  triggers:
    - trigger: state
      entity_id: device_tracker.iphone
      from: "home"
  actions:
    - action: light.turn_off
      target:
        entity_id: light.entryway
```

--------------------------------

### Example trigger selector output result

Source: https://www.home-assistant.io/docs/blueprint/selectors

Shows an example output of the trigger selector, containing a list of triggers. This example includes a numeric_state trigger with an entity_id and below threshold.

```yaml
# Example trigger selector output result
- trigger: numeric_state
  entity_id: "sensor.outside_temperature"
  below: 20

```

--------------------------------

### Example: Combine !include_dir_merge_list with automations.yaml

Source: https://www.home-assistant.io/docs/configuration/splitting_configuration

Shows how to split automations while still being able to create them in the UI. Uses labels 'manual' and 'ui' to separate handmade and UI-created automations.

```yaml
# My own handmade automations
automation manual: !include_dir_merge_list automations/

# Automations I create in the UI
automation ui: !include automations.yaml
```

--------------------------------

### Perform action in YAML: light.turn_on

Source: https://www.home-assistant.io/docs/scripts

Use the action key with the action name, and optionally target and data. This example turns on the bedroom light with brightness 100.

```yaml
alias: "Bedroom lights on"
action: light.turn_on
target:
  entity_id: light.bedroom
data:
  brightness: 100

```

--------------------------------

### Location selector example output

Source: https://www.home-assistant.io/docs/blueprint/selectors

Example output of the location selector, showing latitude, longitude, and optional radius.

```yaml
latitude: 50.935
longitude: 6.95
radius: 500 # Only provided when radius was set to true.

```

--------------------------------

### Entity ID key uniqueness example

Source: https://www.home-assistant.io/docs/configuration/packages

Shows an example of an `input_boolean` configuration with a key `my_input` that cannot be reused in a package.

```yaml
input_boolean:
  my_input:

```

--------------------------------

### Choose in YAML with morning, day, and night options

Source: https://www.home-assistant.io/docs/scripts

YAML example of the choose action with multiple options and a default sequence. The first option whose conditions are met runs its sequence; if none match, the default runs. This example runs different scripts and turns off lights based on the time of day.

```yaml
triggers:
  - trigger: state
    entity_id: input_boolean.simulate
    to: "on"
mode: restart
actions:
  - choose:
      # IF morning
      - conditions:
          - condition: template
            value_template: "{{ now().hour < 9 }}"
        sequence:
          - action: script.sim_morning
      # ELIF day
      - conditions:
          - condition: template
            value_template: "{{ now().hour < 18 }}"
        sequence:
          - action: light.turn_off
            target:
              entity_id: light.living_room
          - action: script.sim_day
    # ELSE night
    default:
      - action: light.turn_off
        target:
          entity_id: light.kitchen
      - delay:
          minutes: "{{ range(1, 11) | random }}"
      - action: light.turn_off
        target:
          entity_id: all
```

--------------------------------

### Convert sensor state to number: example output

Source: https://www.home-assistant.io/docs/templating/states

Example output of the float conversion template, showing the result 27.5.

```text
27.5
```
Tokens:
Raw