ESPEasy

Welcome to ESP Easy, the open source firmware for ESP8266.

ESP Hardware Devices Modded Hardware

Forum ESP Easy web interface Template Files

History of ESP Easy Milestones/Roadmap Contributors

Introduction

The ESP Easy firmware can be used to turn the ESP module into an easy multifunction sensor device for Home Automation solutions like Domoticz. Configuration of the ESP Easy is entirely web based, so once you've got the firmware loaded, you don't need any other tool besides a common web browser.

The ESP Easy firmware is currently at build R120 an looks stable enough for production purposes as long as it's being used as a sensor device.

ESP Easy also offers limited "low level" actuator functions but due to system instability, this could be less useful in real life applications.

Get started

Getting started with the ESP Easy takes a few basic steps. In most cases your ESP module comes with the AT firmware or the NodeMCU LUA firmware. We need to replace the existing firmware with the ESP Easy firmware. We provide a (Windows only) flashtool to make this process an easy job.

1. Download firmware as binary including flash tool
↓
2. Connect the ESP to Windows PC
Using either USB/UART of board or separate USB/TTL adapter
↓
3. Write firmware using flash tool
Note necessity for GPIO to be LOW to enter flashmode
↓
4. Restart ESP. WiFi "AP ESP_0" will appear
↓
5. Search for you routers WiFi and connect
↓
6. Reconnect to your WiFi and enter IP adress shown on previous screen

Supported Hardware

ESP Easy can be installed/flashed on nearly every piece of Hardware that has an ESP8266 built-in, newest 2.0.0 version even does support the ESP8285 (basically an ESP8266 with buildtin 1M Flash). Please see the list here for more in depth detail about the hardware.

Supported Sensors/Actuators

The in depth list of devices (sensors and actuators) is found here.

OLD Supported Sensors/Actuators List

This list is being migrated to the new list found here.

Sensors (Input)
Distance	Switch
HC-SR04	Switch
Analog	More Analog
Analog	PCF8591 ADS1115
Digital inputs	Infrared Receivers
MCP23017 PCF8574	IR
Motion
MPU 6050

Actuators (Output)
Digital output	Servo
Output pin Relays	Servo
IR-Transmit	Extra IO
IR Led	MCP23017 PCF8574
PWM	Motor Shield
PCA9685 PWM GPIO	Adafruit Motor Shield v2
Buzzer (RTTL)
RTTL

Other
LCD	OLED	Level Shifter
LCD Display	OLED Display	Level Shifter

Modded Hardware Products

A list of (officially) modded hardware products is found here.

Tutorials

• Using the flashtool to upload the ESP Easy firmware
• Using the Arduino IDE to upload the ESP Easy firmware
• Using the ESP Easy as a simple input switch in Domoticz
• Using the ESP Easy to control a LED of Relay from OpenHAB
• Rules, a modest way to locally control something in ESP Easy
• GlobalSync

Hardware Tips 'n Tricks

• Power stability
• Relays
• Breadboards
• WiFi interference

Examples

• Analog Pressure Sensor
• DC Voltage divider

Loading firmware

• Current stable: ESPEasy R120

• Old release candidate: ESPEasy R147_RC8 (is being replaced by version 2.0)

• New release candidates are on github: ESPEasy version 2.0 and higher

Tutorial_ESPEasy_Firmware_Upload

Protocol selection

The ESP Easy supports several Home Automation controllers or web-services that collect sensor data.

EasyProtocols

Configuration

This section tells you more about the ESPeasy setup and the ESP unit's need to know settings (GPIO boot states etc.).

GPIO on ESP8266

GPIO Number	GPIO Name	Boot State	Precautions and information
0	D3	HIGH for boot LOW for serial programming	Pullup resistor on most boards
1			Used as serial (TX) May be used but observe that signal might flicker due to serial activity during boot.
2	D4	HIGH for boot HIGH for serial programming	Connected to onboard LED (low active) Used as serial1 (TX1)
3			Used as serial (RX) May be used but observe that signal might flicker due to serial activity during boot.
4	D2		Generally used as SDA (I2C)
5	D1		Generally used as SCL (I2C)
6			Do not use! Reserved for SPI + flash
7			Do not use! Reserved for SPI + flash
8			Do not use! Reserved for SPI + flash
9	D11		Do not use! Reserved for SPI + flash
10	D12		Use with caution! Reserved for SPI + flash
11			Do not use! Reserved for SPI + flash
12	D6
13	D7
14	D5
15	D8	LOW for boot	Pulldown resistor on most boards
16	D0		No PWM. No internal pullup available. Used in sleep mode for wakeup

ESP Easy web interface

The ESP Easy has a user-friendly web interface for all configuration settings. They are locally stored in flash memory and retained on power-off. We explain all configuration pages and settings here.

Command Reference

ESPEasy Command Reference

System variables Reference

ESPEasy System Variables

Tutorial Rules

Tutorial Rules

Most information on rules (=local logic on ESP without controller) can be found in the tutorial

Support and discussion

• Forum
• IRC: #espeasy @freenode

Source code development

Sources are on Github

Want to contribute? Anyone is invited to do so, but please read this first: ESPEasyDevelopmentGuidelines

If you're new to this, follow these guides:

• Install Atom and platformio: Tutorial Install Platformio
• If you want to be send us back your changes via github follow: Tutorial preparing to work with github (otherwise skip it)
• Then you're ready for: Tutorial building and uploading with platformio
• And eventually, if you did the github stuff: Tutorial Contributing Back To ESPEasy