ESPHome Components

https://esphome.io/components/
Admin
Complete documentation for ESPHome components covering sensors, displays, connectivity, climate...
Tokens:906,520
Snippets:6,995
Trust Score:9.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### Test setup action data example

Source: https://esphome.io/components/hlk_fm22x

Example action data for calling the enroll action from Home Assistant developer tools. Select the action esphome.test_node_enroll and enter this JSON.

```json
{ "name": "My name", "direction": 1 }

```

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

### Start animations with lvgl.animation.start

Source: https://esphome.io/components/lvgl/animation

Example YAML showing how to start a single animation by ID and how to start multiple animations while overriding duration and loop options.

```yaml
on_...:
  then:
    # Start a single animation by ID
    - lvgl.animation.start: slide


    # Start several, overriding some options
    - lvgl.animation.start:
        id:
          - slide
          - fade
        duration: 2s
        loop: false

```

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

### Full configuration example with boot read and network sync

Source: https://esphome.io/components/time/ds1307

Full configuration example showing a typical setup: read the RTC once at boot, disable periodic RTC reads, and use a Home Assistant time source to synchronize the RTC after network time sync.

```yaml
esphome:
  on_boot:
    then:
      # read the RTC time once when the system boots
      ds1307.read_time:


time:
  - platform: ds1307
    # repeated synchronization is not necessary unless the external RTC
    # is much more accurate than the internal clock
    update_interval: never
  - platform: homeassistant
    # instead try to synchronize via network repeatedly ...
    on_time_sync:
      then:
        # ... and update the RTC when the synchronization was successful
        ds1307.write_time:

```

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

### rp2_ble_tracker.start_scan YAML configuration example

Source: https://esphome.io/components/rp2_ble_tracker

Shows a complete YAML configuration using rp2_ble_tracker.start_scan with a templatable 'continuous' override. The example starts a continuous scan when a client connects and stops it when all subscribed clients disconnect, using api.connected with state_subscription_only to ignore logger-only clients.

```yaml
rp2_ble_tracker:
  scan_parameters:
    continuous: false


api:
  on_client_connected:
    - rp2_ble_tracker.start_scan:
        continuous: true
  on_client_disconnected:
    # fires for EVERY departing client (log viewer, CLI) — state_subscription_only
    # ignores logger-only clients, so scanning stops only when Home Assistant is gone
    - if:
        condition:
          not:
            api.connected:
              state_subscription_only: true
        then:
          - rp2_ble_tracker.stop_scan:

```

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

### Full configuration example with external time sync

Source: https://esphome.io/components/time/rx8130

Complete setup that reads the RTC at boot, disables periodic RTC updates, and writes the RTC after a successful network time sync. Uses the homeassistant time platform as the external source.

```yaml
esphome:
  on_boot:
    then:
      # read the RTC time once when the system boots
      rx8130.read_time:


time:
  - platform: rx8130
    # repeated synchronization is not necessary unless the external RTC
    # is much more accurate than the internal clock
    update_interval: never
    timezone: Europe/Paris
  - platform: homeassistant
    # instead try to synchronize via network repeatedly ...
    on_time_sync:
      then:
        # ... and update the RTC when the synchronization was successful
        rx8130.write_time:

```

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

### Example configuration entry for web_server

Source: https://esphome.io/components/web_server

Minimal configuration to enable the web server on port 80. This is the basic setup required to access the web interface via browser or REST API.

```yaml
# Example configuration entry
web_server:
  port: 80

```

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

### Send FollowMe commands and control display with Remote Transmitter

Source: https://esphome.io/components/climate/midea

Example configuration for sending FollowMe commands with sensor values and controlling the LED display. Includes remote_transmitter setup, a homeassistant sensor with filters, and template buttons for display toggle and swing step actions.

```yaml
# Example configuration entry


remote_transmitter:
  pin: GPIO13                       # For iot-uni-stick.
  carrier_duty_percent: 100%        # 50% for IR LED, 100% for direct connect to TSOP IR receiver output.


sensor:
  - platform: homeassistant
    entity_id: sensor.room_sensor   # Sensor from HASS
    internal: true
    filters:
      - throttle: 10s
      - heartbeat: 2min             # Maximum interval between updates.
      - debounce: 1s
    on_value:
      midea_ac.follow_me:
        temperature: !lambda "return x;"
        beeper: false               # Optional. Beep on update.


# template buttons for sending display control command and swing step actions
button:
  - platform: template
    name: Display Toggle
    icon: mdi:theme-light-dark
    on_press:
      midea_ac.display_toggle:
  - platform: template
    name: Swing Step
    icon: mdi:tailwind
    on_press:
      midea_ac.swing_step:

```

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

### Packet Transport Example Configuration

Source: https://esphome.io/components/packet_transport

Shows a complete example configuration for the packet_transport component, including the main component setup with optional encryption and rolling code, plus sensor and binary_sensor platform configurations. The example includes placeholders like 'REPLACEME' for the encryption key and '...' for the platform.

```yaml
# Example configuration entry
packet_transport:
  platform: ...
  update_interval: 5s
  encryption: "REPLACEME"
  rolling_code_enable: true
  binary_sensors:
    - binary_sensor_id1
  sensors:
    - sensor_id1
    - id: sensor_id2
      broadcast_id: different_id
  providers:
    - name: device1-name
      encryption: "REPLACEME"


sensor:
  - platform: packet_transport
    provider: device1-name
    id: local_sensor_id
    remote_id: some_sensor_id


binary_sensor:
  - platform: packet_transport
    provider: device2-name
    type: data                  # Optional, defaults to 'data'
    id: other_binary_sensor_id  # also used as remote_id


  - platform: packet_transport
    provider: device1-name
    type: status
    name: Device 1 connection status

```

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

### Test setup

Source: https://esphome.io/components/dfplayer

Sample configuration to set up a node and expose DFPlayer actions as Home Assistant services.

```APIDOC
## Test setup

### Description
With the following code you can quickly setup a node and use Home Assistant's service in the developer tools. E.g. for calling `dfplayer.play_folder` select the service `esphome.test_node_dfplayer_play` and in service data enter `{ "file": 23 }`.

### Sample code
yaml
uart:
  tx_pin: GPIOXX
  rx_pin: GPIOXX
  baud_rate: 9600


dfplayer:
  on_finished_playback:
    then:
      logger.log: 'Playback finished event'


api:
  actions:
  - action: dfplayer_next
    then:
      - dfplayer.play_next:
  - action: dfplayer_previous
    then:
      - dfplayer.play_previous:
  - action: dfplayer_play
    variables:
      file: int
    then:
      - dfplayer.play: !lambda 'return file;'
  - action: dfplayer_play_loop
    variables:
      file: int
      loop_: bool
    then:
      - dfplayer.play:
          file: !lambda 'return file;'
          loop: !lambda 'return loop_;'
  - action: dfplayer_play_folder
    variables:
      folder: int
      file: int
    then:
      - dfplayer.play_folder:
          folder: !lambda 'return folder;'
          file: !lambda 'return file;'


  - action: dfplayer_play_loop_folder
    variables:
      folder: int
    then:
      - dfplayer.play_folder:
          folder: !lambda 'return folder;'
          loop: true


  - action: dfplayer_set_device_tf
    then:
      - dfplayer.set_device: TF_CARD


  - action: dfplayer_set_device_usb
    then:
      - dfplayer.set_device: USB


  - action: dfplayer_set_volume
    variables:
      volume: int
    then:
      - dfplayer.set_volume: !lambda 'return volume;'
  - action: dfplayer_set_eq
    variables:
      preset: int
    then:
      - dfplayer.set_eq: !lambda 'return static_cast<dfplayer::EqPreset>(preset);'


  - action: dfplayer_sleep
    then:
      - dfplayer.sleep


  - action: dfplayer_reset
    then:
      - dfplayer.reset


  - action: dfplayer_start
    then:
      - dfplayer.start


  - action: dfplayer_pause
    then:
      - dfplayer.pause


  - action: dfplayer_stop
    then:
      - dfplayer.stop


  - action: dfplayer_random
    then:
      - dfplayer.random


  - action: dfplayer_volume_up
    then:
      - dfplayer.volume_up


  - action: dfplayer_volume_down
    then:
      - dfplayer.volume_down


```

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

### ESPHome ESP8266 GPIO example configuration

Source: https://esphome.io/components/esp8266

Example configuration entry for ESPHome using an ESP8266 board (nodemcuv2) with a binary sensor on pin GPIO17. Use this as a starting point for projects that need to reference pins by their internal GPIO numbers.

```yaml
# Example configuration entry
esphome:
  name: livingroom


esp8266:
  board: nodemcuv2


binary_sensor:
  - platform: gpio
    name: "Pin GPIO17"
    pin: GPIO17

```

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

### Complex example: mapping to color and string with display lambda

Source: https://esphome.io/components/mapping

A more complex example showing mappings to color and string, with color and font definitions, and a display lambda that uses get() and [] to index the maps. Also shows updating a map at runtime with set().

```yaml
mapping:
  - id: color_map
    from: int
    to: color
    entries:
      0: red
      1: green
      2: blue
  - id: string_map
    from: int
    to: string
    entries:
      0: red
      1: green
      2: blue


color:
  - id: red
    hex: FF0000
  - id: green
    hex: 00FF00
  - id: blue
    hex: 0000FF


font:
  - file: gfonts://Roboto
    id: roboto20
    size: 20
    bpp: 4


display:
  - platform: ...
    # update the display drawing random text in random colors
    lambda: |-
      auto color = color_map.get(random_uint32() % 3); # Uses get() to index the color_map
      it.printf(100, 100, id(roboto20), color, id(string_map)[random_uint32() % 3].c_str(), Color(0));


    on_...:
      then:
        - lambda: |-
              id(color_map).set(2, Color::random_color());
```

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

### rp2_ble_tracker.stop_scan Action

Source: https://esphome.io/components/rp2_ble_tracker

Stops the running Bluetooth scan; also cancels a start latched before setup. Accepts the bare-id shorthand and can be restarted with rp2_ble_tracker.start_scan.

```APIDOC
## rp2_ble_tracker.stop_scan Action

### Description
Stop the running Bluetooth scan; also cancels a start latched before setup. Accepts the bare-id shorthand (`rp2_ble_tracker.stop_scan: my_tracker`). It can be restarted with `rp2_ble_tracker.start_scan`.

### Usage
```yaml
on_...:
  - rp2_ble_tracker.stop_scan:
```

### See Also
- RP2 Platform
- RP2040 BLE
- ESP32 BLE Tracker
- Bluetooth Proxy
- API Reference: rp2_ble_tracker.h
```

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

### light.effect.next and light.effect.previous Actions Example

Source: https://esphome.io/components/light

YAML example for cycling through light effects using light.effect.next and light.effect.previous. Shows both long and shorthand syntax, and includes include_none: true to include 'None' as a step.

```yaml
on_...:
  then:
    - light.effect.next:
        id: light_1
    # Shorthand
    - light.effect.next: light_1
    - light.effect.previous:
        id: light_1
        include_none: true

```

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

### Test Setup with API Actions

Source: https://esphome.io/components/dfplayer

Complete test setup for a node with UART, DFPlayer, and API actions. Use Home Assistant's developer tools to call the exposed services (e.g., esphome.test_node_dfplayer_play).

```yaml
uart:
  tx_pin: GPIOXX
  rx_pin: GPIOXX
  baud_rate: 9600


dfplayer:
  on_finished_playback:
    then:
      logger.log: 'Playback finished event'


api:
  actions:
  - action: dfplayer_next
    then:
      - dfplayer.play_next:
  - action: dfplayer_previous
    then:
      - dfplayer.play_previous:
  - action: dfplayer_play
    variables:
      file: int
    then:
      - dfplayer.play: !lambda 'return file;'
  - action: dfplayer_play_loop
    variables:
      file: int
      loop_: bool
    then:
      - dfplayer.play:
          file: !lambda 'return file;'
          loop: !lambda 'return loop_;'
  - action: dfplayer_play_folder
    variables:
      folder: int
      file: int
    then:
      - dfplayer.play_folder:
          folder: !lambda 'return folder;'
          file: !lambda 'return file;'


  - action: dfplayer_play_loop_folder
    variables:
      folder: int
    then:
      - dfplayer.play_folder:
          folder: !lambda 'return folder;'
          loop: true


  - action: dfplayer_set_device_tf
    then:
      - dfplayer.set_device: TF_CARD


  - action: dfplayer_set_device_usb
    then:
      - dfplayer.set_device: USB


  - action: dfplayer_set_volume
    variables:
      volume: int
    then:
      - dfplayer.set_volume: !lambda 'return volume;'
  - action: dfplayer_set_eq
    variables:
      preset: int
    then:
      - dfplayer.set_eq: !lambda 'return static_cast<dfplayer::EqPreset>(preset);'


  - action: dfplayer_sleep
    then:
      - dfplayer.sleep


  - action: dfplayer_reset
    then:
      - dfplayer.reset


  - action: dfplayer_start
    then:
      - dfplayer.start


  - action: dfplayer_pause
    then:
      - dfplayer.pause


  - action: dfplayer_stop
    then:
      - dfplayer.stop


  - action: dfplayer_random
    then:
      - dfplayer.random


  - action: dfplayer_volume_up
    then:
      - dfplayer.volume_up


  - action: dfplayer_volume_down
    then:
      - dfplayer.volume_down

```

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

### Enable esp32_touch hub with setup_mode

Source: https://esphome.io/components/binary_sensor/esp32_touch

Minimal configuration to enable the esp32_touch hub. setup_mode is optional and defaults to false; when true, debug messages with touch pad values are logged to help find suitable thresholds for binary sensors.

```yaml
# Example configuration entry
esp32_touch:
  setup_mode: false

```

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

### ota.http_request.flash action example

Source: https://esphome.io/components/ota/http_request

Triggers the OTA update from a configured URL. The device reboots after installation, so subsequent actions like logger.log may not execute.

```yaml
on_...:
  then:
    - ota.http_request.flash:
        md5_url: http://example.com/firmware.md5
        url: https://example.com/firmware.ota.bin
    - logger.log: "This message should be not displayed because the device reboots"

```

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

### example.yaml with substitution placeholder

Source: https://esphome.io/components/substitutions

Base configuration file using a substitution placeholder for the device name. The substitution is overridden from the command line.

```yaml
substitutions:
  name: my_default_name


esphome:
  name: $name

```

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

### MCP9808 sensor configuration

Source: https://esphome.io/components/sensor/mcp9808

Example configuration entry for the MCP9808 sensor. Requires I²C bus setup. Defaults to address 0x18 and update_interval 60s.

```yaml
# Example configuration entry
sensor:
  - platform: mcp9808
    name: "Living Room Temperature"
    update_interval: 60s

```

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

### Example configuration entry

Source: https://esphome.io/components/mqtt

Minimal configuration to connect to an MQTT broker with authentication. The broker is required; username and password are optional.

```yaml
mqtt:
  broker: 10.0.0.2
  username: livingroom
  password: !secret mqtt_password

```

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

### 6 Channel BL0906 Configuration

Source: https://esphome.io/components/sensor/bl0906

Example configuration for a 6-channel BL0906 sensor, extending the 2-channel setup with channels 3 through 6, each with current, power, and energy sensors.

```yaml
# Example configuration entry
sensor:
  - platform: bl0906
    frequency:
      name: 'Frequency'
    temperature:
      name: 'Temperature'
    voltage:
      name: 'Voltage'
    channel_1:
      current:
        name: 'Current_1'
      power:
        name: 'Power_1'
      energy:
        name: 'Energy_1'
    channel_2:
      current:
        name: 'Current_2'
      power:
        name: 'Power_2'
      energy:
        name: 'Energy_2'
    channel_3:
      current:
        name: 'Current_3'
      power:
        name: 'Power_3'
      energy:
        name: 'Energy_3'
    channel_4:
      current:
        name: 'Current_4'
      power:
        name: 'Power_4'
      energy:
        name: 'Energy_4'
    channel_5:
      current:
        name: 'Current_5'
      power:
        name: 'Power_5'
      energy:
        name: 'Energy_5'
    channel_6:
      current:
        name: 'Current_6'
      power:
        name: 'Power_6'
      energy:
        name: 'Energy_6'
    total_energy:
      name: 'Total_Energy'
    total_power:
      name: 'Total_Power'

```

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

### rp2_ble_tracker.stop_scan YAML example

Source: https://esphome.io/components/rp2_ble_tracker

Stops the running Bluetooth scan and cancels a latched start. Use in an automation's on_... trigger. The action can be restarted with rp2_ble_tracker.start_scan.

```yaml
on_...:
  - rp2_ble_tracker.stop_scan:

```

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

### Apply styles to a widget state (checked state example)

Source: https://esphome.io/components/lvgl/widgets

Shows how to activate a state at boot and apply styles to that state. The state must be specified one level above the style definitions. Here, the 'checked' state is activated and a green background color is applied when the widget is checked.

```yaml
- button:
    checkable: true
    state:
      checked: true # here you activate the state to be used at boot
    checked:
      bg_color: 0x00FF00 # here you apply styles to be used when in the respective state

```

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

### hlk_fm22x.enroll Action - Start Enrollment

Source: https://esphome.io/components/hlk_fm22x

Starts the face enrollment process with a name and direction. Requires consecutive successful scans from all directions; a failure restarts the process. The direction is a bitmask: 1 for center, 2 for right, 4 for left, 8 for down, 16 for up. The example also publishes a visual feedback message.

```yaml
on_...:
  then:
    - hlk_fm22x.enroll:
        name: "My name"
        direction: 1
    # Update the template text sensor for visual feedback
    - text_sensor.template.publish:
        id: face_state
        state: "Look directly at the camera"

```

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

### Configure ESP32 Touch Hub in setup_mode to find thresholds

Source: https://esphome.io/components/binary_sensor/esp32_touch

Use this configuration to log raw touch values from the ESP32 touch hub. Set setup_mode to true, add binary sensors for the touch pads, and use temporary threshold values (e.g., 1000) to satisfy the validator. After determining suitable thresholds, set setup_mode back to false to avoid performance degradation.

```yaml
# Example configuration entry for finding threshold values
esp32_touch:
  setup_mode: true


binary_sensor:
  - platform: esp32_touch
    name: "ESP32 Touch Pad GPIO27"
    pin: GPIO27
    threshold: 1000

```

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

### light.turn_on Brightness Multiplication Example

Source: https://esphome.io/components/light

Shows how master brightness and separate color/white brightness controls multiply together. This results in color at 40% brightness and white at 60% brightness.

```yaml
- light.turn_on:
    id: light_1
    brightness: 80%
    color_brightness: 50%
    white: 75%

```

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

### UART Configuration Example

Source: https://esphome.io/components/uart

Basic YAML configuration for a UART bus, setting TX and RX pins and baud rate. Use this as a starting point for connecting serial devices.

```yaml
uart:
  tx_pin: GPIOXX
  rx_pin: GPIOXX
  baud_rate: 9600
```

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

### sprinkler.set_multiplier Action Example

Source: https://esphome.io/components/sprinkler

Sets the multiplier used to proportionally adjust run durations for all valves. A multiplier of zero prevents any valve from starting, which can cause confusing behavior if not visually indicated.

```yaml
on_...:
  then:
    - sprinkler.set_multiplier:
        id: sprinkler_ctrlr
        multiplier: 1.5

```

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

### Example configuration entry

Source: https://esphome.io/components/camera/camera_encoder

Minimal YAML configuration to enable the camera_encoder component with default settings.

```yaml
camera_encoder:
```

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

### Local packages example: config.yaml, wifi.yaml, device_base.yaml

Source: https://esphome.io/components/packages

Shows how to define packages as a list in the main configuration file, and how the included files define common components like Wi-Fi and API. The api component in device_base.yaml is merged with actions defined in config.yaml.

```yaml
# In config.yaml
packages:   # as a list
  - !include common/wifi.yaml
  - !include common/device_base.yaml


api:
  actions:
    - action: start_laundry
      then:
        - switch.turn_on: relay


# any additional configuration...
```

```yaml
# In wifi.yaml
wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password
```

```yaml
# In device_base.yaml
esphome:
  name: ${node_name}


esp32:
  board: wemos_d1_mini32


logger:


api:
  encryption:
    key: !secret api_encryption_key
```

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

### Binary Light Configuration Example

Source: https://esphome.io/components/light/binary

Example configuration entry for a binary light. The 'output' option is required and specifies the ID of the binary output component to use for this light. All other options from the Light component are also available.

```yaml
# Example configuration entry
light:
  - platform: binary
    name: "Desk Lamp"
    output: light_output

```

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

### AS5600 component configuration

Source: https://esphome.io/components/sensor/as5600

Example configuration for the AS5600 sensor component. It sets the start position to 90 degrees, a range of 180 degrees, clockwise direction, and assigns a GPIO pin for the direction pin.

```yaml
as5600:
  start_position: 90deg
  range: 180deg
  direction: clockwise
  dir_pin: GPIOXX
```

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

### Example configuration entry

Source: https://esphome.io/components/touchscreen/ft63x6

Minimal configuration for the FT63X6 touchscreen controller. Requires I²C to be set up in the configuration. The interrupt_pin is optional but recommended for touch detection.

```yaml
touchscreen:
  - platform: ft63x6
    interrupt_pin: GPIOXX

```

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

### Example configuration entry for key_collector

Source: https://esphome.io/components/key_collector

YAML configuration for a key_collector component that reads from a keypad source, requires a start key 'A', end key '#', and a 4-digit PIN. It logs progress, result, and timeout events.

```yaml
# Example configuration entry
key_collector:
  - id: pincode_reader
    source_id: mykeypad
    start_keys: "*"
    min_length: 4
    max_length: 4
    start_keys: "A"
    end_keys: "#"
    end_key_required: true
    back_keys: "*"
    clear_keys: "C"
    allowed_keys: "0123456789"
    timeout: 5s
    on_progress:
      - logger.log:
          format: "input progress: '%s', started by '%c'"
          args: [ 'x.c_str()', "(start == 0 ? '~' : start)" ]
    on_result:
      - logger.log:
          format: "input result: '%s', started by '%c', ended by '%c'"
          args: [ 'x.c_str()', "(start == 0 ? '~' : start)", "(end == 0 ? '~' : end)" ]
    on_timeout:
      - logger.log:
          format: "input timeout: '%s', started by '%c'"
          args: [ 'x.c_str()', "(start == 0 ? '~' : start)" ]

```

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

### Example configuration entry on ESP32

Source: https://esphome.io/components/zigbee

Minimal Zigbee component configuration for ESP32. Sets the component ID and enables router mode. Use this as a starting point for mains-powered ESP32 devices that should forward Zigbee packets.

```yaml
# Example configuration entry on ESP32
zigbee:
  id: my_zigbee
  router: true

```

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

### Example configuration entry

Source: https://esphome.io/components/number/homeassistant

Basic configuration for the `homeassistant` number platform. Requires `entity_id` and an `id`. Min, max, and step are not configurable.

```yaml
number:
  - platform: homeassistant
    id: my_ha_number
    entity_id: number.my_number
```

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

### Example configuration entry for honeywell_hih_i2c sensor

Source: https://esphome.io/components/sensor/honeywell_hih_i2c

Basic ESPHome YAML configuration for the Honeywell HumidIcon sensor. Requires I²C bus setup. Defines temperature and humidity sensors with names. update_interval defaults to 60s.

```yaml
# Example configuration entry
sensor:
  - platform: honeywell_hih_i2c
    temperature:
      name: "Living Room Temperature"
    humidity:
      name: "Living Room Humidity"

```

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

### Snapshot display example configuration

Source: https://esphome.io/components/display/snapshot

Minimal configuration for the snapshot display platform on the host platform. Sets a 320x240 display with a test card and an id of my_display.

```yaml
esphome:
  name: snapshot


host:


display:
  - platform: snapshot
    id: my_display
    show_test_card: true
    dimensions:
      width: 320
      height: 240

```

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

### Basic configuration entry for waveshare_epaper

Source: https://esphome.io/components/display/waveshare_epaper

Example configuration for a Waveshare E-Paper display using SPI. Includes font definition, SPI pins, and display setup with model, update interval, and a lambda that prints text.

```yaml
font:
  - file: 'fonts/Comic Sans MS.ttf'
    id: font1
    size: 8


spi:
  clk_pin: D0
  mosi_pin: D1


display:
  - platform: waveshare_epaper
    cs_pin: D2
    dc_pin: D3
    busy_pin: D4
    reset_pin: D5
    model: 2.90in
    full_update_every: 30
    lambda: |-
      it.print(0, 0, id(font1), "Hello World!");

```

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

### snapshot.take action usage examples

Source: https://esphome.io/components/display/snapshot

Shows three ways to use the snapshot.take action: with a generated filename, with a fixed filename, and with a templated filename. The templated example returns dark.bmp or light.bmp based on the night_mode state.

```yaml
on_...:
  # save to a name built from the display id and the current time
  - snapshot.take: my_display


  # save to a name you choose
  - snapshot.take:
      id: my_display
      filename: start_screen.bmp


  # the name may be templated
  - snapshot.take:
      id: my_display
      filename: !lambda |-
        return id(night_mode).state ? "dark.bmp" : "light.bmp";

```

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

### rtttl.play Action Example

Source: https://esphome.io/components/rtttl

YAML snippet showing how to use the rtttl.play action to play an RTTTL melody. The rtttl string is required and templatable. If a melody is currently playing, you must call rtttl.stop before starting a new one.

```yaml
on_...:
  then:
    - rtttl.play: 'siren:d=8,o=5,b=100:d,e,d,e,d,e,d,e'

```

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

### mqtt.enable Action - Custom Setup with Global Broker Address

Source: https://esphome.io/components/mqtt

Shows a complete setup for enabling MQTT on demand with a dynamically set broker address. The MQTT component is configured with an empty broker and enable_on_boot set to false. A global variable stores the broker address, and a lambda sets it before enabling MQTT.

```yaml
mqtt:
  id: mqtt_id
  broker: ""
  enable_on_boot: False


globals:
  - id: broker_address
    type: std::string
    restore_value: yes
    max_restore_data_length: 24
    initial_value: '"192.168.1.2"'


on_...:
  then:
    - lambda: !lambda id(mqtt_id).set_broker_address(id(broker_address));
    - mqtt.enable:
```
Tokens:
Raw