Go to file
Vladimir Dronnikov 96ab811a55 yet another dht11/22 module added 2015-01-26 14:42:20 +03:00
.settings add spi, and some minor fix 2015-01-18 11:46:15 +08:00
app for reading internal vdd33 pin voltage. 2015-01-26 12:17:15 +02:00
bin serial input now accept non-ascii chars 2014-12-30 19:00:36 +08:00
examples add tcp2uart.lua example 2015-01-23 17:12:54 +08:00
include Patch 20150126 for esp_iot_sdk_v0.9.5_15_01_23. 2015-01-26 18:18:39 +08:00
ld migrate to sdk 0.9.5 release version 2015-01-24 23:36:04 +08:00
lib Patch 20150126 for esp_iot_sdk_v0.9.5_15_01_23. 2015-01-26 18:18:39 +08:00
lua_examples yet another dht11/22 module added 2015-01-26 14:42:20 +03:00
lua_modules cleanup http module 2015-01-26 14:36:39 +03:00
pre_build Update pre-build binary for 20150126 patch of SDK. 2015-01-26 18:42:32 +08:00
tools merge mqtt branch to master and build pre_build bin 2015-01-23 11:48:05 +08:00
.cproject move eclipse project file to root, now eclipse can see all files 2015-01-12 21:04:43 +08:00
.project move eclipse project file to root, now eclipse can see all files 2015-01-12 21:04:43 +08:00
LICENSE update doc 2014-11-21 00:10:01 +08:00
Makefile can set makefile COMPORT name via argument make COMPORT='COM1' flash 2015-01-26 13:25:58 +07:00
README.md update readme for api doc 2015-01-25 12:10:40 +08:00

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-01-24
migrate to sdk 0.9.5 release.
tmr.time() now return second(not precise yet).
build pre_build bin.

2015-01-23
merge mqtt branch to master.
build pre_build bin.

2015-01-18
merge mqtt module to new branch mqtt from https://github.com/tuanpmt/esp_mqtt.
merge spi module from iabdalkader:spi.
fix #110,set local port to random in client mode.
modify gpio.read to NOT set pin to input mode automatic.
add PATH env with C:\MinGW\bin;C:\MinGW\msys\1.0\bin;C:\Python27 in eclipse project. resolve #103.

2015-01-08
fix net.socket:send() issue when multi sends are called.
NOTE: if data length is bigger than 1460, send next packet AFTER "sent" callback is called.
fix file.read() api, take 0xFF as a regular byte, not EOF.
pre_build/latest/nodemcu_512k_latest.bin is removed. use pre_build/latest/nodemcu_latest.bin instead.

more change log

##GPIO NEW TABLE ( Build 20141219 and later)

IO indexESP8266 pinIO indexESP8266 pin
0 [*]GPIO168GPIO15
1GPIO59GPIO3
2GPIO410GPIO1
3GPIO011GPIO9
4GPIO212GPIO10
5GPIO14
6GPIO12
7GPIO13
#### [*] 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
#endif /* LUA_USE_MODULES */

#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")

####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)

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

####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)

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