Guides

• Automations and Templates
  • Actions
  • Templates (Lambdas)
    • Bonus: Templating Actions
  • Global Variables
  • Do Automations Work Without a Network Connection
  • All Triggers
  • All Actions
  • All Conditions
  • All Lambda Calls
  • delay Action
  • lambda Action
  • lambda Condition
  • and / or / not Condition
  • if Action
  • while Action
  • repeat Action
  • wait_until Action
  • component.update Action
  • globals.set Action
  • script Component
  • Script Parameters
  • script.execute Action
  • script.stop Action
  • script.wait Action
  • script.is_running Condition
  • for Condition
  • interval Component
  • Timers and timeouts
  • See Also
• Changelog
• Command Line Interface
  • Base Usage
  • --help Option
  • --verbose Option
  • --quiet Option
  • --substitution Option
  • run Command
  • config Command
  • compile Command
  • upload Command
  • clean-mqtt Command
  • wizard Command
  • mqtt-fingerprint Command
  • version Command
  • clean Command
  • dashboard Command
  • logs Command
• Configuration Types
  • ID
  • Pin
  • Pin Schema
  • Time
  • Substitutions
    • YAML insertion operator
    • Substitute !include variables
    • Command line substitutions
  • Packages
    • Local packages
    • Remote/git Packages
  • See Also
• Contributing
  • Contributing to ESPHome-Docs
    • Through Github
    • Build
    • Notes
    • Syntax
  • Setting Up Development Environment
  • Setting Up Git Environment
  • Contributing to ESPHome
    • 1. Directory Structure
    • 2. Config Validation
    • 3. Code Generation
    • 4. Runtime
    • 5. Extras
  • Codebase Standards
  • See Also
• Sharing ESPHome devices
  • Example configuration
  • Relevant Documentation
  • See Also
• DIY Examples
  • Blog Posts & Videos
  • Custom Components & Code
  • Sample Configurations
• Frequently Asked Questions
  • Tips for using ESPHome
  • I can’t get flashing over USB to work.
  • Help! Something’s not working!!
  • How to submit an issue report
  • How do I update to the latest version?
  • How do I update to the latest beta release?
  • How do I use the latest bleeding edge version?
  • How do I use my Home Assistant secrets.yaml?
  • Does ESPHome support [this device/feature]?
  • I have a question… How can I contact you?
  • My node keeps reconnecting randomly
  • Component states not restored after reboot
  • Docker Reference
  • Notes on disabling mDNS
  • Can Configuration Files Be Recovered From The Device?
  • Why shouldn’t I use underscores in my device name?
  • Why am I getting a warning about strapping pins?
  • How can I test a Pull Request?
  • See Also
• Getting Started with the ESPHome Command Line
  • Installation
  • Connecting the ESP Device
  • Creating a Project
  • Adding some features
  • First uploading
  • Adding A Binary Sensor
  • Where To Go Next
  • Bonus: ESPHome dashboard
  • See Also
• Getting Started with ESPHome and Home Assistant
  • Installing ESPHome Dashboard
  • Dashboard Interface
  • Adding some (basic) features
  • Connecting your device to Home Assistant
  • Adding A Binary Sensor
  • Where To Go Next
  • See Also
• Installing ESPHome Manually
  • Windows
  • Mac
  • Linux
  • See Also
• Made for ESPHome
  • Requirements
  • Logos
• Migrating from ESPEasy
  • Getting Binary
  • Uploading Binary
  • See Also
• Migrating from ESPurna
  • Getting Binary
  • Uploading Binary
  • See Also
• Migrating from Sonoff Tasmota
  • Getting the Binary
  • Uploading the Binary
  • See Also
• Physically Connecting to your Device
  • Connecting to the ESP
    • USB Port on Device
    • Pre-soldered Programming Header
    • Unpopulated Programming Header
    • Solder-filled Programming Header
    • Module Only
    • Bare Chip
  • Materials
  • See Also
• Contributors
  • Contributors