/esphome-config

My ESPHome configuration & documentation.

MIT LicenseMIT

Ghimele's ESPHome configuration

Project Maintenance License

GitHub Actions GitHub Activity GitHub Last Commit

ESPHome Logo

This repository contains the various configuration files I use for the various ESPHome devices I have and use around my home.

Devices

I have a number of ESPHome devices around my Smart Home and I've to provide a description and readme for each of these devices to share how I built the device and what I use it for. I also use these readme to document any special components I've used with the device and any specific build steps I followed.

Device Description Config files Readme
Refoss P11 Refoss P11 Power Monitoring Plug epp-plg01.yaml
epp-plg02.yaml
Refoss P11 readme
MOES MS-105 MOES MS-105 Smart Dimmer epp-dmr01.yaml MOES MS-105 readme
Crono Custom Crono Thermostat that runs the heaters on my house epp-crn01.yaml Crono readme

Splitting up the ESPHome configuration

A pattern I have seen used by a others in the community which makes an ESPHome config much more readable is to split out common components to their own .yaml files.

I took inspiration from this repository jcallaghan ESPHome Configs

|-- ESPHome-Config
    |-- .build (local directory not pushed to this repo)
    |-- .esphome (local directory not push to this repo)
    |-- assets (storage for images used in my configs)
    |-- boards (definitions for each board type)
    |   |-- .esphome.yaml
    |   |-- board_definition.yaml
    |-- components (used to organised yaml files)
    |   |-- binary_sensors
    |   |-- buttons
    |   |-- common (used with both ESP32 and ESP8266 boards)   
    |   |-- common_esp32 (used just for ESP32 board)
    |   |-- debug
    |   |-- dusplay (collect all the display devices used in my projects)
    |   |-- fonts (used within the display devices)
    |   |-- sensors
    |   |-- switches
    |   |-- text_sensors
    |   |-- time
    |-- devices (device definitions)
    |   |-- ESPC3_Relay_X1.yaml
    |   |-- Refoss_P11_PMP.yaml
    |-- docs (collection of readme for each device configured)
    |-- .gitignore
    |-- esph_device_configuration_1.yaml (definition for each ESP board I run ESPHome on)
    |-- esph_device_configuration_2.yaml
    |-- esph_device_configuration_3.yaml
    |-- readme.md (this readme)
    |-- secrets.yaml (where passwords and other secrets are stored and not pushed to this repo)

References