esphome

ESPHome is a system to control your ESP8266/ESP32 by simple yet powerful configuration files and control them remotely through Home Automation systems.

9,231

4,097

9,231

457

View on GitHub

Top Related Projects

core

78,334

:house_with_garden: Open source home automation that puts local control and privacy first.

Alternative firmware for ESP8266 and ESP32 based devices with easy configuration using webUI, OTA updates, automation using timers or rules, expandability and entirely local control over MQTT, HTTP, Serial or KNX. Full documentation at

arduino-esp32

14,694

Arduino core for the ESP32

platformio-core

8,264

Your Gateway to Embedded Software Development Excellence :alien:

pubsubclient

3,910

A client library for the Arduino Ethernet Shield that provides support for MQTT.

Quick Overview

ESPHome is an open-source firmware and ecosystem for ESP8266/ESP32 microcontrollers, designed to simplify the creation of custom home automation devices. It allows users to define their device configurations using YAML files, which are then compiled into custom firmware tailored to their specific needs.

Pros

Easy to use with a simple YAML-based configuration system
Integrates seamlessly with Home Assistant for home automation
Supports a wide range of sensors, displays, and other components
Over-the-Air (OTA) updates for easy maintenance and upgrades

Cons

Limited to ESP8266 and ESP32 platforms
Requires some technical knowledge to set up and configure
May have a steeper learning curve for users new to embedded systems
Some advanced features may require custom C++ code

Code Examples

Basic configuration for an ESP8266 board with a DHT22 sensor:

esphome:
  name: my_sensor
  platform: ESP8266
  board: nodemcuv2

sensor:
  - platform: dht
    pin: D2
    temperature:
      name: "Room Temperature"
    humidity:
      name: "Room Humidity"
    update_interval: 60s

Adding a simple switch to control an LED:

switch:
  - platform: gpio
    name: "LED"
    pin: D5

light:
  - platform: monochromatic
    name: "LED Light"
    output: led_output

output:
  - platform: esp8266_pwm
    id: led_output
    pin: D5

Implementing a custom sensor using C++ code:

esphome:
  name: custom_sensor
  includes:
    - my_custom_sensor.h

sensor:
  - platform: custom
    lambda: |-
      auto my_sensor = new MyCustomSensor();
      App.register_component(my_sensor);
      return {my_sensor};
    sensors:
      - name: "Custom Sensor Value"

Getting Started

Install ESPHome:
```
pip3 install esphome
```

Create a new configuration file (e.g., my_device.yaml):

esphome:
  name: my_device
  platform: ESP8266
  board: nodemcuv2

wifi:
  ssid: "Your_WiFi_SSID"
  password: "Your_WiFi_Password"

# Add your components here

Compile and upload the firmware:
```
esphome run my_device.yaml
```
Access the device through Home Assistant or the ESPHome dashboard.

Competitor Comparisons

core

78,334

:house_with_garden: Open source home automation that puts local control and privacy first.

Pros of Home Assistant Core

Comprehensive home automation platform with a wide range of integrations
Large and active community, providing extensive support and custom components
User-friendly web interface for configuration and control

Cons of Home Assistant Core

Steeper learning curve for advanced configurations
Higher resource requirements, especially for complex setups
Can be overwhelming for users who only need simple device control

Code Comparison

ESPHome configuration (YAML):

esphome:
  name: my_device
  platform: ESP8266
  board: nodemcuv2

sensor:
  - platform: dht
    pin: D2
    temperature:
      name: "Room Temperature"
    humidity:
      name: "Room Humidity"

Home Assistant Core configuration (YAML):

sensor:
  - platform: mqtt
    name: "Room Temperature"
    state_topic: "home/temperature"
    unit_of_measurement: "°C"
  - platform: mqtt
    name: "Room Humidity"
    state_topic: "home/humidity"
    unit_of_measurement: "%"

ESPHome focuses on firmware generation for ESP devices, while Home Assistant Core provides a broader home automation platform. ESPHome's code is more device-specific, whereas Home Assistant Core's configuration is typically integration-based.

Tasmota

23,087

Pros of Tasmota

Larger community and more extensive device support
Web-based configuration interface for easier setup
More frequent updates and active development

Cons of Tasmota

Steeper learning curve for advanced customization
Less integration with Home Assistant compared to ESPHome
Configuration can be more complex for multi-function devices

Code Comparison

Tasmota (configuration example):

# Sonoff Basic configuration
substitutions:
  devicename: sonoff_basic
  friendlyname: Sonoff Basic
  topic: sonoff_basic

ESPHome (configuration example):

# Sonoff Basic configuration
esphome:
  name: sonoff_basic
  platform: ESP8266
  board: esp01_1m

switch:
  - platform: gpio
    name: "Sonoff Basic Relay"
    pin: GPIO12

Both projects aim to provide firmware for ESP8266/ESP32 devices, but they differ in their approach. Tasmota offers a more standalone solution with its web interface, while ESPHome integrates tightly with Home Assistant. Tasmota's configuration is often done through its web interface or MQTT commands, whereas ESPHome uses YAML files for configuration. ESPHome provides a more streamlined experience for Home Assistant users, but Tasmota offers greater flexibility and a wider range of supported devices.

arduino-esp32

14,694

Arduino core for the ESP32

Pros of arduino-esp32

More low-level control and flexibility for advanced users
Wider range of supported ESP32 boards and modules
Extensive library ecosystem within the Arduino framework

Cons of arduino-esp32

Steeper learning curve, especially for beginners
Requires more manual configuration and setup
Less integrated with smart home systems out-of-the-box

Code Comparison

ESPHome example:

esphome:
  name: my_device
  platform: ESP32

sensor:
  - platform: dht
    pin: GPIO22
    temperature:
      name: "Room Temperature"
    humidity:
      name: "Room Humidity"

arduino-esp32 example:

#include <DHT.h>

#define DHTPIN 22
#define DHTTYPE DHT22

DHT dht(DHTPIN, DHTTYPE);

void setup() {
  dht.begin();
}

void loop() {
  float temperature = dht.readTemperature();
  float humidity = dht.readHumidity();
  // Use temperature and humidity values
}

ESPHome uses a declarative YAML configuration, making it easier for beginners to set up sensors and devices. arduino-esp32 requires more traditional programming, offering greater flexibility but with increased complexity. ESPHome integrates seamlessly with home automation systems, while arduino-esp32 provides a foundation for more diverse projects beyond smart home applications.

platformio-core

8,264

Your Gateway to Embedded Software Development Excellence :alien:

Pros of PlatformIO Core

Broader ecosystem support, compatible with multiple frameworks and platforms
More flexible and customizable for advanced users
Extensive library management system

Cons of PlatformIO Core

Steeper learning curve for beginners
Requires more manual configuration for specific projects
Less integrated with smart home systems out-of-the-box

Code Comparison

ESPHome configuration example:

esphome:
  name: my_device
  platform: ESP8266
  board: nodemcuv2

sensor:
  - platform: dht
    pin: D2
    temperature:
      name: "Room Temperature"
    humidity:
      name: "Room Humidity"

PlatformIO Core configuration example:

[env:nodemcuv2]
platform = espressif8266
board = nodemcuv2
framework = arduino

lib_deps =
    adafruit/DHT sensor library

Both ESPHome and PlatformIO Core are powerful tools for embedded development, but they cater to different user needs. ESPHome is more focused on smart home integration and offers a simpler configuration process, while PlatformIO Core provides a more versatile development environment suitable for a wider range of projects and platforms.

pubsubclient

3,910

A client library for the Arduino Ethernet Shield that provides support for MQTT.

Pros of PubSubClient

Lightweight and simple MQTT client library for Arduino and ESP8266
Easy to integrate into existing Arduino projects
Supports QoS 0 and 1 for MQTT messaging

Cons of PubSubClient

Limited to MQTT protocol only, while ESPHome supports multiple protocols
Requires manual coding for device configuration and behavior
Less extensive feature set compared to ESPHome's comprehensive smart home integration

Code Comparison

PubSubClient:

#include <PubSubClient.h>

PubSubClient client(espClient);
client.setServer(mqtt_server, 1883);
client.setCallback(callback);
client.publish("outTopic", "hello world");

ESPHome:

mqtt:
  broker: mqtt_server
  username: username
  password: password

sensor:
  - platform: dht
    temperature:
      name: "Living Room Temperature"
    humidity:
      name: "Living Room Humidity"

ESPHome uses a declarative YAML configuration, while PubSubClient requires manual C++ coding. ESPHome provides a higher-level abstraction for smart home devices, whereas PubSubClient offers more flexibility for custom MQTT implementations in Arduino projects.

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

ESPHome

Documentation -- Issues -- Feature requests

Top Related Projects

Convert designs to code with AI

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot