No Description

George Hahn 2b5ee453a8 Move contributing guidelines to repository 9 years ago
.settings df3c82391f add spi, and some minor fix 9 years ago
app 6e840a453f add node.compile() api 9 years ago
bin ee2e791282 serial input now accept non-ascii chars 9 years ago
examples 6e840a453f add node.compile() api 9 years ago
include bee2ed7231 Patch 20150126 for esp_iot_sdk_v0.9.5_15_01_23. 9 years ago
ld 2d711bbc0d update spiffs to 0.2.2, add file.rename api 9 years ago
lib a8c1a76d5a About #160, applied espressif patch for forever deepsleep issue. 9 years ago
lua_examples 888fbdf338 ver 0.9.5 reports error in tmr.alarm() 9 years ago
lua_modules 85727485cf Update dht22.lua 9 years ago
pre_build 6e840a453f add node.compile() api 9 years ago
tools 7f633b9168 Revert "Use python2 instead of python(2/3)" 9 years ago
.cproject a2d1e5ff2b move eclipse project file to root, now eclipse can see all files 9 years ago
.project a2d1e5ff2b move eclipse project file to root, now eclipse can see all files 9 years ago
CONTRIBUTING.md 2b5ee453a8 Move contributing guidelines to repository 9 years ago
LICENSE b249b8d5fe update doc 9 years ago
Makefile 6d3d95a271 Only set ESPTOOL if not set before 9 years ago
README.md 6e840a453f add node.compile() api 9 years ago

README.md

NodeMcu

version 0.9.5 ###A lua based firmware for wifi-soc esp8266 Build on ESP8266 sdk 0.9.5
Lua core based on eLua project
File system based on spiffs
Open source development kit for NodeMCU nodemcu-devkit
Flash tool for NodeMCU nodemcu-flasher

wiki: nodemcu wiki
api: nodemcu api
home: nodemcu.com
bbs: Chinese bbs
Tencent QQ group: 309957875

Summary

  • Easy to access wireless router
  • Based on Lua 5.1.4 (without io, math, debug, os module.)
  • Event-Drive programming preferred.
  • Build-in file, timer, pwm, i2c, spi, 1-wire, net, mqtt, gpio, wifi, adc, uart and system api.
  • GPIO pin re-mapped, use the index to access gpio, i2c, pwm.

To Do List (pull requests are very welcomed)

  • fix wifi smart connect
  • add spi module (done)
  • add mqtt module (done)
  • add coap module
  • cross compiler

Change log

2015-02-13
add node.compile() api to compile lua text file into lua bytecode file.
this will reduce memory usage noticeably when require modules into NodeMCU.
raise internal LUA_BUFFERSIZE from 1024 to 4096.
lua require(«mod») will load «mod.lc» file first if exist.
build latest pre_build bin.

2015-02-12
fix float print.
update spiffs, add file.rename api to file module.
fix some file system bug. need more tests.
add support to 8Mbyte, 16Mbyte flash.
remove node.led() and node.key() api.
some update to lua_modules and examples.
build latest pre_build bin.

2015-01-27
support floating point LUA.
use macro LUA_NUMBER_INTEGRAL in user_config.h control this feature.
LUA_NUMBER_INTEGRAL to disable floating point support,
// LUA_NUMBER_INTEGRAL to enable floating point support.
fix tmr.time(). #132
fix filesystem length. #113
fix ssl reboots. #134
build pre_build bin.

2015-01-26
applied sdk095_patch1 to sdk 0.9.5.
added LUA examples and modules by dvv.
added node.readvdd33() API by alonewolfx2.
build pre_build bin.

more change log

##GPIO NEW TABLE ( Build 20141219 and later)

<th scope="col">IO index</th><th scope="col">ESP8266 pin</th><th scope="col">IO index</th><th scope="col">ESP8266 pin</th>

<td>0 [*]</td><td>GPIO16</td><td>8</td><td>GPIO15</td>

<td>1</td><td>GPIO5</td><td>9</td><td>GPIO3</td>

<td>2</td><td>GPIO4</td><td>10</td><td>GPIO1</td>

<td>3</td><td>GPIO0</td><td>11</td><td>GPIO9</td>

<td>4</td><td>GPIO2</td><td>12</td><td>GPIO10</td>

<td>5</td><td>GPIO14</td><td></td><td></td>

<td>6</td><td>GPIO12</td><td></td><td></td>

<td>7</td><td>GPIO13</td<td></td><td></td>

[*] D0(GPIO16) can only be used as gpio read/write. no interrupt supported. no pwm/i2c/ow supported.

#Build option ####file ./app/include/user_config.h

// #define FLASH_512K
// #define FLASH_1M
// #define FLASH_2M
// #define FLASH_4M
#define FLASH_AUTOSIZE
...
#define LUA_USE_MODULES
#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_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_WS2812
#endif /* LUA_USE_MODULES */
...
// LUA_NUMBER_INTEGRAL

#Flash the firmware nodemcu_latest.bin: 0x00000
for most esp8266 modules, just pull GPIO0 down and restart.
You can use the nodemcu-flasher to burn the firmware.

Or, if you build your own bin from source code.
0x00000.bin: 0x00000
0x10000.bin: 0x10000

Better run file.format() after flash

#Connect the hardware in serial baudrate:9600

#Start play

####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 a arduino

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

####Write network application in nodejs 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 don'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)

-- for secure: m:connect("192.168.11.118", 1880, 1)
m:connect("192.168.11.118", 1880, 0, function(conn) print("connected") end)

-- subscribe topic with qos = 0
m:subscribe("/topic",0, function(conn) print("subscribe success") end)
-- or subscribe multiple topic (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();
-- 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 shining

  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 system started

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

####With below code, you can telnet to your esp8266 now

    -- 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 multiple separate line
       end) 
       c:on("disconnection",function(c) 
          node.output(nil)        -- un-regist the redirect output function, output goes to serial
       end) 
       print("Welcome to NodeMcu world.")
    end)

####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 GPIO 2 to red
	ws2812.write(4, string.char(0, 255, 0)) 
	-- set the color of 10 LEDs on GPIO 0 to blue
	ws2812.write(3, string.char(0, 0, 255):rep(10))
	-- first LED green, second LED white
	ws2812.write(4, string.char(255, 0, 0, 255, 255, 255))