How To guide when Install a new ESP Devices Into Home Assistant with ESPHome

ESPHome
1

I thought I would create a post on a “How To” guide when installing a new ESP device into Home Assistant with ESPHome.

There are a lot of ESP devices out there so the below index will have a link to the post that shows you the “How To” guide for that ESP device. More ESP devices will be added in time.

Please feel free to post your “How To” guide below and if the community gives it a :+1: with 10+ :heart: I will create a link here (Please PM me if I have missed putting the index link). The “How To” guide must be in this post for me to link it, as I don’t want to hijack someone else’s topic.

:straight_ruler: POST RULES

  • When posting your “How To” guide, please use the 2nd post as a general format layout. At the top make sure you put the name of the ESP in bold so we will know where or how to link it in the top index and for what ESP device it is for. Your code may be enough with just a few steps if needed like in the 2nd post, the critical item is, you must push and hold down the button and then plug it in for it to be seen and installed (flashed) for the first time.

  • This is not a “How To”, to make the ESP do anything just a “How To” guide on connecting your ESP to Home Assistant and ESPHome so new users can get started. If you need help making it do something then please create a different topic on this forum as it is very active and a lot of community members are actively helping others.

  • If you try a “How To” guide and it works, please make sure you click the :heart: in that members post as it will show everyone it worked.

INDEX BELOW

M5Stack

  1. M5Stamp C3U Mate
1 Like
2

M5Stamp C3U Mate

Go into your ESPHome once you added the integration and click “+ NEW DEVICE”. then click “continue”

1

Then add the name you would like to call the new device.

2

Select ESP32-C3

3

Your encryption key will be created and click skip.

4
4391×517 54.2 KB

You will see an new device created, click edit.

5

Here will be all your YAML.

6
6656×634 84.9 KB

In the yaml we will need to update a few things. Below is my code. I have updated my api, ota, wifi information and ap. The main thing you will need to update is your wifi information.

esphome:
  name: esp32-c3-test-board
  friendly_name: ESP32-C3-Test-Board

esp32:
  board: esp32-c3-devkitm-1
  framework:
    type: arduino

# Enable logging
logger:

# Enable Home Assistant API
api:
  encryption:
    key: !secret encryption_key

# Over The Air Password (Stops somone on your network accessing files)
ota:
  password: !secret esphome_secret

# Wifi Information
wifi:
  ssid: !secret wifi_ssid
  password: !secret wifi_password

## Optional manual - Static IP
###  manual_ip:
###    static_ip: ?.?.?.?
###    gateway: ?.?.?.?
###    subnet: 255.255.255.0

# Enable fallback hotspot (captive portal) in case wifi connection fails
  ap:
    ssid: "Esp32-C3-Test-Board"
    password: !secret fallback_ap_password

# Captive Portal
## After 1 minute of unsuccessful WiFi connection attempts, 
## the Atom Lite will start a WiFi hotspot (with the credentials from your fallback).
## Use your AP (Access Point WiFi) SSID & Password to connect then go to http://192.168.4.1/ in your browser.
captive_portal:

Once you are happy with your code click “install” and for the first time it is best to plug your ESP directly into what it running Home Assistant / ESPHome. Then click “Plug into the computer running ESPHome Dashboard”

7

With the “M5Stamp C3U Mate” you will have to push the button first, hold it down and then pug the USB in. You only need to do this the first time you install your code. After that you can just plug it in.

8

If you dont hold the button down when plugging it in you will see this. If you see this unplug it and push the button holding it down and plug it in again.

9

You should now see something like this. Select the correct port that the ESP is plugged in to.

10

It will then start installing. Once done you will see this.

11
111623×839 153 KB

Unplug the ESP from USB and you can now move it around and plug it in anywhere. You will then see you device is online as shown below.

12

Now you can add whatever code you would like to your YAML and use “wirelessly” when you install your code.

You will probably see a new device is discovered in Home Assistant. If you click on it and click configure you will have to input your encryption key that is in your YAML and follow the set up.

Enjoy

Blacky :smiley:

1 Like