Module gizwits

模块功能:机智云物联网套件客户端功能

Info:

  • Copyright: openLuat
  • Release: 2018.07.04
  • License: MIT
  • Author: openLuat

Functions

publish (topic, payload[, qos=0][, cbFnc=nil], cbPara) 发布一条消息 手动编写并发送一条mqtt消息
transmissionSend (flag, ccmd, sn, cmd, topic) 发布一条透传消息 按照机智云带ack的格式发送一条消息
setup (PRODUCT_KEY, PRODUCT_SECRET, getDeviceName, getDeviceSecret) 初始化机智云注册所需要的数据
on (evt, cbFnc) 注册事件的处理函数


Functions

publish (topic, payload[, qos=0][, cbFnc=nil], cbPara)
发布一条消息
 手动编写并发送一条mqtt消息

Parameters:

  • topic string
    UTF8编码的主题
  • payload string
    负载
  • qos number [此参数可选,默认值为: 0]
    质量等级,0/1/2,默认0
  • cbFnc function [此参数可选,默认值为: nil]
    消息发布结果的回调函数
  • cbPara string
    标志

Returns:

  • nil

Usage:

  • publish(topic,msg,0)
  • publish(topic,msgbody,0,{cb=cbFnc,para=cbPara})
transmissionSend (flag, ccmd, sn, cmd, topic)
发布一条透传消息
 按照机智云带ack的格式发送一条消息

Parameters:

  • flag number
    通讯协议手册中的flag
  • ccmd string
    命令字,ack返回为0094
  • sn string
    包序号
  • cmd string
    业务指令
  • topic string
    UTF8编码的主题

Returns:

  • nil

Usage:

  • gizwits.transmissionSend(0,string.fromHex("0094"),string.fromHex("000000001"),"cmd","dev2app/12345/67890"))  --回复ack
setup (PRODUCT_KEY, PRODUCT_SECRET, getDeviceName, getDeviceSecret)
初始化机智云注册所需要的数据

Parameters:

  • PRODUCT_KEY string
    机智云应用列表中的Product Key
  • PRODUCT_SECRET string
    机智云应用列表中的Product Secret
  • getDeviceName function
    获取设备mac地址的函数
  • getDeviceSecret function
    获取设备passcode的函数

Returns:

  • nil

Usage:

  • gizwits.setup("PRODUCT_KEY","PRODUCT_SECRET",getDeviceName,getDeviceSecret)
on (evt, cbFnc)
注册事件的处理函数

Parameters:

  • evt string
    事件
     "connect"表示连接结果事件
     "receive"表示接收到消息事件
  • cbFnc function
    事件的处理函数
     当evt为"connect"时,cbFnc的调用形式为:cbFnc(result),result为true表示连接成功,false或者nil表示连接失败
     当evt为"receive"时,cbFnc的调用形式为:cbFnc(topic,qos,payload),topic为UTF8编码的主题(string类型),qos为质量等级(number类型),payload为原始编码的负载(string类型)
     当evt为"transmissionRev"时,cbFnc的调用形式为:cbFnc(flag,ccmd,sn,cmd,topic),flag为数值型的量,ccmd为命令字,sn为包序号,cmd为透传消息内容,topic为UTF8编码的主题(string类型)

Returns:

  • nil

Usage:

  • gizwits.on("transmissionRev",rcvTransCbFnc)
generated by LDoc 1.4.6 Last updated 2018-07-13 17:19:02