Go to file
devsaurus 80e6cc1e7e install python requirements 2018-10-07 14:06:56 +02:00
.github Update ISSUE_TEMPLATE.md 2016-05-02 21:39:05 +02:00
components Updated ESP-IDF to latest. 2018-10-07 12:33:40 +02:00
docs Merge pull request #2501 from ryanplusplus/mqtt-rometatable 2018-10-02 19:00:04 +02:00
examples consolidate telnet example 2016-01-06 23:18:42 +01:00
lua_compat Add spi master. 2017-05-14 18:00:40 +02:00
lua_examples Add u8g2 module. 2017-06-13 18:38:09 +02:00
lua_modules Add dht module. 2017-04-14 19:18:38 +02:00
sdk Updated ESP-IDF to latest. 2018-10-07 12:33:40 +02:00
tools update toolchain 2018-04-01 00:28:38 +02:00
.gitignore Add app folder (from other branches) to .gitignore 2018-03-06 23:01:06 +01:00
.gitmodules Add espmqtt library + bindings 2018-02-01 21:03:10 +11:00
.travis.yml install python requirements 2018-10-07 14:06:56 +02: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 Automatically pick up esp32 toolchain on reinvoke. 2016-11-12 11:37:48 +11:00
README.md Add ESP32 README.md and build/flash docs (#1873) 2017-03-24 23:51:13 +01:00
mkdocs.yml Use RO metatable for MQTT module; add link to docs in mkdocs.yml 2018-07-14 13:40:21 -04:00
sdkconfig.defaults Updated ESP-IDF to latest. 2018-10-07 12:33:40 +02:00

README.md

NodeMCU on ESP32

Join the chat at https://gitter.im/nodemcu/nodemcu-firmware Build Status 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