Dashboard - ESPHome

{% for i, entry in enumerate(entries) %}

{{ escape(entry.name) }} {% if 'web_server' in entry.loaded_integrations %} {% end %} {% if entry.update_available %} {% end %}

Filename:


                {{ escape(entry.filename) }}

{% if entry.comment %}

{% end %}

Edit Validate Upload Logs

{% end %}

{% if len(entries) == 0 %}

Welcome to ESPHome

It looks like you don't yet have any Nodes configured.

Click on the pulsating button at the bottom right of the page to add a Node.

{% end %}

Create New Node

Welcome

Welcome to the ESPHome node setup wizard! As there are no nodes setup you will be guided through setting up your first ESP8266 or ESP32-powered device using ESPHome.

ESP8266s and their successors (the ESP32s) are great low-cost microcontrollers that can communicate with the outside world using WiFi. They're found in many devices such as the popular Sonoff/iTead, but also exist as development boards such as the NodeMCU.

ESPHome, the tool you're using here, creates custom firmwares for these devices using YAML configuration files (similar to the ones you might be used to with Home Assistant).

This wizard will create a basic YAML configuration file for your "node" (the microcontroller) and later, you will be able to customize this file with some of ESPHome's many avaliable integrations.

When you are ready click "begin" to move onto the next step!
{% end %} {% if len(entries) >= 1 %}
{% end %}
Node Name

{% if len(entries) == 0 %}
Firstly, please decide on a name for the node. Choose this name wisely, it should be unique among all of your ESPHome nodes.
{% end %} {% if len(entries) >= 1 %}
Select a unique name for the node.
{% end %}
Names must be all lowercase and must not contain any spaces! Characters that are allowed are: a-z, 0-9, _ and -.

Node Name
Device Type

{% if len(entries) == 0 %}
Now that you have named your node, please select what type of microcontroller you are using so that the firmware for your node can be compiled correctly.
{% end %} {% if len(entries) >= 1 %}
Select the type of microcontroller that you are using for the node.
{% end %}
If unsure you can also select a similar board or choose the "Generic" option.
WiFi & Updates

{% if len(entries) == 0 %}
Finally, please enter the details for the WiFi network you want the node to connect to. Please enter an SSID (name of the WiFi network) and the password needed to connect (if the network has no password then this can be left blank):
{% end %} {% if len(entries) >= 1 %}
Enter the details for the WiFi network the node can connect to:
{% end %}
WiFi SSID

WiFi Password
{% if len(entries) == 0 %}
This wizard will automatically set up an Over-The-Air (OTA) update server on the node so that you only need to flash the firmware via USB once. You can optionally password protect this OTA update server by setting up a password here:
{% end %} {% if len(entries) >= 1 %}
Setup an optional password for the Over-The-Air (OTA) update server:
{% end %}
OTA Access Password
Finish
{% if len(entries) == 0 %}
Hooray! 🎉🎉🎉 You have successfully created your first ESPHome configuration file. When you click Submit, the wizard will save the configuration file as {{ escape(config_dir) }}/<NAME_OF_NODE>.yaml.

Next steps
- Flash the firmware. This can be done using the “UPLOAD” option in the dashboard. See this for guides on how to flash different types of devices. For newly plugged in serial devices to be detected, restart the add-on.
- With the current configuration, your node will only connect to WiFi. To make it actually do stuff, follow the rest of the getting started guide .
- See the ESPHome Documentation for a list of supported sensors/devices.
- Join the Discord server and say hi! Discord's the best place to ask if you have issues/ideas.
- Star ESPHome on GitHub if you find this software awesome and report issues using the bug trackers there.
{% end %} {% if len(entries) >= 1 %}
Click submit to finish creating the node!
{% end %}

Welcome to ESPHome

Editing:

Compiling & Uploading:

Update All

Validate:

Showing Logs For:

Compiling:

Clean MQTT Discovery For:

Clean Build Files For:

Create New Node

Next steps