ESPHome

*** THIS CONTENT IS DRAFT ***

This Wiki documents my implementation of ESPHome and how my devices are configured.

• Install guide
• Flashing
• Common config
• Custom components
• Hardware
• Devices
• Templates
• Knowledge Articles
• Community

About

ESP compute modules are a key part to my tinkering projects and wherever I can I use ESPHome to manage and integrate them with Home Assistant.

Install guide

Local python installation

I install ESPHome on my main workstation which I use for flashing.

Docker

I run ESPHome in a Docker container on my Synology NAS.

1. Download the Docker image down from the Registry or use cli.

   docker pull esphome/esphome:latest``` or ```docker pull esphome/esphome:dev
   

2. Create a new container.

   esphome:
     container_name: docker-esphome
     net: "host"
     restart: always
     user: 0:0
     environment:
       - HOME = "/"
     image: esphome/esphome:dev
     ports:
       - 0.0.0.0:6052:6052
       - 0.0.0.0:6123:6123
     volumes:
       - /volume1/docker/esphome-config:/config:rw
     command: config/ dashboard

3. Create the container using docker-compose docker-compose -f docker-compose.yaml up -d command.

4. ESPHome should be available via the host server at port 6052.

Flashing

• Instructions about how I flash
• USB serial tool or a good quality micro USB lead
• esptool.py
• Create config through the dashboard, compile, download the binary and flash
• Best practice - always start by using secrets, use substitutes to help you create common templates and flash quicker
• Tools - ESPEasy Flasher; ESP Eash Flasher

Repo and config management

My Github repo and how I manage my config

Common config

Yaml includes managing standards. + substitutions Naming etc.

Custom components

Call out custom work done.

Hardware

I have a number of different ESP modules which I have captured in the table below and an associated issue where I capture flashing instructions and any board-specific information.

Module	Template	Flashing
D1 Mini
ESP32
ESP32Cam		#49
Sonoff POWR2
ESP8266

Devices

Summary of my devices.

Device	Board	Integration
Upstairs (ESP32)		Xiaomi LYWSD02

Templates

Quick start YAML for the boards

Knowledge articles

• Renaming a device.
• Secrets
• Sliding window average

Community

Links to other repos. Discord. Twitter etc.

• Discord
• Albert Nisbet - Using ESPHome on a Raspberry Pi with Docker

Draft

Warning! You are not connected to the Internet. https://github.com/esphome/issues/issues/999

https://esphome.io/guides/automations.html#automation great for tips on integrating home assistant entities in ESPHome