Go to file
Terry Ellison 68919dea65 Merge pull request #1004 from cheloftus/dev
Added crypto.fhash function for hashing files
2016-02-19 20:16:09 +00:00
.settings add spi, and some minor fix 2015-01-18 11:46:15 +08:00
app Merge pull request #1004 from cheloftus/dev 2016-02-19 20:16:09 +00:00
bin Removed old SDK-provided bin files. 2015-10-12 13:26:04 +11:00
docs Merge pull request #1004 from cheloftus/dev 2016-02-19 20:16:09 +00:00
examples consolidate telnet example 2016-01-06 23:18:42 +01:00
ld Add New Tasking I/F and rework GPIO, UART, etc to support it 2016-02-17 17:13:17 +00:00
lua_examples Remove lua modules with equivalent ones in app/modules. 2016-02-14 23:03:33 +01:00
lua_modules Remove lua modules with equivalent ones in app/modules. 2016-02-14 23:03:33 +01:00
sdk-overrides/include enable -std=gnu11 for http dir 2016-01-23 22:41:41 +01:00
tools Integrate an extra build step for PRs to build a special firmware 2015-11-16 13:22:10 +01:00
.cproject move eclipse project file to root, now eclipse can see all files 2015-01-12 21:04:43 +08:00
.gitignore Bin-patching of SDK 1.5.0 with fix for timer interval. 2016-01-10 17:57:24 +11:00
.project move eclipse project file to root, now eclipse can see all files 2015-01-12 21:04:43 +08:00
.travis.yml Bin-patching of SDK 1.5.0 with fix for timer interval. 2016-01-10 17:57:24 +11:00
CONTRIBUTING.md Move Markdown syntax hint to a more sensible place 2016-02-08 21:52:21 +01:00
LICENSE update doc 2014-11-21 00:10:01 +08:00
Makefile Added -Wimplicit to modules build. 2016-01-22 10:55:57 +11:00
README.md Fix link behind RTD badge 2016-01-17 17:22:46 +01:00
mkdocs.yml Add New Tasking I/F and rework GPIO, UART, etc to support it 2016-02-17 17:13:17 +00:00

README.md

NodeMCU 1.5.1

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

A Lua based firmware for ESP8266 WiFi SOC

NodeMCU is an eLua based firmware for the ESP8266 WiFi SOC from Espressif. The firmware is based on the Espressif NON-OS SDK 1.5.1 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
  • 35+ built-in modules
  • Firmware available with or without floating point support (integer-only uses less memory)
  • Up-to-date documentation at https://nodemcu.readthedocs.org

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(conn, payload)
		print(payload)
		conn:send("<h1> Hello, NodeMCU.</h1>")
	end)
	conn:on("sent", function(conn) conn:close() end)
end)
-- connect to WiFi access point
wifi.setmode(wifi.STATION)
wifi.sta.config("SSID", "password")

Documentation

The entire NodeMCU documentation is maintained right in this repository at /docs. The fact that the API documentation is mainted 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.org.

Support

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

License

MIT © zeroday/nodemcu.com

Build Options

The following sections explain some of the options you have if you want to build your own NodeMCU firmware.

Select Modules

Disable modules you won't be using to reduce firmware size and free up some RAM. The ESP8266 is quite limited in available RAM and running out of memory can cause a system panic.

Edit app/include/user_modules.h and comment-out the #define statement for modules you don't need. Example:

...
#define LUA_USE_MODULES_MQTT
// #define LUA_USE_MODULES_COAP
// #define LUA_USE_MODULES_U8G
...

Tag Your Build

Identify your firmware builds by editing app/include/user_version.h

#define NODE_VERSION    "NodeMCU 1.5.1+myname"
#ifndef BUILD_DATE
#define BUILD_DATE      "YYYYMMDD"
#endif

Set UART Bit Rate

The initial baud rate at boot time is 9600bps. You can change this by editing BIT_RATE_DEFAULT in app/include/user_config.h:

#define BIT_RATE_DEFAULT BIT_RATE_115200

Debugging

To enable runtime debug messages to serial console edit app/include/user_config.h

#define DEVELOP_VERSION

DEVELOP_VERSION changes the startup baud rate to 74880bps.