Skip to content


Repository files navigation

Latest Nightly Build Status Downloads Docs Patreon Ko-Fi PayPal
GitHub version Build status Downloads Documentation Status donate donate donate

For ways to support us, see this announcement on the forum, or have a look at the Patreon, Ko-Fi or PayPal links above.

ESPEasy (development branch)

Introduction (and, mostly outdated, wiki:

MEGA This is the development branch of ESPEasy. All new features go into this branch, and it has become the current stable branch. If you want to do a bugfix, do it on this branch.

Check here to learn how to use this branch and help us improving ESPEasy: Starter guide for (local) development on ESPEasy

Web based flasher (experimental)

To make it easier to get started, one may flash a build directly to the ESP from your browser. Currently only Chrome and Edge are supported.

See this flash page to try the new web flash feature.

The web flasher is using ESP Web Tools made by the people behind ESPHome and Home Assistant.

Binary releases

On demand, controlled by the repo owner, our build-bot will build a new binary release:

The releases are named something like 'mega-20220626' (last number is the build date)

Depending on your needs, we release different types of files:

The name is built up from a few key parts:


[build-type] can be any of:

Build type Description included plugins
climate All plugins related to climate measurement Stable + Climate
custom Custom predefined set/Defined in Custom.h Specific
normal Standard plugins Stable
collection_A Normal + plugin collection A Stable + Collection base + set A
collection_B Normal + plugin collection B Stable + Collection base + set B
collection_C Normal + plugin collection C Stable + Collection base + set C
collection_D Normal + plugin collection D Stable + Collection base + set D
collection_E Normal + plugin collection E Stable + Collection base + set E
collection_F Normal + plugin collection F Stable + Collection base + set F
collection_G Normal + plugin collection G Stable + Collection base + set G
max All available plugins All available
energy All plugins related to energy measurement Stable + Energy measurement
display All plugins related to displays Stable + Displays
neopixel All plugins related to neopixel Stable + Neopixel
hard hardware specific builds Minimal
minimal minimal plugins for specific use-cases Switch and Controller
spec_* specialized technical builds Not intended for regular use
IRext Infra-red hardware specific Sending and receiving IR cmd
safeboot (Experimental) safeboot build to enable
most/all plugins on 4MB Flash boards

[opt-arduino-library] (optional) can be any of:

Arduino library Description
alt_wifi Alternative WiFi configuration
beta Arduino Beta release
sdk3 Arduino SDK v.3
core_274 Arduino Core 2.7.4 release
core_302 Arduino Core 3.0.2 release
core_274_sdk3 Arduino Core 2.7.4 SDK v.3 release

[hardware-type] can be any of:

Hardware type Description
ESP8266 Espressif ESP8266/ESP8285 generic boards
WROOM02 Espressif ESP8266 WRoom02 boards
ESP32 Espressif ESP32 generic boards
ESP32solo1 Espressif ESP32-Solo1 generic boards
ESP32s2 Espressif ESP32-S2 generic boards
ESP32c3 Espressif ESP32-C3 generic boards
ESP32s3 Espressif ESP32-S3 generic boards
ESP32c2 Espressif ESP32-C2 generic boards
ESP32c6 Espressif ESP32-C6 generic boards
ESP32-wrover-kit Espressif ESP32 wrover-kit boards
SONOFF Sonoff hardware specific
other_POW Switch with power measurement
Shelly_1 Shelly 1 switch
Shelly_PLUG_S Shelly plug S switch with power measurement
Ventus Ventus W266 weather station
LCtech_relay LC-tech serial switch

N.B. Starting 2022/07/23, 1M ESP8266 builds can also be used on ESP8285 units and thus there is no longer a specific ESP8285 build anymore.

[flash-size] can be any of:

Flash size Description
1M 1 MB with 128 kB filesystem
2M 2 MB with 128 kB filesystem
2M256 2 MB with 256 kB filesystem
2M320k 2 MB with 320 kB filesystem
4M1M 4 MB with 1 MB filesystem
4M2M 4 MB with 2 MB filesystem
16M 16 MB with 14 MB filesystem
4M316k 4 MB with 316 kB filesystem
8M1M 8 MB with 1 MB filesystem
16M1M 16 MB with 1 MB filesystem
16M8M 16 MB with 8 MB filesystem

N.B. Starting with release 2023/12/25, All ESP32 LittleFS builds use IDF 5.1, to support newer ESP32 chips like ESP32-C2 and ESP32-C6 and SPI Ethernet. Other SPIFFS based ESP32 builds will be migrated to LittleFS as SPIFFS is no longer available in IDF 5 and later. A migration plan will be made available in 2024.

[opt-build-features] can be any of:

Build features Description
LittleFS Use LittleFS instead of SPIFFS filesystem (SPIFFS is unstable > 2 MB, and no longer supported in IDF > 5)
VCC Analog input configured to measure VCC voltage (ESP8266 only)
OTA Arduino OTA (Over The Air) update feature enabled
Domoticz Only Domoticz controllers (HTTP) and plugins included
Domoticz_MQTT Only Domoticz controllers (MQTT) and plugins included
FHEM_HA Only FHEM/OpenHAB/Home Assistant (MQTT) controllers and plugins included
ETH Ethernet interface enabled (ESP32-classic and IDF 5.x based builds)
OPI_PSRAM Specific configuration to enable PSRAM detection, ESP32-S3 only
CDC Support USBCDC/HWCDC-serial console on ESP32-C3, ESP32-S2, ESP32-S3 and ESP32-C6
noOTA/NO_OTA Does not support OTA (Over The Air-updating of the firmware) Use the flash page or ESPTool via USB Serial

Some example firmware names:

Firmware name Hardware Included plugins
ESPEasy_mega-20230822_normal_ESP8266_1M.bin ESP8266/ESP8285 with 1MB flash Stable
ESPEasy_mega-20230822_normal_ESP8266_4M1M.bin ESP8266 with 4MB flash Stable
ESPEasy_mega-20230822_collection_A_ESP8266_4M1M.bin ESP8266 with 4MB flash Stable + Collection base + set A
ESPEasy_mega-20230822_normal_ESP32_4M316k.bin ESP32 with 4MB flash Stable
ESPEasy_mega-20230822_collection_A_ESP32_4M316k.bin ESP32 with 4MB flash Stable + Collection base + set A
ESPEasy_mega-20230822_collection_B_ESP32_4M316k.bin ESP32 with 4MB flash Stable + Collection base + set B
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_CDC_ETH.bin ESP32-S3 with 8MB flash, CDC-serial, Ethernet All available plugins
ESPEasy_mega-20230822_max_ESP32s3_8M1M_LittleFS_OPI_PSRAM_CDC_ETH.bin ESP32-S3 8MB flash, PSRAM, CDC-serial, Ethernet All available plugins
ESPEasy_mega-20230822_max_ESP32_16M1M.bin ESP32 with 16MB flash All available plugins
ESPEasy_mega-20230822_max_ESP32_16M8M_LittleFS_ETH.bin ESP32 with 16MB flash, Ethernet All available plugins

The binary files for the different ESP32 variants (S2, C3, S3, C2, C6, 'Classic') are available in separate archives.

To see what plugins are included in which collection set, you can find that on the ESPEasy Plugin overview page

Documentation & more info

Our new, in-depth documentation can be found at Automatically built, so always up-to-date according to the contributed contents. The old Wiki documentation can be found at

Additional details and discussion are on the "Experimental" section of the forum:

Gitpod Ready-to-Code

Icons used

Icons on courtesy of ICONS8.