NodeMCU Documentation¶

NodeMCU is an open source Lua based firmware for the ESP32 and ESP8266 WiFi SOCs from Espressif. It uses an on-module flash-based SPIFFS file system. NodeMCU is implemented in C and the ESP32 version is layered on the Espressif ESP-IDF.

The firmware was initially developed as is a companion project to the popular ESP8266-based NodeMCU development modules, but the project is now community-supported, and the firmware can now be run on any ESP module.

Important

The NodeMCU release and dev branches target the ESP8266. The dev-esp32 branch targets the ESP32.

Up-To-Date Documentation¶

At the moment the only up-to-date documentation maintained by the current NodeMCU team is in English. It is part of the source code repository (/docs subfolder) and kept in sync with the code.