Components¶
- Binary Sensor Component
- Base Binary Sensor Configuration
- Binary Sensor Filters
- Binary Sensor Automation
- See Also
- Analog Threshold Binary Sensor
- ESP32 Bluetooth Low Energy Device
- CAP1188 Capacitive Touch Sensor
- Custom Binary Sensor
- ESP32 Touch Pad
- GPIO Binary Sensor
- Haier Climate Binary Sensors
- Home Assistant Binary Sensor
- Hydreon Rain Sensor Binary Sensor
- LVGL Binary Sensor
- Modbus Controller Binary Sensor
- MPR121 Capacitive Touch Sensor
- Nextion Binary Sensor Component
- NFC Binary Sensor
- PN532 NFC/RFID
- NDEF
- Qwiic PIR Motion Binary Sensor
- RC522 NFC/RFID
- RDM6300 NFC/RFID
- Status Binary Sensor
- Template Binary Sensor
- TTP229 Capacitive Touch Sensor
- Tuya Binary Sensor
- UDP Binary Sensor
- CAN Bus
- Climate Component
- Cover Component
- Fan Component
- Base Fan Configuration
fan.toggle
Actionfan.turn_off
Actionfan.turn_on
Actionfan.cycle_speed
Actionfan.is_on
/fan.is_off
Conditionfan.on_state
Triggerfan.on_turn_on
/fan.on_turn_off
Triggerfan.on_direction_set
Triggerfan.on_oscillating_set
Triggerfan.on_speed_set
Triggerfan.on_preset_set
Trigger- Lambda calls
- Full Fan Index
- Light Component
- Base Light Configuration
- Light Effects
- Pulse Effect
- Random Effect
- Strobe Effect
- Flicker Effect
- Lambda Effect
- Addressable Rainbow Effect
- Addressable Color Wipe Effect
- Addressable Scan Effect
- Addressable Twinkle Effect
- Addressable Random Twinkle Effect
- Addressable Fireworks Effect
- Addressable Flicker Effect
- Addressable Lambda Effect
- Automation Light Effect
- E1.31 Effect
- Adalight Effect
- WLED Effect
- See Also
- Beken SPI LED Strip
- Binary Light
- Color Temperature Light
- Custom Light Output
- Cold White + Warm White Light
- ESP32 RMT LED Strip
- FastLED Light
- H-bridge Light
- LVGL Light
- Monochromatic Light
- NeoPixelBus Light
- Light Partition
- RGB Light
- RGBCT Light
- RGBW Light
- RGBWW Light
- RP2040 PIO LED Strip
- Shelly Dimmer
- Sonoff D1 Dimmer
- SPI LED Strip Light
- Status LED Light
- Tuya Dimmer
- Number Component
- Datetime Component
- Over-the-Air Updates
- Output Component
- Base Output Configuration
- Full Output Index
- AC Dimmer Component
- BLE Client Binary Output
- BP1658CJ LED driver
- BP5758D LED driver
- Custom Output
- DAC7678
- ESP32 DAC
- ESP8266 Software PWM Output
- GP8403 Component
- GPIO Output
- ESP32 LEDC Output
- LibreTiny PWM Output
- MCP4725 Output
- MCP4728 Component
- MCP47A1 Output
- Modbus Controller Output
- MY9231/MY9291 LED driver
- PCA9685
- Sigma-Delta Output
- Slow PWM Output
- SM16716 LED driver
- SM2135 LED driver
- SM2235 LED driver
- SM2335 LED driver
- Template Output
- TLC59208F
- TLC5947 LED driver
- TLC5971 LED driver
- X9C Potentiometer Output
- Select Component
- Sensor Component
- Base Sensor Configuration
- Sensor Filters
- Example: Converting Celsius to Fahrenheit
- Sensor Automation
- See Also
- A01NYUB Waterproof Ultrasonic Sensor
- A02YYUW Waterproof Ultrasonic Sensor
- Absolute Humidity
- Analog To Digital Sensor
- ADC128S102 8-Channel 12-Bit A/D Converter
- ADE7880 Power Sensor
- ADE7953 Power Sensor
- ADS1115 4-Channel 16-Bit A/D Converter
- ADS1118 4-Channel 16-Bit A/D Converter with Internal Temperature Sensor
- AGS10 Volatile Organic Compound (VOC) Sensor
- AHT10 Temperature+Humidity Sensor
- AirThings BLE Sensors
- Grundfos Alpha3
- AM2315C Temperature+Humidity Sensor
- AM2320 Temperature+Humidity Sensor
- AM43 Sensor
- APDS9306 Sensor
- APDS9960 Sensor
- AMS AS3935 Franklin Lightning Sensor
- AS5600 12-Bit Magnetic Position Sensor
- AS7341 Spectral Color Sensor
- ATM90E26 Power Sensor
- ATM90E32 Power Sensor
- b-parasite
- BH1750 Ambient Light Sensor
- Binary Sensor Map
- Belling BL0906 Energy Monitor
- BL0939 Power Sensor
- Belling BL0940 Energy Monitor
- Belling BL0942 Energy Monitor
- BLE Client Sensor
- ESP32 Bluetooth Low Energy RSSI Sensor
- BME280 Temperature+Pressure+Humidity Sensor
- BME680 Temperature+Pressure+Humidity+Gas Sensor
- BME680 Temperature+Pressure+Humidity+Gas Sensor via BSEC
- BME68x Temperature, Humidity, Pressure & Gas Sensor via BSEC2
- BMI160 Accelerometer/Gyroscope Sensor
- BMP085 Temperature+Pressure Sensor
- BMP280 Temperature+Pressure Sensor
- BMP388 / BMP390 Temperature+Pressure Sensor
- BMP581 Temperature+Pressure Sensor
- CCS811 eCO_2 and Volatile Organic Compound Sensor
- cd74hc4067 Analog Multiplexer
- Combine the state of several sensors
- CS5460A Power Sensor
- CSE7761 Power Sensor
- CSE7766 Power Sensor
- CT Clamp Current Sensor
- Custom Sensor Component
- Dallas Temperature Sensor
- Daly BMS Sensor
- DHT Temperature+Humidity Sensor
- DHT12 Temperature+Humidity Sensor
- DPS310 Atmospheric Pressure Sensor
- DSMR Component
- Duty Cycle Sensor
- Duty Time
- EE895 CO₂, Temperature and Pressure Sensor
- ENS160 Sensor
- ENS210 Temperature+Humidity Sensor
- ESP32 Hall Sensor
- EZO sensor circuits
- FS3000 Air Velocity Sensor
- Panasonic SN-GCJA5 Particulate Matter Sensor
- FTLab GDK101 Gamma Radiation Sensor Module
- Sharp GP2Y1010AU0F PM2.5 Sensor
- Grove Multichannel Gas Sensor V2
- Growatt Solar
- Haier Climate Sensors
- Havells Solar
- HDC1080 Temperature+Humidity Sensor
- HLW8012 Power Sensor
- The Grove - Laser PM2.5 Sensor (HM3301)
- HMC5883L Magnetometer
- Home Assistant Sensor
- Honeywell HumidIcon (I2C HIH series) Temperature & Humidity Sensor
- Honeywell ABP Pressure Sensors
- Honeywell ABP 2 Pressure Sensors
- HRXL/XL MaxSonar WR Series
- HTE501 Temperature+Humidity Sensor
- HTU21D | Si7021 | SHT21 Temperature & Humidity Sensor
- HTU31D Temperature & Humidity Sensor
- HX711 Load Cell Amplifier
- Hydreon Rain Sensor
- HYT271 Temperature & Humidity Sensor
- AMS iAQ-Core Indoor Air Quality Sensor
- INA219 DC Current Sensor
- INA226 DC current and power sensor
- INA260 DC Current and Power sensor
- INA2xx family of digital power monitors
- INA3221 3-Channel DC Current Sensor
- Inkbird IBS-TH1, IBS-TH1 Mini, and IBS-TH2 BLE Sensor
- Integration Sensor
- Internal Temperature Sensor
- JSN-SR04T Waterproof Ultrasonic Range Finder
- Kamstrup Meter Protocol [KMP]
- M5Stack KMeterISO I2C K-Type probe temperature sensor
- Kuntze pool monitor
- LD2410 Sensor
- LD2420 24Ghz mmWave Radar Sensor
- LTR390 UV and Ambient Light Sensor
- Lite-On Ambient Light & Proximity Sensors
- Lite-On Ambient Light & Proximity Sensors
- LVGL Sensor
- M5Stack Unit 8 Angle
- MAX31855 K-Type Thermocouple Temperature Sensor
- MAX31856 Thermocouple Temperature Sensor
- MAX31865 Platinum RTD Temperature Sensor
- MAX44009 Ambient Light Sensor
- MAX6675 K-Type Thermocouple Temperature Sensor
- MAX9611/9612 High Side Current+Voltage+Temperature Sensor
- MCP3008 8-Channel 10-Bit A/D Converter
- MCP3204 & MCP3208 12-Bit A/D Converters
- MCP9600 Thermocouple Amplifier
- MCP9808 Temperature Sensor
- MH-Z19 CO_2 and Temperature Sensor
- MiCS 4514 Gas Sensor
- MLX90393 Triple-axis Magnetometer
- MLX90614 non-contact thermometer
- MMC5603 Magnetometer
- MMC5983 Magnetometer
- Modbus Controller Sensor
- Mopeka Pro Check BLE Sensor
- Mopeka Standard Check BLE Sensor
- MPL3115A2 Barometric Pressure/Altitude/Temperature Sensor
- MPU6050 Accelerometer/Gyroscope Sensor
- MPU6886 Accelerometer/Gyroscope Sensor
- MQTT Subscribe Sensor
- MS5611 Atmospheric Pressure Sensor
- MS8607 Temperature+Pressure+Humidity Sensor
- NAU7802 24-bit ADC
- Nextion Sensor Component
- NPI-19 Pressure Sensor
- NTC Sensor
- PM1006 Particulate Matter Sensor
- PMSA003I Particulate Matter Sensor
- PMSX003 Particulate Matter Sensor
- PMWCS3 Capacitive Soil Moisture and Temperature Sensor
- Pulse Counter Sensor
- Pulse Meter Sensor
- Pulse Width Sensor
- Peacefair PZEM-004T Energy Monitor
- Peacefair PZEM-004T V3 Energy Monitor
- Peacefair PZEM-00X DC Energy Monitor
- QMC5883L Magnetometer
- QMP6988 Temperature+Pressure Sensor
- Radon Eye BLE Sensors
- Resistance Sensor
- Rotary Encoder Sensor
- RuuviTag Open Source BLE Sensor
- SCD30 CO₂, Temperature and Relative Humidity Sensor
- SCD4X CO₂, Temperature and Relative Humidity Sensor
- Eastron SDM Energy Monitor
- SDP3x / SDP800 Series Differential Pressure Sensor
- SDS011 Particulate Matter Sensor
- Selec Energy Monitor
- SEN0321 DFRobot Ozone Sensor
- SEN21231 Person Sensor from Useful Sensors
- Sen5x Series Environmental sensor
- SenseAir CO_2 Sensor
- SFA30 Formaldehyde Sensor
- SGP30 CO₂ and Volatile Organic Compound Sensor
- SGP40 Volatile Organic Compound Sensor and SGP41 VOC and NOx Sensor
- SHT3X-D Temperature+Humidity Sensor
- SHT4X Temperature and Humidity Sensor
- SHTCx Temperature+Humidity Sensors
- SM300D2 7-in-1 Air Quality Sensor
- SMT100 Soil Moisture Sensor
- SPS30 Particulate Matter Sensor
- STS3X Temperature Sensor
- T6613/15 CO2 Sensors
- TCS34725 RGB Color Sensor
- TEE501 Temperature Sensor
- Teleinformation from Linky electrical counter.
- TE-M3200 Pressure Sensor
- Template Sensor
- TMP102 Temperature Sensor
- TMP1075 Temperature Sensor
- TMP117 Temperature Sensor
- TOF10120 Time Of Flight Distance Sensor
- Total Daily Energy Sensor
- TSL2561 Ambient Light Sensor
- TSL2591 Ambient Light Sensor
- Tuya Sensor
- TX20/TX23 Wind Speed/Direction Sensor
- UDP Sensor
- uFire Isolated EC sensor
- uFire ISE pH sensor
- Ultrasonic Distance Sensor
- Uptime Sensor
- VEML3235 Ambient Light Sensor
- VEML7700 and VEML6030 Ambient Light Sensors
- VL53L0X Time Of Flight Distance Sensor
- WiFi Signal Sensor
- CFSensor XGZP68xx Series Differential Pressure Sensor
- Xiaomi Mijia BLE Sensors
- HHCCJCY01 Moved To Xiaomi BLE
- HHCCJCY10 Xiaomi MiFlora (Pink version)
- LYWSDCGQ Moved To Xiaomi BLE
- Xiaomi Miscale Sensors
- Xiaomi Miscale2 combined into Xiaomi Miscale
- Zio Ultrasonic Distance Sensor
- ZyAura CO2 & Temperature & Humidity Sensor
- Switch Component
- Button Component
- Event Component
- Display Component
- Text Sensor Component
- Base Text Sensor Configuration
- Text Sensor Filters
- Text Sensor Automation
text_sensor.state
Condition- See Also
- BLE Client Text Sensor
- ESP32 Bluetooth Low Energy Scanner
- Custom Text Sensor
- Ethernet Info Text Sensor
- Haier Climate Text Sensors
- Home Assistant Text Sensor
- LibreTiny Text Sensor
- LVGL Text Sensor
- Modbus Controller Text Sensor
- MQTT Subscribe Text Sensor
- Nextion Text Sensor Component
- Template Text Sensor
- Tuya Text Sensor
- Version Text Sensor
- WiFi Info Text Sensor
- WL-134 Pet Tag Sensor
- Stepper Component
- Touchscreen Components
- Base Touchscreen Configuration
TouchPoint
Argument Type- Calibration
on_touch
Triggeron_update
Triggeron_release
Trigger- Binary Sensor
- See Also
- cst226 Touch Screen Controller
- cst816 Touch Screen Controller
- EKTF2232 Touchscreen Controller
- FT5X06 Touch Screen Controller
- FT63X6 Touchscreen Controller
- gt911 Touch Screen Controller
- Lilygo T5 4.7” Touchscreen
- SDL2 Touch Screen Emulator
- TT21100 Touch Screen Controller
- XPT2046 Touch Screen Controller (Updated version)
- Lock Component
- Display Menu
- LVGL Graphics
- Audio DAC Core
- Media Player Components
- Base Media Player Configuration
- Media Player Actions
media_player.play
Actionmedia_player.play_media
Actionmedia_player.pause
Actionmedia_player.stop
Actionmedia_player.toggle
Actionmedia_player.volume_up
Actionmedia_player.volume_down
Actionmedia_player.volume_set
Actionmedia_player.on_state
Triggermedia_player.on_play
Triggermedia_player.on_pause
Triggermedia_player.on_idle
Triggermedia_player.on_announcement
Triggermedia_player.is_idle
Conditionmedia_player.is_playing
Condition
- Play media in order
- See Also
- Microphone Components
- Speaker Components
- Time Component
- Alarm Control Panel Component
- Base Alarm Control Panel Configuration
- Automation:
on_state
Triggeron_pending
Triggeron_arming
Triggeron_armed_home
Triggeron_armed_night
Triggeron_armed_away
Triggeron_triggered
Triggeron_cleared
Triggeron_disarmed
Triggeron_ready
Triggeron_chime
Triggerarm_away
Actionarm_home
Actionarm_night
Actiondisarm
Actionpending
Actiontriggered
Actionis_armed
Condition- lambda calls
- Platforms
- See Also
- Text Component
- Update Core
- Valve Component
- Animation
- Native API Component
- AirTouch AT581x Radar
- BLE Client
- Bluetooth Proxy
- Captive Portal
- CH422G I/O Expander
- Copy Component
- Debug Component
- Deep Sleep Component
- Demo Component
- DF-Player mini
- Overview
- Configuration variables:
dfplayer.is_playing
Conditiondfplayer.play_next
Actiondfplayer.play_previous
Actiondfplayer.play
Actiondfplayer.play_mp3
Actiondfplayer.play_folder
Actiondfplayer.set_device
Actiondfplayer.set_volume
Actiondfplayer.volume_up
Actiondfplayer.volume_down
Actiondfplayer.set_eq
Actiondfplayer.sleep
Actiondfplayer.reset
Actiondfplayer.start
Actiondfplayer.pause
Actiondfplayer.stop
Actiondfplayer.random
Action- All actions
- Test setup
- See Also
- DFRobot mmWave Radar
- EMC2101 Fan Controller and Temperature sensor
- ESP32 Platform
- BLE Component
- ESP32 Bluetooth Low Energy Beacon
- BLE Server
- ESP32 Bluetooth Low Energy Tracker Hub
- ESP32 Camera Component
- ESP32 Camera Web Server Component
- Improv via BLE
- ESP8266 Platform
- ESPHome Core Configuration
- Ethernet Component
- Exposure Notification Listener
- External Components
- 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
Actionezo_pmp.dose_volume
Actionezo_pmp.dose_volume_over_time
Actionezo_pmp.dose_with_constant_flow_rate
Actionezo_pmp.pause_dosing
Actionezo_pmp.stop_dosing
Actionezo_pmp.clear_total_volume_dosed
Actionezo_pmp.set_calibration_volume
Actionezo_pmp.clear_calibration
Actionezo_pmp.find
Actionezo_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
Triggeron_finger_scan_invalid
Triggeron_finger_scan_matched
Triggeron_finger_scan_unmatched
Triggeron_finger_scan_misplaced
Triggeron_enrollment_scan
Triggeron_enrollment_done
Triggeron_enrollment_failed
Triggerfingerprint_grow.enroll
Actionfingerprint_grow.cancel_enroll
Actionfingerprint_grow.delete
Actionfingerprint_grow.delete_all
Actionfingerprint_grow.led_control
Actionfingerprint_grow.aura_led_control
Action- All actions
- Test setup
- See Also
- Font Renderer Component
- Global Variables
globals.set
Action- See Also
- GPS Component
- Graph Component
- Grove TB6612FNG Motor Drive
- Host Platform
- HTTP Request
- I²C Bus
- I²S Audio Component
- Images
- Improv via Serial
- Interval Component
- See Also
- Key collector component
- LibreTiny Platform
- LightWaveRF
- Logger Component
- Matrix keypad
- MAX6956 I/O Expander
- MCP230xx I/O Expander
- MCP23Sxx I/O Expander
- mDNS Component
- Micro Wake Word
- MicroNova based pellet stove
- Modbus Component
- Modbus Controller
- 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
Triggeron_message
Triggeron_json_message
Triggermqtt.publish
Actionmqtt.publish_json
Actionmqtt.connected
Condition- See Also
- Network component
- 1-Wire Bus
- Online Image Component
- Packages
- PCA6416A I/O Expander
- PCA9554 I/O Expander
- PCF8574 I/O Expander
- PipSolar PV Inverter
- PN7150 NFC
- NDEF
- PN7160 NFC
- NDEF
- Power Supply Component
- Prometheus Component
- PSRAM
- Pylontech Battery
- QR Code Component
- Remote Receiver
- Remote Transmitter
- RF Bridge Component
- RP2040 Platform
- Rtttl Buzzer
- Safe Mode
- Script Component
- Script Parameters
script.execute
Actionscript.stop
Actionscript.wait
Actionscript.is_running
Condition- See Also
- Seeed Studio MR24HPC1 mmWave (Kit)
- Servo Component
- Sim800L Component
- SML (Smart Message Language)
- SN74HC165 I/O Expander (shift register)
- SN74HC595 I/O Expander (shift register)
- SPI Bus
- Sprinkler Controller
- Configuration variables:
- An Important Note about GPIO Switches and Control
- Controller Actions
sprinkler.start_full_cycle
actionsprinkler.start_from_queue
actionsprinkler.start_single_valve
actionsprinkler.shutdown
actionsprinkler.next_valve
actionsprinkler.previous_valve
actionsprinkler.pause
actionsprinkler.resume
actionsprinkler.resume_or_start_full_cycle
actionsprinkler.queue_valve
actionsprinkler.clear_queued_valves
actionsprinkler.set_multiplier
actionsprinkler.set_repeat
actionsprinkler.set_divider
actionsprinkler.set_valve_run_duration
action
- Pump and Distribution Valve Coordination
- Controller Examples
- Single Controller, Single Valve, No Pump
- Single Controller, Three Valves, No Pump
- Single Controller, Three Valves, Single Pump
- Single Controller, Three Latching Valves, Single Latching Pump
- Dual Controller, Five Valves, Two Pumps
- Using the Sprinkler Controller’s Numbers
- Extending the Sprinkler Controller’s Switches
- The Sprinkler Controller Queue
- Expose Sprinkler Controller Actions via user-API
- Understanding the Sprinkler Controller’s State
- See Also
- StatsD
- Status LED
- Substitutions
- Sun
- SUN_GTIL2 Grid Tie Inverter
- SX1509 16 channel I/O Expander with LED driver and keypad engine
- Binary Sensor
- TCA9548A I²C Multiplexer
- TCA9555 I/O Expander
- TM1651 Battery Display
- Tuya MCU
- UART Bus
- UDP Component
- Uponor Smatrix Base Pulse Underfloor Heating
- VBus Component
- Voice Assistant
- Web Server Component
- WeiKai SPI/I²C UART/IO Expander
- Wiegand keypad and tag reader
- WiFi Component
- WireGuard Component
- XL9535 I/O Expander