Quick search

Join the community
Follow us on Twitter
Source Code
Contact (no support!)

ESPHome is an open source project by Nabu Casa

This site is powered by Netlify

Components¶

Binary Sensor Component
- Base Binary Sensor Configuration
- Binary Sensor Filters
- Binary Sensor Automation
- 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_turn_on / fan.on_turn_off Trigger
- fan.on_speed_set Trigger
- Lambda calls
- Full Fan Index
Light Component
- Base Light Configuration
- Light Effects
- See Also
Number Component
- Base Number Configuration
- Number Automation
- 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
Display Component
- Display Rendering Engine
- Display Pages
- See Also
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:
- on_touch 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
  - LCD Menu
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.play Action
  - speaker.stop Action
- Speaker Conditions
  - speaker.is_playing 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
Native API Component
- Configuration variables:
- homeassistant.service Action
- User-defined Services
- api.connected Condition
- Advantages over MQTT
- homeassistant.event Action
- homeassistant.tag_scanned Action
- See Also
BLE Client
- Configuration variables:
- BLE Client Automation
- 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
CAN bus
- Base CAN Bus Configuration
  - Configuration variables:
- Automations:
- ESP32 CAN Component
  - Wiring options
  - Configuration variables:
- MCP2515 Component
  - Configuration variables:
  - Wiring options
- Extended ID
- Binary Sensor Example
- Cover Example
- See Also
Captive Portal
- See Also
Copy Integration
- 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:
- See Also
Debug Component
- Text Sensor
- Sensor
- See Also
Deep Sleep Component
- Configuration variables:
- ESP32 Wakeup Pin Mode
- deep_sleep.enter Action
- deep_sleep.prevent Action
- deep_sleep.allow Action
- See Also
Demo Integration
- 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
ESP32 Platform
- Configuration variables:
- GPIO Pin Numbering
- Arduino framework
- Configuration variables:
- ESP-IDF framework
- Configuration variables:
- See Also
BLE Component
- Configuration variables:
- 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
- See Also
ESP32 Camera Component
- Configuration variables:
- Configuration for Ai-Thinker Camera
- Configuration for M5Stack Camera
- Configuration for M5Stack Timer Camera X/F
- Configuration for Wrover Kit Boards
- Configuration for TTGO T-Camera V05
- Configuration for TTGO T-Camera V162
- Configuration for TTGO T-Camera V17
- Configuration for TTGO T-Journal
- Configuration for TTGO-Camera Plus
- Configuration for TTGO-Camera Mini
- Configuration for ESP-EYE
- See Also
ESP32 Camera Web Server Component
- Configuration variables:
- Integrating the mjpeg web service into an NVR:
- See Also
Improv via BLE
- Configuration variables:
- 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
- Setting a New Password
- on_finger_scan_matched Trigger
- on_finger_scan_unmatched 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
GPS Component
- Configuration variables:
- See Also
Grove TB6612FNG Motor Drive
- Configuration variables:
HTTP Request
- Configuration variables:
- esp8266_disable_ssl_support
- HTTP Request Actions
- on_response Trigger
- Examples
- See Also
I²C Bus
- Configuration variables:
- See Also
I²S Audio Component
- Configuration variables:
- See also
Improv via Serial
- Configuration variables
- Next URL
- See Also
Key collector component
- Component
- Automations:
- Lambda:
- See Also
Logger Component
- Configuration variables:
- Hardware UARTs
- Log Levels
- Manual Tag-Specific Log Levels
- logger.log Action
- Logger Automation
  - on_message
- See Also
Matrix keypad
- Component
- Binary Sensor
- 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:
Modbus Component
- Configuration variables:
- See Also
Modbus Controller
- Hardware setup
- Configuration variables:
- Example
- Bitmasks
- Protocol decoding example
- Note
- See Also
MQTT Client Component
- Configuration variables:
- MQTTMessage
- Using with Home Assistant
- 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.connected Condition
- See Also
Network component
- Configuration variables:
- See Also
OTA Update Component
- Configuration variables:
- OTA Automation
- Updating the password:
  - Changing an existing password:
  - Adding a password:
- 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
Power Supply Component
- Configuration variables:
- ATX Power Supplies
- See Also
Prometheus Component
- Configuration variables:
- Metric Relabeling
  - relabel
- See Also
Remote Receiver
- Configuration variables:
- Automations:
- Binary Sensor
  - Configuration variables:
- See Also
Remote Transmitter
- Configuration variables:
- Remote Transmitter Actions
- Setting up Infrared Devices
- Setting Up RF Devices
- 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
- Configuration variables:
- rtttl.play Action
- rtttl.stop Action
- All actions
- rtttl.is_playing Condition
- Common beeps
- Test setup
  - Sample code
- 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
- Configuration
- Configuration variables:
- 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)
- Configuration variables:
- Pin configuration variables:
  - See Also
SPI Bus
- Configuration variables:
- 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
Status LED
- Configuration variables:
- See Also
Sun
- Configuration variables:
- sun Sensor
- sun Text Sensor
- sun.is_above_horizon / sun.is_below_horizon Conditions
- 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
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
- 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
- Push to Talk
- Click to Converse
- See Also
Web Server Component
- Configuration variables:
- Example configurations:
- Advanced usage
- 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
- wifi.disable Action
- wifi.enable Action
- wifi.connected Condition
- wifi.enabled Condition
- See Also
XL9535 I/O Expander
- Configuration variables:
- Pin configuration variables:
  - See Also

A new version has been release since you last visited this page: 2023.8.3 🎉

Dismiss