Components¶

Binary Sensor Component
- Base Binary Sensor Configuration
- Binary Sensor Filters
- Binary Sensor Automation
- See Also
CAN Bus
- Base CAN Bus Configuration
- Platforms
  - ESP32 CAN
  - MCP2515
- Automations
  - on_frame Trigger
  - canbus.send Action
- Extended ID
- Binary Sensor Example
- Cover Example
- See Also
Climate Component
- Base Climate Configuration
- Climate Automation
- See Also
Cover Component
- Base Cover Configuration
- cover.open Action
- cover.close Action
- cover.stop Action
- cover.toggle Action
- cover.control Action
- Lambdas
  - cover.on_open Trigger
  - cover.on_closed Trigger
- See Also
Fan Component
- Base Fan Configuration
- fan.toggle Action
- fan.turn_off Action
- fan.turn_on Action
- fan.cycle_speed Action
- fan.is_on / fan.is_off Condition
- fan.on_state Trigger
- fan.on_turn_on / fan.on_turn_off Trigger
- fan.on_direction_set Trigger
- fan.on_oscillating_set Trigger
- fan.on_speed_set Trigger
- fan.on_preset_set Trigger
- Lambda calls
- Full Fan Index
Light Component
- Base Light Configuration
- Light Automations
- Light Effects
- See Also
Number Component
- Base Number Configuration
- Number Automation
- See Also
Datetime Component
- Base Datetime Configuration
- Automation
  - on_value
- Date Automation
  - datetime.date.set Action
  - lambda calls
- Time Automation
  - datetime.time.set Action
  - lambda calls
- DateTime Automation
  - datetime.datetime.set Action
  - Lambda calls
- See Also
  - Template Datetime
Over-the-Air Updates
- Platforms
  - ESPHome OTA Updates
  - OTA Update via HTTP Request
- Configuration variables:
- OTA Automations
- Safe Mode
- See Also
Output Component
- Base Output Configuration
- Full Output Index
Select Component
- Base Select Configuration
- Select Automation
- Example
- See Also
Sensor Component
- Base Sensor Configuration
- Sensor Filters
- Example: Converting Celsius to Fahrenheit
- Sensor Automation
- See Also
Switch Component
- Base Switch Configuration
- See Also
Button Component
- Base Button Configuration
- Button Automation
- See Also
Event Component
- Base Event Configuration
- Event Automation
- See Also
  - Template Event
Display Component
- Configuration variables:
Text Sensor Component
- Base Text Sensor Configuration
- Text Sensor Filters
  - to_upper
  - to_lower
  - append
  - prepend
  - substitute
  - map
  - lambda
- Text Sensor Automation
  - on_value
  - on_raw_value
- text_sensor.state Condition
  - lambda calls
- See Also
Stepper Component
- Base Stepper Configuration
- A4988 Component
- ULN2003 Component
- stepper.set_target Action
- stepper.report_position Action
- stepper.set_speed Action
- stepper.set_acceleration Action
- stepper.set_deceleration Action
- Home Assistant Configuration
- lambda calls
- See Also
Touchscreen Components
- Base Touchscreen Configuration
  - Configuration variables:
- TouchPoint Argument Type
- Calibration
- on_touch Trigger
- on_update Trigger
- on_release Trigger
- Binary Sensor
  - Configuration variables:
- See Also
Lock Component
- Base Lock Configuration
- See Also
  - Generic Output Lock
  - Template Lock
Display Menu
- Overview
- Menu Items
  - Editing values
  - Label
  - Menu
  - Back
  - Select
  - Number
  - Switch
  - Command
  - Custom
- Automations
- See Also
  - Graphical Display Menu
  - LCD Menu
LVGL Graphics
- Prerequisites
- TL;DR
- Basics
- Main Configuration
- Widgets
- Actions
- Conditions
  - lvgl.is_idle
  - lvgl.is_paused
- Triggers
- See Also
  - LVGL Widgets
Audio DAC Core
- Configuration variables:
- Automations
- Platforms
  - AIC3204
  - ES8311
- See Also
Media Player Components
- Base Media Player Configuration
- Media Player Actions
- Play media in order
- See Also
  - I²S Audio Media Player
Microphone Components
- Base Microphone Configuration
- Microphone Actions
  - microphone.capture Action
  - microphone.stop_capture Action
- Microphone Triggers
  - microphone.on_data Trigger
- Microphone Conditions
  - microphone.is_capturing Condition
- Platforms
  - I²S Audio Microphone
- See Also
Speaker Components
- Base Speaker Configuration
- Speaker Actions
- Speaker Conditions
  - speaker.is_playing Condition
  - speaker.is_stopped Condition
- Platforms
  - I²S Audio Speaker
- See Also
Time Component
- Base Time Configuration
- Use In Lambdas
  - strftime
- See Also
Alarm Control Panel Component
- Base Alarm Control Panel Configuration
- Automation:
- Platforms
  - Template Alarm Control Panel
- See Also
Text Component
- Base Text Configuration
- Text Automation
- See Also
  - LVGL Text
  - Template Text
Update Core
- Configuration variables:
- Automations
  - update.perform Action
  - update.is_available Condition
- See Also
  - Managed Updates via HTTP Request
Valve Component
- Base Valve Configuration
- valve.open Action
- valve.close Action
- valve.stop Action
- valve.toggle Action
- valve.control Action
- Lambdas
  - valve.on_open Trigger
  - valve.on_closed Trigger
- See Also
  - Template Valve
Animation
- Configuration variables:
- Actions:
Native API Component
- Configuration variables:
- Actions
- Triggers
  - on_client_connected Trigger
  - on_client_disconnected Trigger
- api.connected Condition
- User-defined Actions
- Advantages over MQTT
- See Also
AirTouch AT581x Radar
- Component/Hub
  - Configuration variables:
- Binary Sensor
  - Configuration variables:
- Switch
  - Configuration variables:
- Actions
  - at581x.settings Action
  - at581x.reset Action
- See Also
BLE Client
- Configuration variables:
- BLE Client Automation
- ble_client.connect Action
- ble_client.disconnect Action
- ble_client.ble_write Action
- ble_client.passkey_reply Action
- ble_client.numeric_comparison_reply Action
- ble_client.remove_bond Action
- BLE Overview
- Setting Up Devices
- Passkey examples
- See Also
Bluetooth Proxy
- Configuration:
- Improving reception performance
- Complete sample recommended configuration for an ethernet-connected Bluetooth proxy
- See Also
Captive Portal
- See Also
CH422G I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also
Copy Component
- Copy Binary Sensor
  - Configuration variables:
- Copy Button
  - Configuration variables:
- Copy Cover
  - Configuration variables:
- Copy Fan
  - Configuration variables:
- Copy Lock
  - Configuration variables:
- Copy Number
  - Configuration variables:
- Copy Select
  - Configuration variables:
- Copy Sensor
  - Configuration variables:
- Copy Switch
  - Configuration variables:
- Copy Text Sensor
  - Configuration variables:
- Copy Text
  - Configuration variables:
- See Also
Debug Component
- Text Sensor
- Sensor
- See Also
Deep Sleep Component
- Configuration variables:
- ESP32 Wakeup Pin Mode
- ESP32 Wakeup Cause
- deep_sleep.enter Action
- deep_sleep.prevent Action
- deep_sleep.allow Action
- See Also
Demo Component
- Configuration variables:
- See Also
DF-Player mini
- Overview
- Configuration variables:
- dfplayer.is_playing Condition
- dfplayer.play_next Action
- dfplayer.play_previous Action
- dfplayer.play Action
- dfplayer.play_mp3 Action
- dfplayer.play_folder Action
- dfplayer.set_device Action
- dfplayer.set_volume Action
- dfplayer.volume_up Action
- dfplayer.volume_down Action
- dfplayer.set_eq Action
- dfplayer.sleep Action
- dfplayer.reset Action
- dfplayer.start Action
- dfplayer.pause Action
- dfplayer.stop Action
- dfplayer.random Action
- All actions
- Test setup
  - Sample code
- See Also
DFRobot mmWave Radar
- Hub Component
  - Configuration variables:
- Binary Sensor
- Switch
  - Configuration variables:
- Actions
  - dfrobot_sen0395.settings Action
  - dfrobot_sen0395.reset Action
- See Also
EMC2101 Fan Controller and Temperature sensor
- EMC2101 Component
  - Configuration variables:
- EMC2101 Output
  - Configuration variables:
- EMC2101 Sensors
  - Configuration variables:
- See Also
ESP32 Platform
- Configuration variables:
- Arduino framework
  - Configuration variables:
- ESP-IDF framework
  - Configuration variables:
- Advanced Configuration
- GPIO Pin Numbering
- See Also
BLE Component
- Configuration variables:
- ble.disable Action
- ble.enable Action
- ble.enabled Condition
- See Also
ESP32 Bluetooth Low Energy Beacon
- Configuration variables:
- Setting Up
- See Also
BLE Server
- Configuration variables:
- See Also
ESP32 Bluetooth Low Energy Tracker Hub
- Configuration variables:
- ESP32 Bluetooth Low Energy Tracker Automation
- Use on single-core chips
- See Also
ESP32 Camera Component
- Configuration variables:
- Configuration examples
- See Also
ESP32 Camera Web Server Component
- Configuration variables:
- Integrating the mjpeg web service into an NVR:
- See Also
Improv via BLE
- Configuration variables:
- Improv Automations
- Status Indicator
- See Also
ESP8266 Platform
- Configuration variables:
- GPIO Pin Numbering
  - Special Pins
- Boot Modes
- Reset Causes
- Electrical Characteristics
- See Also
ESPHome Core Configuration
- Configuration variables:
- on_boot
- on_shutdown
- on_loop
- platformio_options
- includes
- libraries
- Adjusting flash writes
- Changing ESPHome Node Name
- Adding the MAC address as a suffix to the device name
- Project information
- Minimum ESPHome version
- See Also
Ethernet Component
- Configuration variables:
- Configuration examples
- See Also
Exposure Notification Listener
- Configuration variables:
- Indicator of device with exposure notifications
- See Also
External Components
- Local
  - Example of local components
- Git
  - Example of git repositories
  - Refresh
- See Also
Atlas Scientific Peristaltic Pump
- Sensors
- current_volume_dosed
- total_volume_dosed
- absolute_total_volume_dosed
- last_volume_requested
- max_flow_rate
- pump_voltage
- Binary Sensors
- pump_state
- is_paused
- Text Sensors
- dosing_mode
- calibration_status
- Actions
- ezo_pmp.dose_continuously Action
- ezo_pmp.dose_volume Action
- ezo_pmp.dose_volume_over_time Action
- ezo_pmp.dose_with_constant_flow_rate Action
- ezo_pmp.pause_dosing Action
- ezo_pmp.stop_dosing Action
- ezo_pmp.clear_total_volume_dosed Action
- ezo_pmp.set_calibration_volume Action
- ezo_pmp.clear_calibration Action
- ezo_pmp.find Action
- ezo_pmp.change_i2c_address Action
- Home Assistant Configuration
- lambda calls
- See Also
Grow Fingerprint Reader
- Component/Hub
- Binary Sensor
- Sensor
- Sleep Mode
- Setting a New Password
- on_finger_scan_start Trigger
- on_finger_scan_invalid Trigger
- on_finger_scan_matched Trigger
- on_finger_scan_unmatched Trigger
- on_finger_scan_misplaced Trigger
- on_enrollment_scan Trigger
- on_enrollment_done Trigger
- on_enrollment_failed Trigger
- fingerprint_grow.enroll Action
- fingerprint_grow.cancel_enroll Action
- fingerprint_grow.delete Action
- fingerprint_grow.delete_all Action
- fingerprint_grow.led_control Action
- fingerprint_grow.aura_led_control Action
- All actions
- Test setup
  - Sample code
- See Also
Font Renderer Component
- Configuration variables:
- See Also
Global Variables
globals.set Action
See Also
GPS Component
- Configuration variables:
- See Also
Graph Component
- Configuration variables:
Grove TB6612FNG Motor Drive
- Configuration variables:
Host Platform
- Configuration variables:
- Build and run
- See Also
HTTP Request
- Configuration variables:
- HTTP Request Actions
- on_response Trigger
- on_error Trigger
- Examples
- See Also
I²C Bus
- Configuration variables:
- See Also
Generic I²C device component:
Configuration variables:
See Also
I²S Audio Component
- Configuration variables:
- See also
Images
- Configuration variables:
Improv via Serial
- Configuration variables
- Next URL
- See Also
Interval Component
- Configuration variables:
See Also
json Component
- Parsing JSON:
- Building JSON:
- Troubleshooting Errors:
- See Also
Key collector component
- Component
- Automations:
- Lambda:
- See Also
LibreTiny Platform
- Configuration variables:
- Getting Started
- GPIO Pin Numbering
- Advanced options
- See Also
LightWaveRF
- Configuration variables:
- lightwaverf.send_raw Action
- Configuration variables:
- Compatible Hardware
- See Also
Logger Component
- Configuration variables:
- Hardware UARTs
  - Default UART GPIO Pins
- Default Hardware Interfaces
- Log Levels
- Manual Tag-Specific Log Levels
- logger.log Action
- Logger Automation
  - on_message
- See Also
Matrix keypad
- Component
- Binary Sensor
- Automations:
- See Also
MAX6956 I/O Expander
- Component/Hub
  - Configuration variables:
- Binary Sensor Example
- Switch Example
- Led driver Example
- See Also
MCP230xx I/O Expander
- MCP23008 Component
  - Configuration variables:
  - Pin configuration variables:
- MCP23016 Component
  - Configuration variables:
  - Pin configuration variables:
- MCP23017 Component
  - Configuration variables:
  - Pin configuration variables:
- See Also
MCP23Sxx I/O Expander
- MCP23S08 Component
  - Configuration variables:
  - Pin Configuration Variables:
- MCP23S17 Component
  - Configuration variables:
  - Pin Configuration Variables:
- See Also
mDNS Component
- Services:
- Configuration variables:
Micro Wake Word
- Configuration variables:
- Automations
  - micro_wake_word.start Action
  - micro_wake_word.stop Action
- Example usage
- Model JSON
- See Also
MicroNova based pellet stove
- Connecting your stove
- Component/Hub
  - Configuration variables:
- Text Sensors
  - Configuration variables:
- Sensors
  - Configuration variables:
- Numbers
  - Configuration variables:
- Buttons
  - Configuration variables:
- Switches
  - Configuration variables:
- See Also
Modbus Component
- Configuration variables:
- See Also
Modbus Controller
- Hardware setup
- Configuration variables:
- Example Client
- Example Server
- Bitmasks
- Using custom_command
- Optimizing modbus communications
- Protocol decoding example
- Automation
- See Also
MQTT Client Component
- Configuration variables:
- MQTTMessage
- MQTT device discovery
- Using device discovery with Home Assistant
- Using with Home Assistant MQTT entities
- Defaults
- Last Will And Birth Messages
- SSL Fingerprints
- TLS with esp-idf (esp32)
- MQTT Component Base Configuration
- on_connect / on_disconnect Trigger
- on_message Trigger
- on_json_message Trigger
- mqtt.publish Action
- mqtt.publish_json Action
- mqtt.disable Action
- mqtt.enable Action
- mqtt.connected Condition
- See Also
Network component
- Configuration variables:
- See Also
1-Wire Bus
- GPIO
  - Configuration variables:
  - Getting Sensor IDs
- See Also
Online Image Component
- Configuration variables
- Automations
- Actions
- Examples
- See Also
OpenTherm
- Quick glossary
- Hub
  - Configuration variables:
  - Note about sync mode
- Usage as a thermostat
- Examples
  - Minimal example with numeric input
  - Basic PID thermostat
- See Also
Packages
- Local Packages
- Remote/Git Packages
- Configuration variables:
- Packages as Templates
- Extend
- Remove
- See Also
PCA6416A I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also
PCA9554 I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also
PCF8574 I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also
PipSolar PV Inverter
- Overview
  - Configuration variables:
- Sensor
  - Configuration variables:
- Binary Sensor
  - Configuration variables:
- Text Sensor
  - Configuration variables:
- Switch
  - Configuration variables:
- Output
  - Configuration variables:
- output.pipsolar.set_level Action
- See Also
PN7150 NFC
- Component/Hub
  - Configuration variables:
- Actions
- Triggers
NDEF
- NDEF Reading
- NDEF Writing
- See Also
PN7160 NFC
- Component/Hub
- Over SPI
  - Configuration variables:
- Over I²C
  - Configuration variables:
- Actions
- Triggers
NDEF
- NDEF Reading
- NDEF Writing
- See Also
Power Supply Component
- Configuration variables:
- ATX Power Supplies
- See Also
Prometheus Component
- Configuration variables:
- Metric Relabeling
  - relabel
- See Also
PSRAM
- Configuration variables:
- See Also
Pylontech Battery
- Hardware Setup
- Component/Hub
  - Configuration variables:
- Sensor
  - Configuration variables:
- Text Sensor
  - Configuration variables:
- Energy Monitoring
- See Also
QR Code Component
- Configuration variables:
Remote Receiver
- Configuration variables:
- Automations:
- Binary Sensor
  - Configuration variables:
- See Also
Remote Transmitter
- Configuration variables:
- Automations:
- Remote Transmitter Actions
  - RC Switch Protocol
  - Lambda calls
- See Also
RF Bridge Component
- Configuration variables:
- on_code_received Trigger
- rf_bridge.send_code Action
- rf_bridge.send_raw Action
- rf_bridge.learn Action
- Portisch firmware
- Getting started with Home Assistant
- See Also
RP2040 Platform
- Configuration variables:
- See Also
Rtttl Buzzer
- Overview Using a passive buzzer
- Overview Using the I2S speaker
- Configuration variables:
- rtttl.play Action
- rtttl.stop Action
- All actions
- rtttl.is_playing Condition
- Common beeps
- Test setup
  - Sample code
- See Also
Safe Mode
- Configuration variables:
- See Also
Script Component
Script Parameters
script.execute Action
script.stop Action
script.wait Action
script.is_running Condition
See Also
Seeed Studio MR24HPC1 mmWave (Kit)
- Component/Hub
  - Configuration variables:
- Binary Sensor
  - Configuration variables:
- Sensor
  - Configuration variables:
- Switch
  - Configuration variables:
- Number
  - Configuration variables:
- Button
  - Configuration variables:
- Text Sensor
  - Configuration variables:
- Select
  - Configuration variables:
- Home Assistant Card
- See Also
Seeed Studio MR60BHA2 60GHz mmWave Breathing and Heartbeat Detection Sensor Kit
- Component/Hub
  - Configuration variables:
- Sensor
  - Configuration variables:
- See Also
Seeed Studio MR60FDA2 60GHz mmWave Fall Detection Sensor Kit
- Component/Hub
  - Configuration variables:
- Binary Sensor
  - Configuration variables:
- Button
  - Configuration variables:
- Select
  - Configuration variables:
- See Also
Servo Component
- Configuration variables:
- servo.write Action
- servo.detach Action
- Home Assistant Configuration
- See Also
Sim800L Component
- Component/Hub
- Sensor
- Binary Sensor
- on_sms_received Trigger
- on_incoming_call Trigger
- on_ussd_received Trigger
- sim800l.send_sms Action
- sim800l.dial Action
- sim800l.connect Action
- sim800l.disconnect Action
- sim800l.send_ussd Action
- Getting started with Home Assistant
- See Also
SML (Smart Message Language)
- Hardware
- Component/Hub
- Sensor
- Text Sensor
- Automations:
  - on_data Trigger
- Getting OBIS codes and sensor ids
- Precision errors
- Holley DTZ541 Smart Meters
- See Also
SN74HC165 I/O Expander (shift register)
- Configuration variables:
- Pin configuration variables:
  - See Also
SN74HC595 I/O Expander (shift register)
- Over GPIO
  - Configuration variables:
- Over SPI
  - Configuration variables:
- Pin configuration
- See Also
SPI Bus
- Configuration variables:
- Interface selection:
- Generic SPI device component:
- Configuration variables:
- SPI modes:
- See Also
Sprinkler Controller
- Configuration variables:
- An Important Note about GPIO Switches and Control
- Controller Actions
- Pump and Distribution Valve Coordination
  - Delayed Starting and/or Stopping of Pumps or Valves
  - Banging Pipes or Valves That Don’t Consistently Close
- Controller Examples
- Understanding the Sprinkler Controller’s State
  - How Do I…
- See Also
StatsD
- Configuration variables:
- Sensor list
- See Also
Status LED
- Configuration variables:
- See Also
Substitutions
- Substitute !include variables
- Command line substitutions
- Bonus: YAML insertion operator
- See Also
Sun
- Configuration variables:
- sun Sensor
- sun Text Sensor
- sun.is_above_horizon / sun.is_below_horizon Conditions
- See Also
SUN_GTIL2 Grid Tie Inverter
- Component/Hub
  - Configuration variables:
- Sensor
  - Configuration variables:
- Text Sensor
  - Configuration variables:
- See Also
SX1509 16 channel I/O Expander with LED driver and keypad engine
- Configuration variables:
Binary Sensor
- Configuration variables:
- Pin configuration variables:
- See Also
TCA9548A I²C Multiplexer
- Configuration variables:
  - See Also
TCA9555 I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also
TM1651 Battery Display
- Battery Display
  - Configuration variables:
- tm1651.set_level_percent Action
- tm1651.set_level Action
- tm1651.set_brightness Action
- tm1651.turn_off Action
- tm1651.turn_on Action
- Advanced Configuration
- See Also
Tuya MCU
- Configuration variables:
- Tuya Automation
  - on_datapoint_update
- See Also
UART Bus
- Configuration variables:
- Hardware UARTs
- uart.write Action
- Debugging
- Changing at runtime
- UART component with the host platform
- See Also
UDP Component
- Configuration variables:
- Reliability
- Security
- Configuration examples
- See Also
Uponor Smatrix Base Pulse Underfloor Heating
- Connecting to the bus
- Getting started
- Controller/Hub component
  - Configuration variables:
- Climate component
  - Configuration variables:
- Sensor component
  - Configuration variables:
- See Also
VBus Component
- Supported Models
- Hardware Connection
- Component
- Sensor
- Binary Sensor
- custom VBus sensors
- custom VBus binary sensors
- See Also
Voice Assistant
- Configuration:
- Voice Assistant Actions
- Voice Assistant Conditions
- Wake word detection
- Push to Talk
- Click to Converse
- See Also
Web Server Component
- Configuration variables:
- Example configurations:
- Advanced usage
- Version 3 features
- See Also
WeiKai SPI/I²C UART/IO Expander
- Connecting via an SPI bus
  - Configuration variables:
- Connecting via an I²C bus
  - Configuration variables:
- Using the GPIO pins
  - Pin configuration variables:
- Performance considerations:
  - Bus speed
  - Maximum Baud rate
- See Also
Wiegand keypad and tag reader
- Component
- Automations:
- See Also
WiFi Component
- Configuration variables:
- Access Point Mode
- User Entered Credentials
- Manual IPs
- Power Save Mode
- Connecting to Multiple Networks
- Enterprise Authentication
- on_connect / on_disconnect Trigger
- wifi.disable Action
- wifi.enable Action
- wifi.configure Action
- wifi.connected Condition
- wifi.enabled Condition
- See Also
WireGuard Component
- Configuration variables
- Static routes and outgoing connections
- Sensors
- Actions
  - wireguard.disable
  - wireguard.enable
- Conditions
  - wireguard.enabled
  - wireguard.peer_online
- Remote peer setup
- Connecting to remote Home Assistant
- See Also
XL9535 I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also