|
%!s(int64=6) %!d(string=hai) anos | |
---|---|---|
.github | %!s(int64=7) %!d(string=hai) anos | |
app | %!s(int64=6) %!d(string=hai) anos | |
bin | %!s(int64=6) %!d(string=hai) anos | |
docs | %!s(int64=6) %!d(string=hai) anos | |
ld | %!s(int64=6) %!d(string=hai) anos | |
local | %!s(int64=8) %!d(string=hai) anos | |
lua_examples | %!s(int64=6) %!d(string=hai) anos | |
lua_modules | %!s(int64=6) %!d(string=hai) anos | |
sdk-overrides | %!s(int64=7) %!d(string=hai) anos | |
tools | %!s(int64=6) %!d(string=hai) anos | |
.gitignore | %!s(int64=6) %!d(string=hai) anos | |
.travis.yml | %!s(int64=7) %!d(string=hai) anos | |
CONTRIBUTING.md | %!s(int64=7) %!d(string=hai) anos | |
LICENSE | %!s(int64=9) %!d(string=hai) anos | |
Makefile | %!s(int64=6) %!d(string=hai) anos | |
README.md | %!s(int64=6) %!d(string=hai) anos | |
mkdocs.yml | %!s(int64=6) %!d(string=hai) anos | |
rtd-requirements.txt | %!s(int64=6) %!d(string=hai) anos |
NodeMCU is an eLua based firmware for the ESP8266 WiFi SOC from Espressif. The firmware is based on the Espressif NON-OS SDK 2.1.0 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.
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.setmode(wifi.STATION)
wifi.sta.config{ssid="SSID", pwd="password"}
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.
Due to the ever-growing number of modules available within NodeMCU, pre-built binaries are no longer made available. Use the automated custom firmware build service to get the specific firmware configuration you need, or consult the documentation for other options to build your own firmware.
This project uses two main branches, master
and dev
. dev
is actively worked on and it’s also where PRs should be created against. master
thus can be considered «stable» even though there are no automated regression tests. The goal is to merge back to master
roughly every 2 months. Depending on the current «heat» (issues, PRs) we accept changes to dev
for 5-6 weeks and then hold back for 2-3 weeks before the next snap is completed.
A new tag is created every time dev
is merged back to master
. They are listed in the releases section here on GitHub. Tag names follow the <SDK-version>-master_yyyymmdd pattern.
See https://nodemcu.readthedocs.io/en/master/en/support/.