esphomeyaml Dashboard

{% for file, full_path in zip(files, full_path_files) %}

Full path: {{ escape(full_path) }}

Upload Compile Show Logs Validate

{% end %}

Introduction And Name

Hi there! I'm the esphomeyaml setup wizard and will guide you through setting up your first ESP8266 or ESP32-powered device using esphomeyaml.
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.

esphomeyaml, 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). Later, you will be able to customize this file and add some of esphomelib's many integrations.

First, I need to know what this node should be called. Choose this name wisely, changing this later makes Over-The-Air Update attempts difficult. Names must be lowercase and must not contain spaces (allowed characters: a-z, 0-9 and _)

Name of node
Device Type

Great! Now I need to know what type of microcontroller you're using so that I can compile firmware for them. Please choose either ESP32 or ESP8266 (use ESP8266 for Sonoff devices).

Microcontroller Type

I'm also going to need to know which type of board you're using. Please go to ESP32 boards or ESP8266 boards, find your board and enter it here. For example, enter nodemcuv2 for ESP8266 NodeMCU boards. Note: Use esp01_1m for Sonoff devices.

Board Type
WiFi And Over-The-Air Updates

Thanks! Now I need to know what WiFi Access Point I should instruct the node to connect to. Please enter an SSID (name of the WiFi network) and password (leave empty for no password).

WiFi SSID

WiFi Password

Esphomelib automatically sets up an Over-The-Air update server on the node so that you only need to flash a firmware via USB once. Optionally, you can set a password for this upload process here:

OTA Password
MQTT

esphomelib connects to your Home Assistant instance via MQTT. If you haven't already, please set up MQTT on your Home Assistant server, for example with the awesome Mosquitto Hass.io Add-on.

When you're done with that, please enter your MQTT broker here. For example 192.168.1.100 (Note hassio.local doesn't always work, please use a static IP). Please also specify the MQTT username and password you wish esphomelib to use (leave them empty if you're not using any authentication).

MQTT Broker

MQTT Username

MQTT Password
Done!
Hooray! 🎉🎉🎉 You've successfully created your first esphomeyaml configuration file. When you click Submit, I will save this configuration file under <HASS_CONFIG_FOLDER>/esphomeyaml/<NAME_OF_NODE>.yaml and you will be able to edit this file with the HASS Configuratior add-on.

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. Note that you need to restart this add-on for newly plugged in serial devices to be detected.
- With the current configuration, your node will only connect to WiFi and MQTT. To make it actually do stuff, follow the rest of the getting started guide .
- See the esphomeyaml index for a list of supported sensors/devices.
- Join the Discord server and say hi! When I have time, I would be happy to help with issues and discuss new features.
- Star esphomelib and esphomeyaml on GitHub if you find this software awesome and report issues using the bug trackers there.

Set up your first Node

Huh... It seems like you you don't have any esphomeyaml configuration files yet... Fortunately, there's a setup wizard that will step you through setting up your first node 🎉

Show Logs

Compile And Upload

Compile

Validate

Next steps

Set up your first Node