Module iot

适配合宙的LuatOS

Functions

logger (tag) 创建日志
traceback (err) 添加异常调用栈,限xpcall用
call (func, boolean, any) 安全调用
xcall (func, boolean, any) 扩展安全调用,用于兼容布尔返回值的调用
setTimeout (func, timeout) 定时任务
setInterval (func, timeout) 循环定时任务
clearTimeout (id) 清空定时任务
clearInterval (id) 清空循环定时任务
start (func, arg1) 创建协程
stop (id) 关闭协程
sleep (timeout) 协程休眠
wait (topic, timeout) 等待消息,协程休眠
on (topic, func) 消息订阅
once (topic, func) 消息订阅(单次)
emit (topic, arg1) 发布消息
open (filename, mode) 打开文件
exists (filename) 文件是否存在
readFile (filename) 读取文件全部内容
writeFile (filename, data) 写入文件内容(覆盖)
appendFile (filename, data) 写入文件内容(追加)
mkdir (path) 创建目录
rmdir (path) 创建目录
walk (path, cb, offset) 遍历目录
md5 (data) MD5加密
hmac_md5 (data, key) HMAC MD5加密
sha1 (data) SHA1加密
hmac_sha1 (data, key) HMAC SHA1加密
sha256 (data) SHA256加密
hmac_sha256 (data, key) HMAC SHA256加密
sha512 (data) SHA512加密
hmac_sha512 (data, key) HMAC SHA512加密
encrypt (type, padding, str, key, iv) 加密
decrypt (type, padding, str, key, iv) 解密
base64_encode (data) BASE64编码
base64_decode (data) BASE64解码
crc8 (data) CRC8校验
crc16 (method, data) CRC16校验
crc32 (data) CRC32校验
json_encode (obj) JSON编码
json_decode (str) JSON解码
pack (fmt, arg1) PACK打包
unpack (str, fmt, offset) PACK解包
reboot (timeout) 重启(可以监听 REBOOT 消息, 在重启前保存数据)
socket (opts) 创建SOCKET
request (url, opts) HTTP请求
download (url, dst, opts) HTTP下载
upgrade (url) 升级文件
mqtt (opts) 创建MQTT


Functions

logger (tag)
创建日志

Parameters:

  • tag string 标签

Returns:

    table 日志器
traceback (err)
添加异常调用栈,限xpcall用

Parameters:

  • err string 错误

Returns:

    string 添加错误堆栈信息
call (func, boolean, any)
安全调用

Parameters:

  • func 函数
  • boolean 成功与否
  • any 结果 或 错误
xcall (func, boolean, any)
扩展安全调用,用于兼容布尔返回值的调用

Parameters:

  • func 函数, 第一个返回值 代表成功与否,第二个返回值 代表结果 或 错误
  • boolean 成功与否
  • any 结果 或 错误
setTimeout (func, timeout)
定时任务

Parameters:

  • func function 回调
  • timeout integer 超时

Returns:

    interger 定时器ID
setInterval (func, timeout)
循环定时任务

Parameters:

  • func function 回调
  • timeout integer 超时

Returns:

    interger 定时器ID
clearTimeout (id)
清空定时任务

Parameters:

  • id interger 定时器ID
clearInterval (id)
清空循环定时任务

Parameters:

  • id interger 定时器ID
start (func, arg1)
创建协程

Parameters:

  • func function 回调
  • arg1 ,arg2,arg3… any 参数

Returns:

    interger 任务ID
stop (id)
关闭协程

Parameters:

  • id interger 任务ID
sleep (timeout)
协程休眠

Parameters:

  • timeout integer 超时
wait (topic, timeout)
等待消息,协程休眠

Parameters:

  • topic string 消息
  • timeout integer 超时

Returns:

  1. boolean 成功与否(超时false)
  2. any 传参
on (topic, func)
消息订阅

Parameters:

  • topic string 消息
  • func function 回调
once (topic, func)
消息订阅(单次)

Parameters:

  • topic string 消息
  • func function 回调
emit (topic, arg1)
发布消息

Parameters:

  • topic string 消息
  • arg1 any 参数
open (filename, mode)
打开文件

Parameters:

  • filename string 文件名
  • mode string 模式 r w a b + …

Returns:

  1. boolean 成功与否
  2. file 文件对象,通过file:read file:write file:seek file:close操作
exists (filename)
文件是否存在

Parameters:

  • filename string 文件名

Returns:

    boolean 成功与否
readFile (filename)
读取文件全部内容

Parameters:

  • filename string 文件名

Returns:

  1. boolean 成功与否
  2. string 内容
writeFile (filename, data)
写入文件内容(覆盖)

Parameters:

  • filename string 文件名
  • data string 数据

Returns:

    boolean 成功与否
appendFile (filename, data)
写入文件内容(追加)

Parameters:

  • filename string 文件名
  • data string 数据

Returns:

    boolean 成功与否
mkdir (path)
创建目录

Parameters:

  • path string 文件名

Returns:

    boolean 成功与否
rmdir (path)
创建目录

Parameters:

  • path string 文件名

Returns:

    boolean 成功与否
walk (path, cb, offset)
遍历目录

Parameters:

  • path string 文件名
  • cb function(filename) 回调
  • offset integer 跳过
md5 (data)
MD5加密

Parameters:

  • data string 数据

Returns:

    string 加密后的十六进制串
hmac_md5 (data, key)
HMAC MD5加密

Parameters:

  • data string 数据
  • key string 秘钥

Returns:

    string 加密后的十六进制串
sha1 (data)
SHA1加密

Parameters:

  • data string 数据

Returns:

    string 加密后的十六进制串
hmac_sha1 (data, key)
HMAC SHA1加密

Parameters:

  • data string 数据
  • key string 秘钥

Returns:

    string 加密后的十六进制串
sha256 (data)
SHA256加密

Parameters:

  • data string 数据

Returns:

    string 加密后的十六进制串
hmac_sha256 (data, key)
HMAC SHA256加密

Parameters:

  • data string 数据
  • key string 秘钥

Returns:

    string 加密后的十六进制串
sha512 (data)
SHA512加密

Parameters:

  • data string 数据

Returns:

    string 加密后的十六进制串
hmac_sha512 (data, key)
HMAC SHA512加密

Parameters:

  • data string 数据
  • key string 秘钥

Returns:

    string 加密后的十六进制串
encrypt (type, padding, str, key, iv)
加密

Parameters:

  • type string 类型 AES-128-ECB,AES-192-ECB,AES-256-ECB,AES-128-CBC, AES-192-CBC,AES-256-CBC,AES-128-CTR,AES-192-CTR,AES-256-CTR,AES-128-GCM, AES-192-GCM,AES-256-GCM,AES-128-CCM,AES-192-CCM,AES-256-CCM,DES-ECB, DES-EDE-ECB,DES-EDE3-ECB,DES-CBC,DES-EDE-CBC,DES-EDE3-CBC
  • padding string 对齐 PKCS7,ZERO,ONE_AND_ZEROS,ZEROS_AND_LEN,NONE
  • str string 明文
  • key string 秘钥
  • iv string IV

Returns:

    string 密文
decrypt (type, padding, str, key, iv)
解密

Parameters:

  • type string 类型
  • padding string 对齐
  • str string 密文
  • key string 秘钥
  • iv string IV

Returns:

    string 明文
base64_encode (data)
BASE64编码

Parameters:

  • data string 数据

Returns:

    string base64编码
base64_decode (data)
BASE64解码

Parameters:

  • data string base64编码

Returns:

    string 数据
crc8 (data)
CRC8校验

Parameters:

  • data string 数据

Returns:

    integer 检验
crc16 (method, data)
CRC16校验

Parameters:

  • method string 类型 IBM MAXIM USB MODBUS CCITT CCITT-FALSE X25 XMODEM DNP USER-DEFINED
  • data string 数据

Returns:

    integer 检验
crc32 (data)
CRC32校验

Parameters:

  • data string 数据

Returns:

    integer 检验
json_encode (obj)
JSON编码

Parameters:

  • obj table 对象

Returns:

  1. string 文本
  2. string error
json_decode (str)
JSON解码

Parameters:

  • str string 文本

Returns:

  1. table 对象
  2. string error
pack (fmt, arg1)
PACK打包

Parameters:

  • fmt string 格式
  • arg1 any 参数

Returns:

    string 文本
unpack (str, fmt, offset)
PACK解包

Parameters:

  • str string 格式
  • fmt string 格式
  • offset integer 偏移

Returns:

  1. integer 下个字符
  2. any 值1-n
reboot (timeout)
重启(可以监听 REBOOT 消息, 在重启前保存数据)

Parameters:

  • timeout
socket (opts)
创建SOCKET

Parameters:

  • opts

Returns:

    Socket
request (url, opts)
HTTP请求

Parameters:

  • url string URL
  • opts table 参数 {method, headers, body}

Returns:

  1. integer status
  2. table headers
  3. string body
download (url, dst, opts)
HTTP下载

Parameters:

  • url string URL
  • dst string 目标路径
  • opts table 参数 {method, headers, body}

Returns:

  1. integer status
  2. table headers
  3. string body
upgrade (url)
升级文件

Parameters:

  • url
mqtt (opts)
创建MQTT

Parameters:

  • opts table

Returns:

    MqttClient
generated by LDoc 1.5.0 Last updated 2026-03-23 10:22:38