Go to file
Bernd Meyer 6db8c43480 Prevent memory leak in UART driver when message handling is slow 2021-11-04 20:54:56 +11:00
.github Lock build runner version. 2021-09-09 17:43:17 +10:00
components Prevent memory leak in UART driver when message handling is slow 2021-11-04 20:54:56 +11:00
docs Implement tmr.wdclr() 2021-10-22 12:38:07 +11:00
examples consolidate telnet example 2016-01-06 23:18:42 +01:00
lua_compat Set missing DATABITS_8 property (#2672) 2019-04-22 11:41:13 +02:00
lua_examples Add touch sensor module (#2863) 2019-10-27 19:49:56 +01:00
lua_modules Joystick Lua library and example code (#2710) 2019-04-22 14:46:49 +02:00
sdk Update to latest IDF master. 2021-08-24 10:24:49 +10:00
tools Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. 2021-08-22 02:03:05 +10:00
.gitignore Update RTD MkDocs (#3457) 2021-08-16 15:27:56 +10:00
.gitmodules ESP32 precompiled toolchain (#2730) 2019-04-22 14:45:27 +02:00
.readthedocs.yaml Update RTD MkDocs (#3457) 2021-08-16 15:27:56 +10:00
CMakeLists.txt Code cleanup to sort out warnings. 2021-07-29 13:47:45 +10:00
CONTRIBUTING.md Switch from readthedocs.org to readthedocs.io 2016-04-28 08:09:35 +02:00
LICENSE update doc 2014-11-21 00:10:01 +08:00
Makefile Add ESP32C3 support/coexistence. 2021-08-11 17:32:47 +10:00
README.md Replace CI badge 2021-08-04 12:24:49 +02:00
install.sh idf4: overhaul to new build system, part 1 of 3 2021-07-15 16:27:03 +10:00
mkdocs.yml Added heaptrace module. 2021-09-16 13:54:55 +10:00
requirements.txt Attempt to address IDF certificate issue 2021-10-06 21:30:45 +02:00
sdkconfig.defaults Port Terry's Lua 5.1 + 5.3 work from the esp8266 branch. 2021-08-22 02:03:05 +10:00

README.md

NodeMCU on ESP32

Join the chat at https://gitter.im/nodemcu/nodemcu-firmware CI Documentation Status License

A Lua based firmware for ESP32 WiFi SOC

NodeMCU is an eLua based firmware for the ESP32 WiFi SOC from Espressif. The firmware is based on the Espressif IoT Development Framework and uses a file system based on spiffs. The code repository consists of 98.1% C-code that glues the thin Lua veneer to the SDK.

The NodeMCU firmware is a companion project to the popular NodeMCU dev kits, ready-made open source development boards with ESP8266-12E chips.

Summary

  • Easy to program wireless node and/or access point
  • Based on Lua 5.1.4 (without debug, os modules)
  • Asynchronous event-driven programming model
  • 10+ built-in modules
  • Firmware available with or without floating point support (integer-only uses less memory)
  • Up-to-date documentation at https://nodemcu.readthedocs.io

Programming Model

The NodeMCU programming model is similar to that of Node.js, only in Lua. It is asynchronous and event-driven. Many functions, therefore, have parameters for callback functions. To give you an idea what a NodeMCU program looks like study the short snippets below. For more extensive examples have a look at the /lua_examples folder in the repository on GitHub.

-- a simple HTTP server
srv = net.createServer(net.TCP)
srv:listen(80, function(conn)
	conn:on("receive", function(sck, payload)
		print(payload)
		sck:send("HTTP/1.0 200 OK\r\nContent-Type: text/html\r\n\r\n<h1> Hello, NodeMCU.</h1>")
	end)
	conn:on("sent", function(sck) sck:close() end)
end)
-- connect to WiFi access point
wifi.mode(wifi.STATION, true)

wifi.sta.on("connected", function() print("connected") end)
wifi.sta.on("got_ip", function(event, info) print("got ip "..info.ip) end)

-- mandatory to start wifi after reset
wifi.start()
wifi.sta.config({ssid="SSID", pwd="password", auto=true}, true)

Documentation

The entire NodeMCU documentation is maintained right in this repository at /docs. The fact that the API documentation is maintained in the same repository as the code that provides the API ensures consistency between the two. With every commit the documentation is rebuilt by Read the Docs and thus transformed from terse Markdown into a nicely browsable HTML site at https://nodemcu.readthedocs.io/en/dev-esp32/.

Support

See https://nodemcu.readthedocs.io/en/dev/en/support/.

License

MIT © zeroday/nodemcu.com