Go to file
Johny Mattsson 9bbf8f43fb Successfully boot barebones NodeMCU on ESP32 (only).
RTOS driver evicted as it did not play nice with stdio etc.

Implemented a minimal driver to fully support Lua console on UART0. Output
on UART0 done via stdout (provided by the IDF). Input and setup handled
via driver_console/console.c. In addition to the direct input function
console_getc(), the driver also registers in the syscall tables to enable
regular stdio input functions to work (yay!). The Lua VM is still using the
direct interface since it's less overhead, but does also work when going
through stdin/fd 0.

Auto-bauding on the console is not yet functional; revisit when the UART docs
are available.

Module registration/linking/enabling moved over to be Kconfig based. See
updates to base_nodemcu/include/module.h and base_nodemcu/Kconfig for
details.

The sdk-overrides directory/approach is no longer used. The IDF is simply
too different to the old RTOS SDK - we need to adapt our code directly instead.

Everything in app/ is now unused, and will need to be gradually migrated
into components/ though it is probably better to migrate straight from the
latest dev branch.
2016-09-20 13:35:56 +10:00
.github Update ISSUE_TEMPLATE.md 2016-05-02 21:39:05 +02:00
app Teach Lua LTR about ESP32 drom0 location. 2016-06-24 18:17:38 +10:00
bin Removed old SDK-provided bin files. 2015-10-12 13:26:04 +11:00
components Successfully boot barebones NodeMCU on ESP32 (only). 2016-09-20 13:35:56 +10:00
docs Fixed output redirection regression (and improved it). 2016-06-02 18:29:00 +10:00
examples consolidate telnet example 2016-01-06 23:18:42 +01:00
ld Sort out mapping of virtual <-> flash addresses. 2016-06-24 15:40:48 +10:00
lua_examples update examples to task posting (#1249) 2016-04-18 13:35:07 +02:00
lua_modules Delered as per #475 and creation of the encoder module 2016-03-02 00:33:51 +00:00
sdk WIP ESP32 IDF port. 2016-09-16 18:11:42 +10:00
sdk-overrides Successfully boot barebones NodeMCU on ESP32 (only). 2016-09-20 13:35:56 +10:00
tools Updated toolchain for ESP32. 2016-09-15 13:50:00 +10:00
.gitignore WIP ESP32 IDF port. 2016-09-16 18:11:42 +10:00
.gitmodules WIP ESP32 IDF port. 2016-09-16 18:11:42 +10:00
.travis.yml WIP ESP32 IDF port. 2016-09-16 18:11:42 +10: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 Successfully boot barebones NodeMCU on ESP32 (only). 2016-09-20 13:35:56 +10:00
README.md Remove last obsolete line 2016-04-28 23:28:20 +02:00
mkdocs.yml Add meta-info block to every module doc page 2016-03-06 08:56:28 +01: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
  • 40+ 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(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.io.

Support

See https://nodemcu.readthedocs.io/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. The default configuration is designed to run on all ESP modules including the 512 KB modules like ESP-01 and only includes general purpose interface modules which require at most two GPIO pins.

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 115200bps. You can change this by editing BIT_RATE_DEFAULT in app/include/user_config.h:

#define BIT_RATE_DEFAULT BIT_RATE_115200

Note that, by default, the firmware runs an auto-baudrate detection algorithm so that typing a few characters at boot time will cause the firmware to lock onto that baud rate (between 1200 and 230400).

Debugging

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

#define DEVELOP_VERSION