Ei kuvausta

Marcel Stör 5bb80df304 Remove Eclipse project files 8 vuotta sitten
app 6822116d64 Merge pull request #1136 from TerryE/dev-quick-gpio-bugfix 8 vuotta sitten
bin 3d99ea6833 Removed old SDK-provided bin files. 8 vuotta sitten
docs 6822116d64 Merge pull request #1136 from TerryE/dev-quick-gpio-bugfix 8 vuotta sitten
examples 87351a2d10 consolidate telnet example 8 vuotta sitten
ld 501bd1fb9a Adds support for verifying the certificate offered by an SSL server. 8 vuotta sitten
lua_examples ee96273191 Remove lua modules with equivalent ones in app/modules. 8 vuotta sitten
lua_modules 6fcd554e9c Delered as per #475 and creation of the encoder module 8 vuotta sitten
sdk-overrides 8743319b02 Merge pull request #1000 from devsaurus/sigma_delta 8 vuotta sitten
tools 501bd1fb9a Adds support for verifying the certificate offered by an SSL server. 8 vuotta sitten
.gitignore 5bb80df304 Remove Eclipse project files 8 vuotta sitten
.travis.yml cf2aa574b8 Bin-patching of SDK 1.5.0 with fix for timer interval. 8 vuotta sitten
CONTRIBUTING.md b3335819b8 Move Markdown syntax hint to a more sensible place 8 vuotta sitten
LICENSE b249b8d5fe update doc 9 vuotta sitten
Makefile 731264776d Fix to make GNU make 4.1 accept the Makefile after cert changes. 8 vuotta sitten
README.md bcbf49f275 Change a number of default values 8 vuotta sitten
mkdocs.yml 202cc1a12a Add meta-info block to every module doc page 8 vuotta sitten

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. 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

Debugging

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

#define DEVELOP_VERSION