Nessuna descrizione

Marcel Stör 8505362f2a Rewrite intro for README 5 anni fa
.github f562ef8fc1 Grammar and spelling fixes (#1852) 7 anni fa
app fd745e0981 Espressif SDK v2.2.1 (#2401) 5 anni fa
bin c972d86ea9 Update to sdk 2.2 6 anni fa
docs 2e202796b8 Fix LFS Markdown syntax 5 anni fa
ld 4f21224d56 LFS patch updates following review II and testing 5 anni fa
local af39a0bc25 Upgrade to latest SPIFFS and add building of file systems (#1226) 8 anni fa
lua_examples 2d2c189a66 Add checking of Lua sources to travis build (#2423) 5 anni fa
lua_modules 520b853bf4 Small typo in ftp server fails compilation 5 anni fa
sdk-overrides 96e5c026a8 Refactor timer suspend portion of node.sleep (pmsleep) (#2287) 6 anni fa
tools 2d2c189a66 Add checking of Lua sources to travis build (#2423) 5 anni fa
.gdbinit 88bd9e01d3 LFS patch updates following review 6 anni fa
.gdbinitlua 88bd9e01d3 LFS patch updates following review 6 anni fa
.gitignore 88bd9e01d3 LFS patch updates following review 6 anni fa
.travis.yml 4141e69003 Move luac.cross build into standard make hierarchy 6 anni fa
CONTRIBUTING.md f562ef8fc1 Grammar and spelling fixes (#1852) 7 anni fa
LICENSE b249b8d5fe update doc 9 anni fa
Makefile fd745e0981 Espressif SDK v2.2.1 (#2401) 5 anni fa
README.md 8505362f2a Rewrite intro for README 5 anni fa
mkdocs.yml 2e202796b8 Fix LFS Markdown syntax 5 anni fa
rtd-requirements.txt 8dc6eb62df Update comments 5 anni fa

README.md

NodeMCU 2.2.1

Build Status Documentation Status License

A Lua based firmware for ESP8266 WiFi SOC

NodeMCU is an open source Lua based firmware for the ESP8266 WiFi SOC from Espressif and uses an on-module flash-based SPIFFS file system. NodeMCU is implemented in C and is layered on the Espressif NON-OS SDK.

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.

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
  • more than 65 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.setmode(wifi.STATION)
wifi.sta.config{ssid="SSID", pwd="password"}

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.

Releases

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.

Support

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

License

MIT © zeroday/nodemcu.com