No Description

Marcel Stör 4609a88230 Fix font-size, it's odd and inconsistent in the theme 8 years ago
.settings df3c82391f add spi, and some minor fix 9 years ago
app d426976e60 BMP085: bmp085.init() should return 0 8 years ago
bin 3d99ea6833 Removed old SDK-provided bin files. 8 years ago
cache a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
docs 4609a88230 Fix font-size, it's odd and inconsistent in the theme 8 years ago
examples fee2cf476a Merge branch 'master' into dev 9 years ago
ld a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
lua_examples 0a7b730e23 Support DS18S20 and fix negative temp handling 8 years ago
lua_modules 0a7b730e23 Support DS18S20 and fix negative temp handling 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 a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
.project a2d1e5ff2b move eclipse project file to root, now eclipse can see all files 9 years ago
.travis.yml f9ff515de9 Integrate an extra build step for PRs to build a special firmware 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 a6c0873a28 Upgrade to SDK 1.5.0 + Espressif's Open LWIP 1.5.0. 8 years ago
README.md 9ca35b1fff transferred ucg module documentation 8 years ago
mkdocs.yml 8cbc5d6a05 Merge pull request #943 from funshine/newdocs 8 years ago

README.md

NodeMCU 1.5.0

Build Status Documentation Status

###A lua based firmware for wifi-soc esp8266

Summary

  • Easy to program wireless node and/or Access Point
  • Based on Lua 5.1.4 (without debug, os module.)
  • Event-driven programming model preferred
  • Built-in modules: node, json, file, timer, pwm, i2c, spi, onewire, net, mqtt, coap, gpio, wifi, adc, uart, bit, u8g, ucg, ws2801, ws2812, crypto, dht, rtc, sntp, bmp085, tls2561, hx711 and system api.
  • Both Integer (less memory usage) and Float version firmware provided.

Useful links

Resource Location
Developer Wiki https://github.com/nodemcu/nodemcu-firmware/wiki
API docs NodeMCU api
Home nodemcu.com
BBS Chinese BBS
Docs NodeMCU docs
Tencent QQ group 309957875
Windows flash tool nodemcu-flasher
Linux flash tool Esptool
ESPlorer GUI https://github.com/4refr0nt/ESPlorer
NodeMCU Studio GUI https://github.com/nodemcu/nodemcu-studio-csharp

Programming Examples

Because Lua is a high level language and several modules are built into the firmware, you can very easily program your ESP8266. Here are some examples!

Connect to your AP

    ip = wifi.sta.getip()
    print(ip)
    --nil
    wifi.setmode(wifi.STATION)
    wifi.sta.config("SSID", "password")
    ip = wifi.sta.getip()
    print(ip)
    --192.168.18.110

Manipulate hardware like an Arduino

    pin = 1
    gpio.mode(pin, gpio.OUTPUT)
    gpio.write(pin, gpio.HIGH)
    print(gpio.read(pin))

Write a network application in Node.js style

    -- A simple http client
    conn=net.createConnection(net.TCP, 0)
    conn:on("receive", function(conn, payload) print(payload) end)
    conn:connect(80, "115.239.210.27")
    conn:send("GET / HTTP/1.1\r\nHost: www.baidu.com\r\n"
        .. "Connection: keep-alive\r\nAccept: */*\r\n\r\n")

Or a simple HTTP server

    -- 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 MQTT broker

-- init mqtt client with keepalive timer 120sec
m = mqtt.Client("clientid", 120, "user", "password")

-- setup Last Will and Testament (optional)
-- Broker will publish a message with qos = 0, retain = 0, data = "offline"
-- to topic "/lwt" if client doesn't send keepalive packet
m:lwt("/lwt", "offline", 0, 0)

m:on("connect", function(con) print("connected") end)
m:on("offline", function(con) print("offline") end)

-- on publish message receive event
m:on("message", function(conn, topic, data)
  print(topic .. ":")
  if data ~= nil then
    print(data)
  end
end)

-- m:connect(host, port, secure, auto_reconnect, function(client) end)
-- for secure: m:connect("192.168.11.118", 1880, 1, 0)
-- for auto-reconnect: m:connect("192.168.11.118", 1880, 0, 1)
m:connect("192.168.11.118", 1880, 0, 0, function(conn) print("connected") end)

-- subscribe to topic with qos = 0
m:subscribe("/topic", 0, function(conn) print("subscribe success") end)
-- or subscribe multiple topics (topic/0, qos = 0; topic/1, qos = 1; topic2, qos = 2)
-- m:subscribe({["topic/0"]=0,["topic/1"]=1,topic2=2}, function(conn) print("subscribe success") end)
-- publish a message with data = hello, QoS = 0, retain = 0
m:publish("/topic", "hello", 0, 0, function(conn) print("sent") end)

m:close();  -- if auto-reconnect == 1, it will disable auto-reconnect and then disconnect from host.
-- you can call m:connect again

UDP client and server

-- a udp server
s=net.createServer(net.UDP)
s:on("receive", function(s, c) print(c) end)
s:listen(5683)

-- a udp client
cu=net.createConnection(net.UDP)
cu:on("receive", function(cu, c) print(c) end)
cu:connect(5683, "192.168.18.101")
cu:send("hello")

Do something shiny with an RGB LED

  function led(r, g, b)
    pwm.setduty(1, r)
    pwm.setduty(2, g)
    pwm.setduty(3, b)
  end
  pwm.setup(1, 500, 512)
  pwm.setup(2, 500, 512)
  pwm.setup(3, 500, 512)
  pwm.start(1)
  pwm.start(2)
  pwm.start(3)
  led(512, 0, 0) -- red
  led(0, 0, 512) -- blue

And blink it

  lighton=0
  tmr.alarm(1, 1000, 1, function()
    if lighton==0 then
      lighton=1
      led(512, 512, 512)
    else
      lighton=0
      led(0, 0, 0)
    end
  end)

If you want to run something when the system boots

  --init.lua will be executed
  file.open("init.lua", "w")
  file.writeline([[print("Hello, do this at the beginning.")]])
  file.close()
  node.restart()  -- this will restart the module.

Add a simple telnet server to the Lua interpreter

    -- a simple telnet server
    s=net.createServer(net.TCP, 180)
    s:listen(2323, function(c)
       function s_output(str)
          if(c~=nil)
             then c:send(str)
          end
       end
       node.output(s_output, 0)   -- re-direct output to function s_ouput.
       c:on("receive", function(c, l)
          node.input(l)           -- works like pcall(loadstring(l)) but support multiples separate lines
       end)
       c:on("disconnection", function(c)
          node.output(nil)        -- un-register the redirect output function, output goes to serial
       end)
       print("Welcome to NodeMCU world.")
    end)

Building the firmware

There are several options for building the NodeMCU firmware.

Online firmware custom build

Please try Marcel’s NodeMCU custom build cloud service and you can choose only the modules you need, and download the firmware once built.

NodeMCU custom builds can build from all active branches (with the latest fixes).

Docker containerised build

See https://hub.docker.com/r/marcelstoer/nodemcu-build/

This Docker image includes the build toolchain and SDK. You just run the Docker image with your checked-out NodeMCU firmware repository (this one).

You will need to see BUILD OPTIONS below, to configure the firmware before building.

Build it yourself

See BUILD OPTIONS below, to configure the firmware before building.

Minimum requirements:

Build instructions:

Assuming NodeMCU firmware is checked-out to /opt/nodemcu-firmware:

git clone --recursive https://github.com/pfalcon/esp-open-sdk.git /opt/esp-open-sdk
cd /opt/esp-open-sdk
make STANDALONE=y
PATH=/opt/esp-open-sdk/xtensa-lx106-elf/bin:$PATH
cd /opt/nodemcu-firmware
make

BUILD OPTIONS

Disable modules you won’t be using, to reduce firmware size on flash and free more RAM. The ESP8266 is quite limited in available RAM, and running out can cause a system panic.

Edit app/include/user_modules.h

Comment-out the #define statement for unused modules. Example:

#ifdef LUA_USE_MODULES
#define LUA_USE_MODULES_NODE
#define LUA_USE_MODULES_FILE
#define LUA_USE_MODULES_GPIO
#define LUA_USE_MODULES_WIFI
#define LUA_USE_MODULES_NET
#define LUA_USE_MODULES_PWM
#define LUA_USE_MODULES_I2C
#define LUA_USE_MODULES_SPI
#define LUA_USE_MODULES_TMR
#define LUA_USE_MODULES_ADC
#define LUA_USE_MODULES_UART
#define LUA_USE_MODULES_OW
#define LUA_USE_MODULES_BIT
#define LUA_USE_MODULES_MQTT
// #define LUA_USE_MODULES_COAP
// #define LUA_USE_MODULES_U8G
// #define LUA_USE_MODULES_WS2801
// #define LUA_USE_MODULES_WS2812
// #define LUA_USE_MODULES_CJSON
#define LUA_USE_MODULES_CRYPTO
#define LUA_USE_MODULES_RC
#define LUA_USE_MODULES_DHT
#define LUA_USE_MODULES_RTCMEM
#define LUA_USE_MODULES_RTCTIME
#define LUA_USE_MODULES_RTCFIFO
#define LUA_USE_MODULES_SNTP
// #define LUA_USE_MODULES_BMP085
#define LUA_USE_MODULES_TSL2561
// #define LUA_USE_MODULES_HX711

#endif /* LUA_USE_MODULES */

Tagging your build

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

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

Setting the boot time serial interface rate

The initial baud rate at boot time is 9600 bps, but you can change this by editing app/include/user_config.h and change BIT_RATE_DEFAULT, e.g.:

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

Flash the firmware

Flash tools for Windows

You can use the nodemcu-flasher to burn the firmware.

Flash tools for Linux

Esptool is a python utility which can read and write the flash in an ESP8266 device. See https://github.com/themadinventor/esptool

Preparing the hardware for firmware upgrade

To enable ESP8266 firmware flashing, the GPIO0 pin must be pulled low before the device is reset. Conversely, for a normal boot, GPIO0 must be pulled high or floating.

If you have a NodeMCU Development Kit then you don’t need to do anything, as the USB connection can pull GPIO0 low by asserting DTR, and reset your board by asserting RTS.

If you have an ESP-01 or other device without inbuilt USB, you will need to enable flashing yourself by pulling GPIO0 low or pressing a «flash» switch.

Files to burn to the flash

If you got your firmware from NodeMCU custom builds then you can flash that file directly to address 0x00000.

Otherwise, if you built your own firmware from source code:

  • bin/0x00000.bin to 0x00000
  • bin/0x10000.bin to 0x10000

Also, in some special circumstances, you may need to flash blank.bin or esp_init_data_default.bin to various addresses on the flash (depending on flash size and type).

If upgrading from spiffs version 0.3.2 to 0.3.3 or later, or after flashing any new firmware (particularly one with a much different size), you may need to run file.format() to re-format your flash filesystem. You will know if you need to do this because your flash files disappeared, or they exist but seem empty, or data cannot be written to new files.

Connecting to your NodeMCU device

NodeMCU serial interface uses 9600 baud at boot time. To increase the speed after booting, issue uart.setup(0,115200,8,0,1,1) (ESPlorer will do this automatically when changing the speed in the dropdown list).

If the device panics and resets at any time, errors will be written to the serial interface at 115200 bps.

User Interface tools

Esplorer

Victor Brutskiy’s ESPlorer is written in Java, is open source and runs on most platforms such as Linux, Windows, Mac OS, etc.

Features

  • Edit Lua scripts and run on the ESP8266 and save to its flash
  • Serial console log
  • Also supports original AT firmware (reading and setting WiFi modes, etc)

NodeMCU Studio

NodeMCU Studio is written in C# and supports Windows. This software is open source and can write lua files to filesystem.

OPTIONAL MODULES

####Use DS18B20 module extends your esp8266

    -- read temperature with DS18B20
    node.compile("ds18b20.lua")   --  run this only once to compile and save to "ds18b20.lc"
    t=require("ds18b20")
    t.setup(9)
    addrs=t.addrs()
    -- Total DS18B20 numbers, assume it is 2
    print(table.getn(addrs))
    -- The first DS18B20
    print(t.read(addrs[1],t.C))
    print(t.read(addrs[1],t.F))
    print(t.read(addrs[1],t.K))
    -- The second DS18B20
    print(t.read(addrs[2],t.C))
    print(t.read(addrs[2],t.F))
    print(t.read(addrs[2],t.K))
    -- Just read
    print(t.read())
    -- Just read as centigrade
    print(t.read(nil,t.C))
    -- Don't forget to release it after use
    t = nil
	ds18b20 = nil
    package.loaded["ds18b20"]=nil

####Control a WS2812 based light strip

	-- set the color of one LED on GPIO2 to red
	ws2812.writergb(4, string.char(255, 0, 0))
	-- set the color of 10 LEDs on GPIO0 to blue
	ws2812.writergb(3, string.char(0, 0, 255):rep(10))
	-- first LED green, second LED white
	ws2812.writergb(4, string.char(0, 255, 0, 255, 255, 255))

####coap client and server

-- use copper addon for firefox
cs=coap.Server()
cs:listen(5683)

myvar=1
cs:var("myvar") -- get coap://192.168.18.103:5683/v1/v/myvar will return the value of myvar: 1

all='[1,2,3]'
cs:var("all", coap.JSON) -- sets content type to json

-- function should tack one string, return one string.
function myfun(payload)
  print("myfun called")
  respond = "hello"
  return respond
end
cs:func("myfun") -- post coap://192.168.18.103:5683/v1/f/myfun will call myfun

cc = coap.Client()
cc:get(coap.CON, "coap://192.168.18.100:5683/.well-known/core")
cc:post(coap.NON, "coap://192.168.18.100:5683/", "Hello")

####cjson

-- Note that when cjson deal with large content, it may fails a memory allocation, and leaks a bit of memory.
-- so it's better to detect that and schedule a restart.
--
-- Translate Lua value to/from JSON
-- text = cjson.encode(value)
-- value = cjson.decode(text)
json_text = '[ true, { "foo": "bar" } ]'
value = cjson.decode(json_text)
-- Returns: { true, { foo = "bar" } }
value = { true, { foo = "bar" } }
json_text = cjson.encode(value)
-- Returns: '[true,{"foo":"bar"}]'

####Read an HX711 load cell ADC. Note: currently only chanel A with gain 128 is supported. The HX711 is an inexpensive 24bit ADC with programmable 128x, 64x, and 32x gain.

	-- Initialize the hx711 with clk on pin 5 and data on pin 6
	hx711.init(5,6)
	-- Read ch A with 128 gain.
	raw_data = hx711.read(0)

####Universal DHT Sensor support Support DHT11, DHT21, DHT22, DHT33, DHT44, etc. Use all-in-one function to read DHT sensor.


pin = 5
status,temp,humi,temp_decimial,humi_decimial = dht.readxx(pin)
if( status == dht.OK ) then
  -- Integer firmware using this example
  print(
    string.format(
      "DHT Temperature:%d.%03d;Humidity:%d.%03d\r\n",
      math.floor(temp),
      temp_decimial,
      math.floor(humi),
      humi_decimial
    )
  )
  -- Float firmware using this example
  print("DHT Temperature:"..temp..";".."Humidity:"..humi)
elseif( status == dht.ERROR_CHECKSUM ) then
  print( "DHT Checksum error." );
elseif( status == dht.ERROR_TIMEOUT ) then
  print( "DHT Time out." );
end