No Description

Marcel Stör c989e297ab Re-write README, fixes #771 and contributes to #774 8 years ago
.settings df3c82391f add spi, and some minor fix 9 years ago
app 82b19c4c37 Merge branch 'newdocs' into dev 8 years ago
bin 3d99ea6833 Removed old SDK-provided bin files. 8 years ago
docs 96a05dcd41 Fix syntax for optional parameters for a few modules 8 years ago
examples 87351a2d10 consolidate telnet example 8 years ago
ld a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
lua_examples 94402443f2 Merge pull request #910 from devsaurus/dev-gcfix 8 years ago
lua_modules 4c037bfeac Add support for Temperature Comparison register set/get functions 8 years ago
sdk-overrides a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
tools f9ff515de9 Integrate an extra build step for PRs to build a special firmware 8 years ago
.cproject a2d1e5ff2b move eclipse project file to root, now eclipse can see all files 9 years ago
.gitignore cf2aa574b8 Bin-patching of SDK 1.5.0 with fix for timer interval. 8 years ago
.project a2d1e5ff2b move eclipse project file to root, now eclipse can see all files 9 years ago
.travis.yml cf2aa574b8 Bin-patching of SDK 1.5.0 with fix for timer interval. 8 years ago
CONTRIBUTING.md 772fbc4164 Add @TerryE's comment about announcing work on a PR 8 years ago
LICENSE b249b8d5fe update doc 9 years ago
Makefile b2850c3f64 Use sha1 of file instead of size 8 years ago
README.md c989e297ab Re-write README, fixes #771 and contributes to #774 8 years ago
mkdocs.yml e86347acf3 Minor syntax fixes for the 1-wire docs 8 years ago

README.md

NodeMCU 1.5.1

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.