Search code, repositories, users, issues, pull requests...

net.server 子模块

listen()

描述

侦听指定ip地址的端口。

语法

net.server.listen(port,[ip],function(net.socket))

参数

port: 端口号
ip:ip地址字符串，可以省略
function(net.socket): 连接创建成功的回调函数，可以作为参数传给调用函数。

返回值

nil

示例

    -- 创建一个server
    sv=net.createServer(net.TCP, 30)  -- 30s 超时
    -- server侦听端口80，如果收到数据将数据打印至控制台，并向远端发送‘hello world’
    sv:listen(80,function(c)
      c:on("receive", function(c, pl) print(pl) end)
      c:send("hello world")
      end)

参见

close()

描述

关闭server

语法

net.server.close()

参数

nil

返回值

nil

示例

    -- 创建server
    sv=net.createServer(net.TCP, 5)
    -- 关闭server
    sv:close()

参见

net.socket 子模块

connect()

描述

连接至远端。

语法

connect(port, ip/domain)

参数

port: 端口号
ip: ip地址或者是域名字符串

返回值

nil

参见

- net.socket:on()

send()

描述

通过连接向远端发送数据。

语法

send(string, function(sent))

参数

string: 待发送的字符串
function(sent): 发送字符串后的回调函数。

返回值

nil

参见

- net.socket:on()

on()

描述

向事件注册回调函数。

语法

on(event, function cb())

参数

event: 字符串，取值为: "connection", "reconnection", "disconnection", "receive", "sent"
function cb(net.socket, [string]): 回调函数。第一个参数是socket.
如果事件是"receive", 第二个参数则为接收到的字符串。

返回值

nil

示例

    sk=net.createConnection(net.TCP, 0)
    sk:on("receive", function(sck, c) print(c) end )
    sk:connect(80,"192.168.0.66")
    sk:send("GET / HTTP/1.1\r\nHost: 192.168.0.66\r\nConnection: keep-alive\r\nAccept: */*\r\n\r\n")

参见

close()

描述

关闭socket。

语法

close()

参数

nil

返回值

nil

参见

dns()

描述

获取当前域的ip

语法

dns(domain, function(net.socket, ip))

参数

domain: 当前域的名称
function (net.socket, ip): 回调函数。第一个参数是socket，第二个参数是当前域的ip字符串。

返回值

nil

示例

    sk=net.createConnection(net.TCP, 0)
    sk:dns("www.nodemcu.com",function(conn,ip) print(ip) end)
    sk = nil

参见

i2c模块

常量

i2c.SLOW, i2c.TRANSMITTER, i2c. RECEIVER. FAST（400k）模式目前不支持。

i2c.setup()

描述

初始化i2c。

语法

i2c.setup(id, pinSDA, pinSCL, speed)

参数

id = 0
pinSDA: 112, IO编号
pinSCL: 112, IO编号
speed: i2c.SLOW

返回值

返回设置的速度

参见

i2c.start()

描述

启动i2c传输。

语法

i2c.start(id)

参数

id = 0

返回值

nil

参见

i2c.stop()

描述

停止i2c传输。

语法

i2c.stop(id)

参数

id = 0

返回值

nil

参见

i2c.address()

描述

设置i2c地址以及读写模式。

语法

i2c.address(id, device_addr, direction)

参数

id=0
device_addr: 设备地址。
direction: i2c.TRANSMITTER：写模式；i2c. RECEIVER：读模式。

返回值

true: 收到ack false：没有收到ack

参见

i2c.write()

描述

向i2c写数据。数据可以是多个数字, 字符串或者lua table。

语法

i2c.write(id, data1, data2,...)

参数

id=0
data: 数据可以是多个数字, 字符串或者lua table。

返回值

number：成功写入的字节个数

示例

    i2c.write(0, "hello", "world")

参见

i2c.read()

描述

读取len个字节的数据。

语法

i2c.read(id, len)

参数

id=0
len: 数据长度。

返回值

string:接收到的数据。

示例

    id=0
    sda=1
    scl=2

    -- 初始化i2c, 将pin1设置为sda, 将pin2设置为scl
    i2c.setup(id,sda,scl,i2c.SLOW)

    -- 用户定义函数:读取地址dev_addr的寄存器reg_addr中的内容。
    function read_reg(dev_addr, reg_addr)
      i2c.start(id)
      i2c.address(id, dev_addr ,i2c.TRANSMITTER)
      i2c.write(id,reg_addr)
      i2c.stop(id)
      i2c.start(id)
      i2c.address(id, dev_addr,i2c.RECEIVER)
      c=i2c.read(id,1)
      i2c.stop(id)
      return c
    end

    -- 读取0x77的寄存器0xAA中的内容。
    reg = read_reg(0x77, 0xAA)
    print(string.byte(reg))

参见

- i2c.write()

adc 模块

常量

无

adc.read()

描述

读取adc的值，esp8266只有一个10bit adc，id为0，引脚为TOUT，最大值1024

语法

adc.read(id)

参数

id = 0

返回值

adc 值 10bit，最大1024.

参见

-

uart 模块

常量

无

uart.setup()

描述

设置uart的波特率，字节长度，校验，停止位，是否echo。

语法

uart.setup( id, baud, databits, parity, stopbits, echo )

参数

id = 0, 只支持一个串口
baud = 300, 600, 1200, 2400, 4800, 9600, 19200, 38400, 57600, 74880, 115200, 230400, 460800, 921600, 1843200, 2686400
databits = 5, 6, 7, 8。表示字节长度。
parity = 0(none)。
stopbits = 1(1 stopbit), 2(2 stopbit).
echo = 0(关闭回显)。

返回值

返回波特率

参见

-

uart.on()

描述

设置uart的事件回调函数，目前支持"data"事件，表示uart收到了数据，以行为单位。

语法

uart.on(method, function, [run_input])

参数

method = "data", 表示uart接收到了数据
function 为回调函数，"data" 的回调函数签名为function(data) end
run_input: 0或1，0表示从uart输入的data不经过lua解释器执行，1表示输入的行会被送到lua解释器执行。

返回值

nil

示例

    uart.on("data",
      function(data)
        print("receive from uart:", data)
        if data=="quit" then 
          uart.on("data") 
        end
    end, 0)

参见

-

uart.write()

描述

向串口写入数据。

语法

uart.write( id, string1, string2... )

参数

id = 0, 只支持一个串口
string1：需要写入的字符串。

返回值

nil

参见

-

onewire 模块

常量

无

ow.setup()

描述

将pin设置为one wire模式。

语法

ow.setup(pin)

参数

pin: 1~12, IO 编号。

返回值

nil

参见

-

ow.reset()

描述

执行一次1-wire复位操作。

语法

ow.reset(pin)

参数

pin: 1~12, IO 编号

返回值

number: 如果有器件响应返回1，如果没有器件响应或者总线被拉低超过250us返回0。

参见

-

ow.skip()

描述

发送一个1-wire“忽略rom”的命令，可以用来寻址总线上的所有器件。

语法

ow.skip(pin)

参数

pin: 1~12, IO 编号

返回值

nil

参见

-

ow.select()

描述

发送一个1-Wire“选择rom”的命令，执行此函数前请务必先执行ow.reset()函数。

语法

ow.select(pin,rom)

参数

pin: 1~12, IO 编号
rom: 包含slave器件rom内容的8个字节长度的string。

返回值

nil

示例

-- 18b20 Example
pin = 9
ow.setup(pin)
count = 0
repeat
  count = count + 1
  addr = ow.reset_search(pin)
  addr = ow.search(pin)
  tmr.wdclr()
until((addr ~= nil) or (count > 100))
if (addr == nil) then
  print("No more addresses.")
else
  print(addr:byte(1,8))
  crc = ow.crc8(string.sub(addr,1,7))
  if (crc == addr:byte(8)) then
    if ((addr:byte(1) == 0x10) or (addr:byte(1) == 0x28)) then
      print("Device is a DS18S20 family device.")
        repeat
          ow.reset(pin)
          ow.select(pin, addr)
          ow.write(pin, 0x44, 1)
          tmr.delay(1000000)
          present = ow.reset(pin)
          ow.select(pin, addr)
          ow.write(pin,0xBE,1)
          print("P="..present)  
          data = nil
          data = string.char(ow.read(pin))
          for i = 1, 8 do
            data = data .. string.char(ow.read(pin))
          end
          print(data:byte(1,9))
          crc = ow.crc8(string.sub(data,1,8))
          print("CRC="..crc)
          if (crc == data:byte(9)) then
             t = (data:byte(1) + data:byte(2) * 256) * 625
             t1 = t / 10000
             t2 = t % 10000
             print("Temperature="..t1.."."..t2.."Centigrade")
          end                   
          tmr.wdclr()
        until false
    else
      print("Device family is not recognized.")
    end
  else
    print("CRC is not valid!")
  end
end

参见

-

ow.write()

描述

向选定的slave写一个字节。

语法

ow.write(pin, v, power)

参数

pin: 1~12, IO 编号
v: 向slave器件发送的字节
power: 1，用于向寄生供电器件供电；0，不需要寄生供电。注意：请务必调用ow.depower()或者发起新的读写操作来取消寄生供电。

返回值

nil

参见

-

ow.write_bytes()

描述

向选定的slave写多个字节。

语法

ow.write_bytes(pin, buf, power)

参数

pin: 1~12, IO 编号
buf: 向slave发送的多个字节的字符串
power: 1，用于向寄生供电器件供电；0，不需要寄生供电。注意：请务必调用ow.depower()或者发起新的读写操作来取消寄生供电。

返回值

nil

参见

-

ow.read()

描述

从选定的slave读取一个字节。

语法

ow.read(pin)

参数

pin: 1~12, IO 编号

返回值

从slave读取的一个字节。

参见

-

ow.read_bytes()

描述

从选定的slave读取多个字节。

语法

ow.read_bytes(pin, size)

参数

pin: 1~12, IO 编号
size: 需要从slave读取的字节的个数

返回值

从slave返回的多个字节的字符串。

参见

-

ow.depower()

描述

取消向总线供电。仅需在ow.write()或者ow.write_bytes()中的'power=1' 且不再进行读写slave的情况下使用。

语法

ow.depower(pin)

参数

pin: 1~12, IO 编号

返回值

nil

参见

-

ow.reset_search()

描述

清除查找状态用于重新开始进行查找操作。

语法

ow.reset_search(pin)

参数

pin: 1~12, IO 编号

返回值

nil

参见

-

ow.target_search()

描述

设置查找选项'family_code'，用于在下次调用ow.search()时查找该'family_code'的器件。

语法

ow.target_search(pin, family_code)

参数

pin: 1~12, IO 编号
family_code: family_code字节

返回值

nil

参见

-

ow.search()

描述

寻找下一个slave器件。

语法

ow.search(pin)

参数

pin: 1~12, IO 编号

返回值

查找成功则返回slave器件的8个字节的rom code字符串；
查找失败则返回nil

参见

-

ow.crc8()

描述

计算Dallas Semiconductor的8位CRC, 用于与ROM或者暂存器中的内容进行比较。

语法

ow.crc8(buf)

参数

buf: 需要进行crc8计算的字符串

返回值

crc结果字节

参见

-

ow.check_crc16()

描述

计算1-Wire的CRC16并与接收的CRC结果进行比较。

语法

ow.check_crc16(buf, inverted_crc0, inverted_crc1, crc)

参数

buf: 需要进行crc8计算的字符串
inverted_crc0: 接收到的CRC结果的低字节
inverted_crc1: 接收到的CRC结果的高字节
crc: crc初始值 (可选)

返回值

布尔值: true, crc结果相符; false，crc结果不相符。

参见

-

ow.crc16()

描述

计算Dallas Semiconductor的16位的CRC值。用于1-wire总线中多器件通信的数据完整性校验。请注意：这里的CRC计算结果并不一定是1-wire总线中获得的CRC，原因如下：
1) 1-wire总线传输的CRC是低位先传输的。
2) 另外由于因处理器而异的字节顺序，ow.crc16()返回结果的MSB和LSB顺序可能不同于1-wire总线中获取的MSB和LSB顺序。

语法

ow.crc16(buf, crc)

参数

buf: 需要进行crc8计算的字符串
crc: crc初始值 (可选)

返回值

返回16位的Dallas Semiconductor CRC计算结果

参见

-

bit 模块

常量

none

bit.bnot()

描述

按位取反, 相当于C语言中的'~value'。

语法

bit.bnot(value)

参数

value: 取反操作数

返回值

number: 按位取反后的结果

参见

-

bit.band()

描述

按位与, 相当于C语言中的'val1 & val2 & ... & valn'。

语法

bit.band(val1, val2, ... valn)

参数

val1: 第一个'与'操作数
val2: 第二个'与'操作数
valn: 第n个'与'操作数

返回值

number: 所有操作数按位'与'操作的结果

参见

-

bit.bor()

描述

按位或, 相当于C语言中的val1 | val2 | ... | valn。

语法

bit.bor(val1, val2, ... valn)

参数

val1: 第一个'或'操作数
val2: 第二个'或'操作数
valn: 第n个'或'操作数

返回值

number: 所有操作数按位'或'操作的结果

参见

-

bit.bxor()

描述

按位异或, 相当于C语言中的val1 ^ val2 ^ ... ^ valn。

语法

bit.bxor(val1, val2, ... valn)

参数

val1: 第一个'异或'操作数
val2: 第二个'异或'操作数
valn: 第n个'异或'操作数

返回值

number: 所有操作数按位'异或'操作的结果

参见

-

bit.lshift()

描述

按位左移一个操作数, 相当于C语言中的 value<<shift。

语法

bit.lshift(value, shift)

参数

value: 按位左移的操作数
shift: 左移的偏移量

返回值

number: 按位左移的结果

参见

-

bit.rshift()

描述

逻辑右移一个操作数, 相当于C语言中的无符号数 value>>shift。

语法

bit.rshift(value, shift)

参数

value: 按位右移的操作数
shift: 右移的偏移量

返回值

number: 按位右移的结果（按无符号数处理）

参见

-

bit.arshift()

描述

算术右移一个操作数, 相当于C语言中的 value>>shift。

语法

bit.arshift(value, shift)

参数

value: 按位右移的操作数
shift: 右移的偏移量

返回值

number: 按位右移的结果（算术右移）

参见

-

bit.bit()

描述

将某一个位设置为1，相当于C语言中的1 << position。

语法

bit.bit(position)

参数

position: 需要设置为1的位序。

返回值

number: 某位设置为1的结果 (其余位设为0)

参见

-

bit.set()

描述

将某些位设置为1。

语法

bit.set(value, pos1, pos2, ..., posn)

参数

value: 操作数
pos1: 第一个需要设置为1的位序
pos2: 第二个需要设置为1的位序
posn: 第n个需要设置为1的位序

返回值

number: 将特定位设置为1的结果

参见

-

bit.clear()

描述

将某些位设置为0。

语法

bit.clear(value, pos1, pos2, ..., posn)

参数

value: 操作数
pos1: 第一个需要设置为0的位序
pos2: 第二个需要设置为0的位序
posn: 第n个需要设置为0的位序

返回值

number: 将特定位设置为0的结果

参见

-

bit.isset()

描述

测试特定位是否为1。

语法

bit.isset(value, position)

参数

value: 需要测试的操作数
position: 需要测试的位序

返回值

boolean: 如果指定位序为1，返回true，否则返回false

参见

-

bit.isclear()

描述

测试特定位是否为0。

语法

bit.isclear(value, position)

参数

value: 需要测试的操作数
position: 需要测试的位序

返回值

boolean: 如果指定位序为0，返回true，否则返回false

参见

-

spi 模块

常量

MASTER, SLAVE, CPHA_LOW, CPHA_HIGH, CPOL_LOW, CPOL_HIGH, DATABITS_8, DATABITS_16

spi.setup()

描述

配置spi.

语法

spi.setup( id, mode, cpol, cpha, databits, clock )

参数

id: spi id号.
mode: MASTER 或者 SLAVE(目前不支持).
cpol: CPOL_LOW 或者 CPOL_HIGH, 时钟极性.
cpha: CPHA_HIGH 或者 CPHA_LOW, 时钟相位.
databits: DATABITS_8 或者 DATABITS_16.
clock: spi时钟 (目前不支持).

返回值

number: 1.

示例

参见

-

spi.send()

描述

向spi设备发送数据.

语法

wrote = spi.send( id, data1, [data2], ..., [datan] )

参数

id: spi id号.
data: data可以是字符串、Lua table或者8位数值.

返回值

number: 发送数据的字节数.

示例

参见

-

spi.recv()

描述

从spi设备接收数据.

语法

read = spi.recv( id, size )

参数

id: spi id号.
size: 需要读取数据的字节数.

返回值

string: 读取的字符串（字节形式）.

示例

参见

-

mqtt 模块

常量

mqtt.Client()

描述

创建一个mqtt client.

语法

mqtt.Client(clientid, keepalive, user, pass)

参数

clientid: mqtt客户端id.
keepalive: 保持连接的时间，单位：秒.
user: 用户名，字符串.
pass: 密码，字符串.

返回值

mqtt客户端.

示例

-- 创建一个mqtt client，保持连接包时间120s.
m = mqtt.Client("clientid", 120, "user", "password")

--设置Last Will和Testament (可选).
--如果mqtt client不发送保持连接包，服务器会向标题"/lwt"发送一个qos = 0, retain = 0, data = "offline"的消息.
m:lwt("/lwt", "offline", 0, 0)

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

-- 接收到消息事件
m:on("message", function(conn, topic, data) 
  print(topic .. ":" ) 
  if data ~= nil then
    print(data)
  end
end)

-- 如果需要安全连接，则m:connect("192.168.11.118", 1880, 1)
m:connect("192.168.11.118", 1880, 0, function(conn) print("connected") end)

-- 订阅"/topic"消息，qos = 0
m:subscribe("/topic",0, function(conn) print("subscribe success") end)

-- 向"/topic"标题发送消息，消息设置：data = hello, QoS = 0, retain = 0
m:publish("/topic","hello",0,0, function(conn) print("sent") end)

m:close();
-- 或者可以再次调用m:connect()

参见

-

mqtt client子模块

mqtt:lwt()

描述

设置Last Will和Testament (可选)
如果mqtt client不发送保持连接包，服务器会向标题"/lwt"发送一个qos = 0, retain = 0, data = "offline"的消息.

语法

mqtt:lwt(topic, message, qos, retain)

参数

topic: 需要发布消息的标题，字符串类型.
message: 需要发布的消息， Buffer或者字符串.
qos: qos值，默认值为0.
retain: 保留标志，默认值为0.

返回值

nil.

示例

参见

-

mqtt:connect()

描述

连接到mqtt服务器.

语法

mqtt:connect( host, port, secure, function(client) )

参数

host: 主机域名或者ip地址，字符串类型.
port: 服务器端口号.
secure: 0 或者 1, 默认值为0.
function(client): 连接成功的回调函数.

返回值

nil.

示例

参见

-

mqtt:close()

描述

关闭mqtt连接.

语法

mqtt:close()

参数

nil

返回值

nil.

示例

参见

-

mqtt:publish()

描述

发布一个消息.

语法

mqtt:publish( topic, payload, qos, retain, function(client) )

参数

topic: 需要发布消息的标题, 字符串类型.
message: 需要发布的消息, 字符串类型.
qos: qos值, 默认值为0.
retain: 保留标志, 默认值为0.
function(client): 发送成功的回调函数，如果接收到PUBACK回调函数解除.

返回值

nil.

示例

参见

-

mqtt:subscribe()

描述

订阅一个或者多个标题的消息.

语法

mqtt:subscribe(topic, qos, function(client, topic, message))

参数

topic: 需要订阅消息的标题.
qos: 订阅消息的qos值, 默认值为0
function(client, topic, message): 接收消息的回调函数，接收后即解除.

返回值

nil.

示例

参见

-