ESPEasy

From Let's Control It
Jump to: navigation, search
Welcome to ESP Easy,
the open source firmware for ESP8266.

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 HC-SR04.jpg Switch Lightswitch.jpg Door Switch.png PIR.jpg
Analog More Analog
Analog Analog.png PCF8591 PCF8591Module.jpg
ADS1115 ADS1115.jpg
Digital inputs Infrared Receivers
MCP23017 MCP23017DIP28.jpg
PCF8574 PCF8574.jpg
IR TSOP4838.png
Motion
MPU 6050 Mpu-6050.jpg
Actuators (Output)
Digital output Servo
Output pin LED.jpg
Relays Relaisbordje.jpg
Servo Servo.png
IR-Transmit Extra IO
IR Led IRLED.png MCP23017 MCP23017DIP28.jpg
PCF8574 PCF8574.jpg
PWM Motor Shield
PCA9685 PCA9685Module.jpg
PWM GPIOMosFET.png
Adafruit Motor Shield v2 Motor shield klein.jpg
Buzzer (RTTL)
RTTL Buzzer.jpg


Other
LCD OLED Level Shifter
LCD Display LCDDemo.jpg OLED Display OLED.png Level Shifter Level shifter example.jpg

Modded Hardware Products

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

Tutorials

Hardware Tips 'n Tricks

Examples

Loading firmware

Tutorial_ESPEasy_Firmware_Upload

Protocol selection

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

EasyProtocols

Configuration

The ESP8266 boards are generally easy to use and understand but some precautions need to be taken when it comes to the different GPIOs available. This section tells you more about the ESPeasy setup and the ESP unit's need to know settings (GPIO boot states etc.).

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: