remove: api文档指向wiki,移除本库的

docs/api/README.md

@@ -0,0 +1,3 @@
+# LuatOS API
+
+请到 https://wiki.luatos.com/api 查阅

docs/api/c_api/freertos/README.md

@@ -1,9 +0,0 @@
----
-title: FreeRTOS集成
----
-
-# FreeRTOS集成
-
-模块 | 描述
----|----
- 

docs/api/c_api/rtt/README.md

@@ -1,11 +0,0 @@
----
-title: RT-Thread集成
----
-
-# RT-Thread集成
-
-模块 | 描述
----|----
-[luat_uart_rtt](luat_uart_rtt.md) | luat_uart_rtt
-[wlan](luat_lib_wlan.md) | wifi操作库
- 

docs/api/c_api/rtt/luat_lib_wlan.md

@@ -1,51 +0,0 @@
----
-module: wlan
-summary: wifi操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# wlan_cb
-
-```c
-static void wlan_cb(int event, struct rt_wlan_buff *buff, void *parameter)
-```
-
-注册回调
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`event`|`int`| *无*
-`buff`|`rt_wlan_buff*`| *无*
-`parameter`|`void*`| *无*
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# luat_PW_msghandler
-
-```c
-static int luat_PW_msghandler(lua_State *L, void *ptr)
-```
-
-----------------------------
------------------------------
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`L`|`lua_State*`| *无*
-`ptr`|`void*`| *无*
-
-## 返回值
-
-> `int`: *无*
-
-

docs/api/c_api/rtt/luat_uart_rtt.md

@@ -1,46 +0,0 @@
----
-module: luat_uart_rtt
----
-
---------------------------------------------------
-# uart_input_cb
-
-```c
-static rt_err_t uart_input_cb(rt_device_t dev, rt_size_t size)
-```
-
-接收数据回调
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`dev`|`rt_device_t`| *无*
-`size`|`rt_size_t`| *无*
-
-## 返回值
-
-> `rt_err_t`: *无*
-
-
---------------------------------------------------
-# uart_sent_cb
-
-```c
-static rt_err_t uart_sent_cb(rt_device_t dev, void *buffer)
-```
-
-串口发送完成事件回调
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`dev`|`rt_device_t`| *无*
-`buffer`|`void*`| *无*
-
-## 返回值
-
-> `rt_err_t`: *无*
-
-

docs/api/lua/README.md

@@ -1,32 +0,0 @@
----
-title: LuaAPI模块
----
-
-# LuaAPI模块
-
-模块 | 描述
----|----
-[adc](luat_lib_adc.md) | 数模转换
-[crypto](luat_lib_crypto.md) | 加解密和hash函数
-[ctiot](luat_lib_ctiot.md) | 中国电信CTIOT集成
-[disp](luat_lib_disp.md) | 显示屏控制
-[eink](luat_lib_eink.md) | 墨水屏操作库
-[gpio](luat_lib_gpio.md) | GPIO操作
-[http](luat_lib_http.md) | 执行http请求
-[i2c](luat_lib_i2c.md) | I2C操作
-[libcoap](luat_lib_libcoap.md) | coap数据处理
-[log](luat_lib_log.md) | 日志库
-[lpmem](luat_lib_lpmem.md) | 操作低功耗不掉电内存块
-[luat_lib_dbg](luat_lib_dbg.md) | luat_lib_dbg
-[luat_lib_fs](luat_lib_fs.md) | luat_lib_fs
-[nbiot](luat_lib_nbiot.md) | NB-IOT操作库
-[pm](luat_lib_pm.md) | 电源管理
-[pwm](luat_lib_pwm.md) | PWM模块
-[rtos](luat_lib_rtos.md) | RTOS底层操作库
-[sensor](luat_lib_sensor.md) | 传感器操作库
-[socket](luat_lib_socket.md) | socket操作库
-[spi](luat_lib_spi.md) | spi操作库
-[timer](luat_lib_timer.md) | 操作底层定时器
-[u8g2](luat_lib_u8g2.md) | u8g2图形处理库
-[uart](luat_lib_uart.md) | 串口操作库
-[wlan](luat_lib_wlan.md) | wifi操作库 

docs/api/lua/luat_lib_adc.md

@@ -1,100 +0,0 @@
----
-module: adc
-summary: 数模转换
-version: 1.0
-date: 2020.07.03
----
-
---------------------------------------------------
-# adc.open
-
-```lua
-adc.open(id)
-```
-
-打开adc通道
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 通道id,与具体设备有关,通常从0开始
-
-## 返回值
-
-> `boolean`: 打开结果
-
-## 调用示例
-
-```lua
--- 打开adc通道2,并读取
-if adc.open(2) then
-    log.info("adc", adc.read(2))
-end
-adc.close(2)
-```
-
-
---------------------------------------------------
-# adc.read
-
-```lua
-adc.read(id)
-```
-
-读取adc通道
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 通道id,与具体设备有关,通常从0开始
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 原始值
-2 |`int`| 计算后的值
-
-## 调用示例
-
-```lua
--- 打开adc通道2,并读取
-if adc.open(2) then
-    log.info("adc", adc.read(2))
-end
-adc.close(2)
-```
-
-
---------------------------------------------------
-# adc.close
-
-```lua
-adc.close(id)
-```
-
-关闭adc通道
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 通道id,与具体设备有关,通常从0开始
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 打开adc通道2,并读取
-if adc.open(2) then
-    log.info("adc", adc.read(2))
-end
-adc.close(2)
-```
-
-

docs/api/lua/luat_lib_crypto.md

@@ -1,419 +0,0 @@
----
-module: crypto
-summary: 加解密和hash函数
-version: 1.0
-date: 2020.07.03
----
-
---------------------------------------------------
-# crypto.md5
-
-```lua
-crypto.md5(str)
-```
-
-计算md5值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-
-## 返回值
-
-> `string`: 计算得出的md5值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的md5
-log.info("md5", crypto.md5("abc"))
-```
-
-
---------------------------------------------------
-# crypto.hmac_md5
-
-```lua
-crypto.hmac_md5(str, key)
-```
-
-计算hmac_md5值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-`key`|`string`| 密钥
-
-## 返回值
-
-> `string`: 计算得出的hmac_md5值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的hmac_md5
-log.info("hmac_md5", crypto.hmac_md5("abc", "1234567890"))
-```
-
-
---------------------------------------------------
-# crypto.sha1
-
-```lua
-crypto.sha1(str)
-```
-
-计算sha1值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-
-## 返回值
-
-> `string`: 计算得出的sha1值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的sha1
-log.info("sha1", crypto.sha1("abc"))
-```
-
-
---------------------------------------------------
-# crypto.hmac_sha1
-
-```lua
-crypto.hmac_sha1(str, key)
-```
-
-计算hmac_sha1值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-`key`|`string`| 密钥
-
-## 返回值
-
-> `string`: 计算得出的hmac_sha1值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的hmac_sha1
-log.info("hmac_sha1", crypto.hmac_sha1("abc", "1234567890"))
-```
-
-
---------------------------------------------------
-# crypto.sha256
-
-```lua
-crypto.sha256(str)
-```
-
-计算sha256值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-
-## 返回值
-
-> `string`: 计算得出的sha256值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的sha256
-log.info("sha256", crypto.sha256("abc"))
-```
-
-
---------------------------------------------------
-# crypto.hmac_sha256
-
-```lua
-crypto.hmac_sha256(str, key)
-```
-
-计算hmac_sha256值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-`key`|`string`| 密钥
-
-## 返回值
-
-> `string`: 计算得出的hmac_sha1值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的hmac_sha256
-log.info("hmac_sha256", crypto.hmac_sha256("abc", "1234567890"))
-```
-
-
---------------------------------------------------
-# crypto.sha512
-
-```lua
-crypto.sha512(str)
-```
-
-计算sha512值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-
-## 返回值
-
-> `string`: 计算得出的sha512值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的sha512
-log.info("sha512", crypto.sha512("abc"))
-```
-
-
---------------------------------------------------
-# crypto.hmac_sha512
-
-```lua
-crypto.hmac_sha512(str, key)
-```
-
-计算hmac_sha512值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 需要计算的字符串
-`key`|`string`| 密钥
-
-## 返回值
-
-> `string`: 计算得出的hmac_sha1值的hex字符串
-
-## 调用示例
-
-```lua
--- 计算字符串"abc"的hmac_sha512
-log.info("hmac_sha512", crypto.hmac_sha512("abc", "1234567890"))
-```
-
-
---------------------------------------------------
-# crypto.cipher
-
-```lua
-crypto.cipher(type, padding, str, key, iv)
-```
-
-对称加密
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`type`|`string`| 算法名称, 例如 AES-128-ECB/AES-128-CBC, 可查阅mbedtls的cipher_wrap.c
-`padding`|`string`| 对齐方式, 当前仅支持PKCS7
-`str`|`string`| 需要加密的数据
-`key`|`string`| 密钥,需要对应算法的密钥长度
-`iv`|`string`| IV值, 非ECB算法需要
-
-## 返回值
-
-> `string`: 加密后的字符串
-
-## 调用示例
-
-```lua
--- 计算AES
-local data = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", "1234567890123456", "1234567890123456")
-local data2 = crypto.cipher_encrypt("AES-128-CBC", "PKCS7", "1234567890123456", "1234567890123456", "1234567890666666")
-```
-
-
---------------------------------------------------
-# crypto.cipher
-
-```lua
-crypto.cipher(type, padding, str, key, iv)
-```
-
-对称解密
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`type`|`string`| 算法名称, 例如 AES-128-ECB/AES-128-CBC, 可查阅mbedtls的cipher_wrap.c
-`padding`|`string`| 对齐方式, 当前仅支持PKCS7
-`str`|`string`| 需要解密的数据
-`key`|`string`| 密钥,需要对应算法的密钥长度
-`iv`|`string`| IV值, 非ECB算法需要
-
-## 返回值
-
-> `string`: 解密后的字符串
-
-## 调用示例
-
-```lua
--- 用AES加密,然后用AES解密
--- data的hex为 757CCD0CDC5C90EADBEEECF638DD0000
--- data2的值为 1234567890123456
-local data = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", "1234567890123456", "1234567890123456")
-local data2 = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", data, "1234567890123456")
--------------------------
--- 用AES加密,然后用AES解密
--- data的hex为 757CCD0CDC5C90EADBEEECF638DD0000
--- data2的值为 1234567890123456
-local data = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", "1234567890123456", "1234567890123456")
-local data2 = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", data, "1234567890123456")
--------------------------
--- 用AES加密,然后用AES解密
--- data的hex为 757CCD0CDC5C90EADBEEECF638DD0000
--- data2的值为 1234567890123456
-local data = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", "1234567890123456", "1234567890123456")
-local data2 = crypto.cipher_encrypt("AES-128-ECB", "PKCS7", data, "1234567890123456")
-```
-
-
---------------------------------------------------
-# crypto.crc16
-
-```lua
-crypto.crc16(method, data, poly, initial, finally, inReversem outReverse, ?)
-```
-
-计算CRC16
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`method`|`string`| 输入模式
-`data`|`string`| 字符串
-`poly`|`int`| poly值
-`initial`|`int`| initial值
-`finally`|`int`| finally值
-`inReversem outReverse`|`int`| 输入反转,1反转,默认0不反转
-`?`|`int`| 输入反转,1反转,默认0不反转
-
-## 返回值
-
-> `int`: 对应的CRC16值
-
-## 调用示例
-
-```lua
--- 计算CRC16
-local crc = crypto.crc16("")
-```
-
-
---------------------------------------------------
-# crypto.crc16_modbus
-
-```lua
-crypto.crc16_modbus(data)
-```
-
-直接计算modbus的crc16值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`data`|`string`| 数据
-
-## 返回值
-
-> `int`: 对应的CRC16值
-
-## 调用示例
-
-```lua
--- 计算CRC16 modbus
-local crc = crypto.crc16_modbus(data)
-```
-
-
---------------------------------------------------
-# crypto.crc32
-
-```lua
-crypto.crc32(data)
-```
-
-计算crc32值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`data`|`string`| 数据
-
-## 返回值
-
-> `int`: 对应的CRC32值
-
-## 调用示例
-
-```lua
--- 计算CRC32
-local crc = crypto.crc32(data)
-```
-
-
---------------------------------------------------
-# crypto.crc8
-
-```lua
-crypto.crc8(data)
-```
-
-计算crc8值
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`data`|`string`| 数据
-
-## 返回值
-
-> `int`: 对应的CRC8值
-
-## 调用示例
-
-```lua
--- 计算CRC8
-local crc = crypto.crc8(data)
-```
-
-

docs/api/lua/luat_lib_ctiot.md

@@ -1,168 +0,0 @@
----
-module: ctiot
-summary: 中国电信CTIOT集成
-version: 1.0
-date: 2020.08.30
----
-
---------------------------------------------------
-# ctiot.init
-
-```lua
-ctiot.init()
-```
-
-初始化ctiot，在复位开机后使用一次
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# ctiot.param
-
-```lua
-ctiot.param(ip, port, lifetime)
-```
-
-设置和读取ctiot相关参数，有参数输入则设置，无论是否有参数输入，均输出当前参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`ip`|`string`| 服务器ip
-`port`|`int`| 服务器端口
-`lifetime`|`int`| 生命周期,单位秒
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`string`| 服务器ip
-2 |`int`| 服务器端口
-3 |`int`| 生命周期,单位秒
-
-
---------------------------------------------------
-# ctiot.ep
-
-```lua
-ctiot.ep(val)
-```
-
-设置和读取自定义EP
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`string`| 自定义EP的值,默认是imei,读取的话不要填这个参数
-
-## 返回值
-
-> `string`: 当前EP值
-
-
---------------------------------------------------
-# ctiot.connect
-
-```lua
-ctiot.connect()
-```
-
-连接CTIOT，必须在设置完参数和模式后再使用
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 成功返回true,否则返回false
-
-
---------------------------------------------------
-# ctiot.disconnect
-
-```lua
-ctiot.disconnect()
-```
-
-断开ctiot
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# ctiot.write
-
-```lua
-ctiot.write(data, mode, seq)
-```
-
-发送数据给ctiot
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`data`|`string`| 需要发送的数据
-`mode`|`int`| 模式, ctiot.CON/NON/NON_REL/CON_REL
-`seq`|`int`| 序号
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`boolean`| 成功返回true,否则返回false
-2 |`string`| 成功为nil,失败返回错误描述
-
-
---------------------------------------------------
-# ctiot.isReady
-
-```lua
-ctiot.isReady()
-```
-
-是否已经就绪
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 已经就绪返回0,否则返回错误代码
-
-
---------------------------------------------------
-# ctiot.update
-
-```lua
-ctiot.update()
-```
-
-发送更新注册信息给ctiot
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 发送成功等待结果返回true,否则返回false
-
-

docs/api/lua/luat_lib_dbg.md

@@ -1,42 +0,0 @@
----
-module: luat_lib_dbg
----
-
---------------------------------------------------
-# dbg.wait
-
-```lua
-dbg.wait(timeout)
-```
-
-等待调试器进入
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`timeout`|`int`| 超时秒数,默认120,即120秒
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# dbg.stop
-
-```lua
-dbg.stop()
-```
-
-结束调试,一般不需要调用
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-

docs/api/lua/luat_lib_disp.md

@@ -1,142 +0,0 @@
----
-module: disp
-summary: 显示屏控制
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# disp.init
-
-```lua
-disp.init(conf)
-```
-
-显示屏初始化
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`conf`|`table`| 配置信息
-
-## 返回值
-
-> `int`: 正常初始化1,已经初始化过2,内存不够3,初始化失败返回4
-
-## 调用示例
-
-```lua
--- 初始化i2c1的ssd1306
-if disp.init({mode="i2c_sw", pin0=17, pin1=18}) == 1 then
-    log.info("disp", "disp init complete")
-end
-```
-
-
---------------------------------------------------
-# disp.close
-
-```lua
-disp.close()
-```
-
-关闭显示屏
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭disp,再次使用disp相关API的话,需要重新初始化
-disp.close()
-```
-
-
---------------------------------------------------
-# disp.update
-
-```lua
-disp.update()
-```
-
-把显示数据更新到屏幕
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 把显示数据更新到屏幕
-disp.update()
-```
-
-
---------------------------------------------------
-# disp.drawStr
-
-```lua
-disp.drawStr(content, x, y)
-```
-
-在显示屏上画一段文字,要调用disp.update才会更新到屏幕
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`content`|`string`| 文件内容
-`x`|`int`| 横坐标
-`y`|`int`| 竖坐标
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-disp.drawStr("wifi is ready", 10, 20)
-```
-
-
---------------------------------------------------
-# disp.setFont
-
-```lua
-disp.setFont(fontId)
-```
-
-设置字体
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`fontId`|`int`| 字体id, 默认0,纯英文8x8字节. 如果支持中文支持, 那么1代表12x12的中文字体.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 设置为中文字体,对之后的drawStr有效
-disp.setFont(1)
-```
-
-

docs/api/lua/luat_lib_eink.md

@@ -1,342 +0,0 @@
----
-module: eink
-summary: 墨水屏操作库
-version: 1.0
-date: 2020.11.14
----
-
---------------------------------------------------
-# eink.setup
-
-```lua
-eink.setup(full, spiid)
-```
-
-初始化eink
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`full`|`int`| 全屏刷新1,局部刷新0,默认是全屏刷新
-`spiid`|`int`| 所在的spi,默认是0
-
-## 返回值
-
-> `boolean`: 成功返回true,否则返回false
-
-
---------------------------------------------------
-# eink.clear
-
-```lua
-eink.clear()
-```
-
-清除绘图缓冲区
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.setWin
-
-```lua
-eink.setWin(width, height, rotate)
-```
-
-设置窗口
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`width`|`int`| width  宽度
-`height`|`int`| height 高度
-`rotate`|`int`| rotate 显示方向,0/1/2/3, 相当于旋转0度/90度/180度/270度
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.getWin
-
-```lua
-eink.getWin()
-```
-
-获取窗口信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| width  宽
-2 |`int`| height 高
-3 |`int`| rotate 旋转方向
-
-
---------------------------------------------------
-# eink.print
-
-```lua
-eink.print(x, y, str, colored, font)
-```
-
-绘制字符串(仅ASCII)
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x坐标
-`y`|`int`| y坐标
-`str`|`string`| 字符串
-`colored`|`int`| 默认是0
-`font`|`font`| 字体大小,默认12
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.printcn
-
-```lua
-eink.printcn(x, y, str, colored, font)
-```
-
-绘制字符串,支持中文
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x坐标
-`y`|`int`| y坐标
-`str`|`string`| 字符串
-`colored`|`int`| 默认是0
-`font`|`font`| 字体大小,默认12
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.show
-
-```lua
-eink.show(x, y)
-```
-
-将缓冲区图像输出到屏幕
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x 输出的x坐标,默认0
-`y`|`int`| y 输出的y坐标,默认0
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.line
-
-```lua
-eink.line(x, y, x2, y2, colored)
-```
-
-缓冲区绘制线
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 起点x坐标
-`y`|`int`| 起点y坐标
-`x2`|`int`| 终点x坐标
-`y2`|`int`| 终点y坐标
-`colored`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-eink.line(0, 0, 10, 20, 0)
-```
-
-
---------------------------------------------------
-# eink.rect
-
-```lua
-eink.rect(x, y, x2, y2, colored, fill)
-```
-
-缓冲区绘制矩形
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 左上顶点x坐标
-`y`|`int`| 左上顶点y坐标
-`x2`|`int`| 右下顶点x坐标
-`y2`|`int`| 右下顶点y坐标
-`colored`|`int`| 默认是0
-`fill`|`int`| 是否填充,默认是0,不填充
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-eink.rect(0, 0, 10, 20)
-eink.rect(0, 0, 10, 20, 1) -- Filled
-```
-
-
---------------------------------------------------
-# eink.circle
-
-```lua
-eink.circle(x, y, radius, colored, fill)
-```
-
-缓冲区绘制圆形
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 圆心x坐标
-`y`|`int`| 圆心y坐标
-`radius`|`int`| 半径
-`colored`|`int`| 默认是0
-`fill`|`int`| 是否填充,默认是0,不填充
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-eink.circle(0, 0, 10)
-eink.circle(0, 0, 10, 1, 1) -- Filled
-```
-
-
---------------------------------------------------
-# eink.qrcode
-
-```lua
-eink.qrcode(x, y, str, version)
-```
-
-缓冲区绘制QRCode
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x坐标
-`y`|`int`| y坐标
-`str`|`string`| 二维码的内容
-`version`|`int`| 二维码版本号
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.bat
-
-```lua
-eink.bat(x, y, bat)
-```
-
-缓冲区绘制电池
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x坐标
-`y`|`int`| y坐标
-`bat`|`int`| 电池电压,单位毫伏
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.weather_icon
-
-```lua
-eink.weather_icon(x, y, code)
-```
-
-缓冲区绘制天气图标
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| x坐标
-`y`|`int`| y坐标
-`code`|`int`| 天气代号
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# eink.model
-
-```lua
-eink.model(m)
-```
-
-设置墨水屏驱动型号
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`m`|`int`| 型号名称, 例如 eink.model(eink.MODEL_1in54_V2)
-
-## 返回值
-
-> *无返回值*
-
-

docs/api/lua/luat_lib_fs.md

@@ -1,64 +0,0 @@
----
-module: luat_lib_fs
----
-
---------------------------------------------------
-# fs.fsstat
-
-```lua
-fs.fsstat(path)
-```
-
-获取文件系统信息
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`path`|`string`| 路径,默认"/",可选
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`boolean`| 获取成功返回true,否则返回false
-2 |`int`| 总的block数量
-3 |`int`| 已使用的block数量
-4 |`int`| block的大小,单位字节
-5 |`string`| 文件系统类型,例如lfs代表littlefs
-
-## 调用示例
-
-```lua
--- 打印根分区的信息
-log.info("fsstat", fs.fsstat("/"))
-```
-
-
---------------------------------------------------
-# fs.fsize
-
-```lua
-fs.fsize(path)
-```
-
-获取文件大小
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`path`|`string`| 文件路径
-
-## 返回值
-
-> `int`: 文件大小,若获取失败会返回0
-
-## 调用示例
-
-```lua
--- 打印main.luac的大小
-log.info("fsize", fs.fsize("/main.luac"))
-```
-
-

docs/api/lua/luat_lib_gpio.md

@@ -1,152 +0,0 @@
----
-module: gpio
-summary: GPIO操作
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# gpio.setup
-
-```lua
-gpio.setup(pin, mode, pull, ?)
-```
-
-设置管脚功能
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| pin 针脚编号,必须是数值
-`mode`|`any`| mode 输入输出模式. 数字0/1代表输出模式,nil代表输入模式,function代表中断模式
-`pull`|`int`| pull 上拉下列模式, 可以是gpio.PULLUP 或 gpio.PULLDOWN, 需要根据实际硬件选用
-`?`|`int`| irq 中断触发模式, 上升沿gpio.RISING, 下降沿gpio.FALLING, 上升和下降都要gpio.BOTH.默认是RISING
-
-## 返回值
-
-> `any`: 输出模式返回设置电平的闭包, 输入模式和中断模式返回获取电平的闭包
-
-## 调用示例
-
-```lua
--- 设置gpio17为输入
-gpio.setup(17, nil) 
--------------------------
--- 设置gpio17为输出
-gpio.setup(17, 0) 
--------------------------
--- 设置gpio27为中断
-gpio.setup(27, function(val) print("IRQ_27") end, gpio.RISING)
-```
-
-
---------------------------------------------------
-# gpio.set
-
-```lua
-gpio.set(pin, value)
-```
-
-设置管脚电平
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| pin 针脚编号,必须是数值
-`value`|`int`| value 电平, 可以是 高电平gpio.HIGH, 低电平gpio.LOW, 或者直接写数值1或0
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 设置gpio17为低电平
-gpio.set(17, 0) 
-```
-
-
---------------------------------------------------
-# gpio.get
-
-```lua
-gpio.get(pin)
-```
-
-获取管脚电平
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| pin 针脚编号,必须是数值
-
-## 返回值
-
-> `value`: 电平, 高电平gpio.HIGH, 低电平gpio.LOW, 对应数值1和0
-
-## 调用示例
-
-```lua
--- 获取gpio17的当前电平
-gpio.get(17) 
-```
-
-
---------------------------------------------------
-# gpio.close
-
-```lua
-gpio.close(pin)
-```
-
-关闭管脚功能(高阻输入态),关掉中断
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| pin 针脚编号,必须是数值
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭gpio17
-gpio.close(17)
-```
-
-
---------------------------------------------------
-# gpio.setDefaultPull
-
-```lua
-gpio.setDefaultPull(val)
-```
-
-设置GPIO脚的默认上拉/下拉设置, 默认是平台自定义(一般为开漏).
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`int`| val 0平台自定义,1上拉, 2下拉
-
-## 返回值
-
-> `boolean`: 传值正确返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 设置gpio.setup的pull默认值为上拉
-gpio.setDefaultPull(1)
-```
-
-

docs/api/lua/luat_lib_http.md

@@ -1,162 +0,0 @@
----
-module: http
-summary: 执行http请求
-version: 1.0
-date: 2020.07.07
----
-
---------------------------------------------------
-# http.req
-
-```lua
-http.req(url, params, cb)
-```
-
-发起一个http请求,推荐用http.get/post/put/delete方法
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`url`|`string`| 目标URL,需要是https://或者http://开头,否则将当成http://开头
-`params`|`table`| 可选参数. method方法,headers请求头,body数据,ca证书路径,timeout超时时长,
-`cb`|`function`| 回调方法
-
-## 返回值
-
-> `boolean`: 成功启动返回true,否则返回false.启动成功后,cb回调必然会调用一次
-
-## 调用示例
-
-```lua
--- GET请求
-http.req("http://www.baidu.com/", nil, function(ret, code, headers, body)
-    log.info("http", ret, code, header, body)
-end) 
-```
-
-
---------------------------------------------------
-# http.get
-
-```lua
-http.get(url, params, cb)
-```
-
-发起一个http get请求
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`url`|`string`| 目标URL,需要是https://或者http://开头,否则将当成http://开头
-`params`|`table`| 可选参数. headers请求头,body数据,ca证书路径,timeout超时时长,
-`cb`|`function`| 回调方法
-
-## 返回值
-
-> `boolean`: 成功启动返回true,否则返回false.启动成功后,cb回调必然会调用一次
-
-## 调用示例
-
-```lua
--- GET请求
-http.get("http://www.baidu.com/", nil, function(ret, code, headers, body)
-    log.info("http", ret, code, header, body)
-end) 
-```
-
-
---------------------------------------------------
-# http.post
-
-```lua
-http.post(url, params, cb)
-```
-
-发起一个http post请求
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`url`|`string`| 目标URL,需要是https://或者http://开头,否则将当成http://开头
-`params`|`table`| 可选参数. headers请求头,body数据,ca证书路径,timeout超时时长,
-`cb`|`function`| 回调方法
-
-## 返回值
-
-> `boolean`: 成功启动返回true,否则返回false.启动成功后,cb回调必然会调用一次
-
-## 调用示例
-
-```lua
--- POST请求
-http.post("http://www.baidu.com/", {body=json.encode(data)}, function(ret, code, headers, body)
-    log.info("http", ret, code, header, body)
-end) 
-```
-
-
---------------------------------------------------
-# http.put
-
-```lua
-http.put(url, params, cb)
-```
-
-发起一个http put请求
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`url`|`string`| 目标URL,需要是https://或者http://开头,否则将当成http://开头
-`params`|`table`| 可选参数. headers请求头,body数据,ca证书路径,timeout超时时长,
-`cb`|`function`| 回调方法
-
-## 返回值
-
-> `boolean`: 成功启动返回true,否则返回false.启动成功后,cb回调必然会调用一次
-
-## 调用示例
-
-```lua
--- PUT请求
-http.put("http://www.baidu.com/", {body=json.encode(data)}, function(ret, code, headers, body)
-    log.info("http", ret, code, header, body)
-end) 
-```
-
-
---------------------------------------------------
-# http.delete
-
-```lua
-http.delete(url, params, cb)
-```
-
-发起一个http delete请求
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`url`|`string`| 目标URL,需要是https://或者http://开头,否则将当成http://开头
-`params`|`table`| 可选参数. headers请求头,body数据,ca证书路径,timeout超时时长,
-`cb`|`function`| 回调方法
-
-## 返回值
-
-> `boolean`: 成功启动返回true,否则返回false.启动成功后,cb回调必然会调用一次
-
-## 调用示例
-
-```lua
--- DELETE请求
-http.put("http://www.baidu.com/", nil, function(ret, code, headers, body)
-    log.info("http", ret, code, header, body)
-end) 
-```
-
-

docs/api/lua/luat_lib_i2c.md

@@ -1,284 +0,0 @@
----
-module: i2c
-summary: I2C操作
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# i2c.exist
-
-```lua
-i2c.exist(id)
-```
-
-i2c编号是否存在
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-
-## 返回值
-
-> `int`: 存在就返回1,否则返回0
-
-## 调用示例
-
-```lua
--- 检查i2c1是否存在
-if i2c.exist(1) then
-    log.info("存在 i2c1")
-end
-```
-
-
---------------------------------------------------
-# i2c.setup
-
-```lua
-i2c.setup(id)
-```
-
-i2c初始化
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-
-## 返回值
-
-> `int`: 成功就返回1,否则返回0
-
-## 调用示例
-
-```lua
--- 初始化i2c1
-if i2c.setup(1) == 0 then
-    log.info("存在 i2c1")
-else
-    i2c.close(1) -- 关掉
-end
-```
-
-
---------------------------------------------------
-# i2c.send
-
-```lua
-i2c.send(id, addr, data)
-```
-
-i2c发送数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`addr`|`int`| I2C子设备的地址, 7位地址
-`data`|`string`| 待发送的数据
-
-## 返回值
-
-> `true/false`: 发送是否成功
-
-## 调用示例
-
-```lua
--- 往i2c1发送2个字节的数据
-i2c.send(1, 0x5C, string.char(0x0F, 0x2F))
-```
-
-
---------------------------------------------------
-# i2c.recv
-
-```lua
-i2c.recv(id, addr, len)
-```
-
-i2c接收数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`addr`|`int`| I2C子设备的地址, 7位地址
-`len`|`int`| 手机数据的长度
-
-## 返回值
-
-> `string`: 收到的数据
-
-## 调用示例
-
-```lua
--- 从i2c1读取2个字节的数据
-local data = i2c.recv(1, 0x5C, 2)
-```
-
-
---------------------------------------------------
-# i2c.writeReg
-
-```lua
-i2c.writeReg(id, addr, reg, data)
-```
-
-i2c写寄存器数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`addr`|`int`| I2C子设备的地址, 7位地址
-`reg`|`int`| 寄存器地址
-`data`|`string`| 待发送的数据
-
-## 返回值
-
-> `true/false`: 发送是否成功
-
-## 调用示例
-
-```lua
--- 从i2c1的地址为0x5C的设备的寄存器0x01写入2个字节的数据
-i2c.writeReg(1, 0x5C, 0x01, string.char(0x00, 0xF2))
-```
-
-
---------------------------------------------------
-# i2c.readReg
-
-```lua
-i2c.readReg(id, addr, reg, len)
-```
-
-i2c读寄存器数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`addr`|`int`| I2C子设备的地址, 7位地址
-`reg`|`int`| 寄存器地址
-`len`|`int`| 待接收的数据长度
-
-## 返回值
-
-> `string`: 收到的数据
-
-## 调用示例
-
-```lua
--- 从i2c1的地址为0x5C的设备的寄存器0x01读出2个字节的数据
-i2c.readReg(1, 0x5C, 0x01, 2)
-```
-
-
---------------------------------------------------
-# i2c.close
-
-```lua
-i2c.close(id)
-```
-
-关闭i2c设备
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭i2c1
-i2c.close(1)
-```
-
-
---------------------------------------------------
-# i2c.readDHT12
-
-```lua
-i2c.readDHT12(id, ?)
-```
-
-从i2c总线读取DHT12的温湿度数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`?`|`int`| DHT12的设备地址,默认0x5C
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`boolean`| 读取成功返回true,否则返回false
-2 |`int`| 湿度值,单位0.1%, 例如 591 代表 59.1%
-3 |`int`| 温度值,单位0.1摄氏度, 例如 292 代表 29.2摄氏度
-
-## 调用示例
-
-```lua
--- 从i2c0读取DHT12
-i2c.setup(0)
-local re, H, T = i2c.readDHT12(0)
-if re then
-    log.info("dht12", H, T)
-end
-```
-
-
---------------------------------------------------
-# i2c.readSHT30
-
-```lua
-i2c.readSHT30(id, addr)
-```
-
-从i2c总线读取DHT30的温湿度数据(由"好奇星"贡献)
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 设备id, 例如i2c1的id为1, i2c2的id为2
-`addr`|`int`| 设备addr,SHT30的设备地址,默认0x44 bit7
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`boolean`| 读取成功返回true,否则返回false
-2 |`int`| 湿度值,单位0.1%, 例如 591 代表 59.1%
-3 |`int`| 温度值,单位0.1摄氏度, 例如 292 代表 29.2摄氏度
-
-## 调用示例
-
-```lua
--- 从i2c0读取SHT30
-i2c.setup(0)
-local re, H, T = i2c.readSHT30(0)
-if re then
-    log.info("sht30", H, T)
-end
-```
-
-

docs/api/lua/luat_lib_lcd.md

@@ -1,367 +0,0 @@
----
-module: lcd
-summary: lcd图形处理库
-version: 1.0
-date: 2021.06.28
----
-
---------------------------------------------------
-# lcd.init
-
-```lua
-lcd.init(tp, args)
-```
-
-lcd显示屏初始化
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-tp|`string`| lcd类型, 当前支持st7789/st7735/gc9a01/gc9106l/gc9306/ili9341/custom 
-args|`table`| 附加参数,与具体设备有关 
-
-## 返回值
-
-> `int`: 正常初始化true,初始化失败返回false
-
-## 调用示例
-
-```lua
--- 初始化spi0的st7789 注意:lcd初始化之前需要先初始化spi
-lcd.init("st7789",{port = 0,pin_cs = 20,pin_dc = 23, pin_pwr = 7,pin_rst = 22,direction = 0,w = 240,h = 320})
-```
-
-
---------------------------------------------------
-# lcd.close
-
-```lua
-lcd.close()
-```
-
-关闭显示屏
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 关闭lcd
-lcd.close()
-```
-
-
---------------------------------------------------
-# lcd.on
-
-```lua
-lcd.on()
-```
-
-开启lcd显示屏背光
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 开启lcd显示屏背光
-lcd.on()
-```
-
-
---------------------------------------------------
-# lcd.off
-
-```lua
-lcd.off()
-```
-
-关闭lcd显示屏背光
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 关闭lcd显示屏背光
-lcd.off()
-```
-
-
---------------------------------------------------
-# lcd.sleep
-
-```lua
-lcd.sleep()
-```
-
-lcd睡眠
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- lcd睡眠
-lcd.sleep()
-```
-
-
---------------------------------------------------
-# lcd.wakeup
-
-```lua
-lcd.wakeup()
-```
-
-lcd唤醒
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- lcd唤醒
-lcd.wakeup()
-```
-
-
---------------------------------------------------
-# lcd.setColor
-
-```lua
-lcd.setColor(back,fore)
-```
-
-lcd颜色设置
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`back`|`int`| 背景色 
-`fore`|`int`| 前景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- lcd颜色设置
-lcd.setColor(0xFFFF,0x0000)
-```
-
-
---------------------------------------------------
-# lcd.draw
-
-```lua
-lcd.draw(x1, y1, x2, y2,color)
-```
-
-lcd颜色填充
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x1`|`int`| 左上边缘的X位置. 
-`y1`|`int`| 左上边缘的Y位置. 
-`x2`|`int`| 右上边缘的X位置. 
-`y2`|`int`| 右上边缘的Y位置. 
-`color`|`int`| 绘画颜色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- lcd颜色填充
-buff:writeInt32(0x001F)
-lcd.draw(20,30,220,30,buff)
-```
-
-
---------------------------------------------------
-# lcd.clear
-
-```lua
-lcd.clear(color)
-```
-
-lcd清屏
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`color`|`int`| 屏幕颜色 可选参数,默认背景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- lcd清屏
-lcd.clear()
-```
-
-
---------------------------------------------------
-# lcd.drawPoint
-
-```lua
-lcd.drawPoint(x0,y0,color)
-```
-
-画一个点.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 点的X位置. 
-`y0`|`int`| 点的Y位置. 
-`color`|`int`| 绘画颜色 可选参数,默认前景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 
-lcd.drawPoint(20,30,0x001F)
-```
-
-
---------------------------------------------------
-# lcd.drawLine
-
-```lua
-lcd.drawLine(x0,y0,x1,y1,color)
-```
-
-在两点之间画一条线.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 第一个点的X位置. 
-`y0`|`int`| 第一个点的Y位置. 
-`x1`|`int`| 第二个点的X位置. 
-`y1`|`int`| 第二个点的Y位置. 
-`color`|`int`| 绘画颜色 可选参数,默认前景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 
-lcd.drawLine(20,30,220,30,0x001F)
-```
-
-
---------------------------------------------------
-# lcd.drawRectangle
-
-```lua
-lcd.drawRectangle(x0,y0,x1,y1,color)
-```
-
-从x / y位置（左上边缘）开始绘制一个框
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 左上边缘的X位置. 
-`y0`|`int`| 左上边缘的Y位置. 
-`x1`|`int`| 右下边缘的X位置. 
-`y1`|`int`| 右下边缘的Y位置. 
-`color`|`int`| 绘画颜色 可选参数,默认前景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 
-lcd.drawRectangle(20,40,220,80,0x001F)
-```
-
-
---------------------------------------------------
-# lcd.drawCircle
-
-```lua
-lcd.drawCircle(x0,y0,r,color)
-```
-
-从x / y位置（圆心）开始绘制一个圆
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 圆心的X位置. 
-`y0`|`int`| 圆心的Y位置. 
- `r`     |`int`| 半径. 
-`color`|`int`| 绘画颜色 可选参数,默认前景色 
-
-## 返回值
-
-> *`int`: 正常初始化true,初始化失败返回false*
-
-## 调用示例
-
-```lua
--- 
-lcd.drawCircle(120,120,20,0x001F)
-```
-

docs/api/lua/luat_lib_libcoap.md

@@ -1,250 +0,0 @@
----
-module: libcoap
-summary: coap数据处理
-version: 1.0
-date: 2020.06.30
----
-
---------------------------------------------------
-# libcoap.new
-
-```lua
-libcoap.new(code, uri, headers, payload)
-```
-
-创建一个coap数据包
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`code`|`int`| coap的code, 例如libcoap.GET/libcoap.POST/libcoap.PUT/libcoap.DELETE
-`uri`|`string`| 目标URI,必须填写, 不需要加上/开头
-`headers`|`table`| 请求头,类似于http的headers,可选
-`payload`|`string`| 请求体,类似于http的body,可选
-
-## 返回值
-
-> `userdata`: coap数据包
-
-## 调用示例
-
-```lua
--- 创建一个请求服务器time的数据包
-local coapdata = libcoap.new(libcoap.GET, "time")
-local data = coapdata:rawdata()
-```
-
-
---------------------------------------------------
-# libcoap.parse
-
-```lua
-libcoap.parse(str)
-```
-
-解析coap数据包
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| coap数据包
-
-## 返回值
-
-> `userdata`: coap数据包,如果解析失败会返回nil
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:hcode(), coapdata:data())
-```
-
-
---------------------------------------------------
-# coapdata:msgid
-
-```lua
-coapdata:msgid()
-```
-
-获取coap数据包的msgid
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: coap数据包的msgid
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:msgid())
-```
-
-
---------------------------------------------------
-# coapdata:token
-
-```lua
-coapdata:token()
-```
-
-获取coap数据包的token
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: coap数据包的token
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:token())
-```
-
-
---------------------------------------------------
-# coapdata:rawdata
-
-```lua
-coapdata:rawdata()
-```
-
-获取coap数据包的二进制数据,用于发送到服务器
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: coap数据包的二进制数据
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.new(libcoap.GET, "time")
-netc:send(coapdata:rawdata())
-```
-
-
---------------------------------------------------
-# coapdata:code
-
-```lua
-coapdata:code()
-```
-
-获取coap数据包的code
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: coap数据包的code
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:code())
-```
-
-
---------------------------------------------------
-# coapdata:hcode
-
-```lua
-coapdata:hcode()
-```
-
-获取coap数据包的http code, 比coap原始的code要友好
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: coap数据包的http code,例如200,205,404
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:hcode())
-```
-
-
---------------------------------------------------
-# coapdata:type
-
-```lua
-coapdata:type(t)
-```
-
-获取coap数据包的type, 例如libcoap.CON/NON/ACK/RST
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`t`|`int`| 新的type值,可选
-
-## 返回值
-
-> `int`: coap数据包的type
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:type())
-```
-
-
---------------------------------------------------
-# coapdata:data
-
-```lua
-coapdata:data()
-```
-
-获取coap数据包的data
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: coap数据包的data
-
-## 调用示例
-
-```lua
--- 解析服务器传入的数据包
-local coapdata = libcoap.parse(indata)
-log.info("coapdata", coapdata:data())
-```
-
-

docs/api/lua/luat_lib_libgnss.md

@@ -1,195 +0,0 @@
----
-module: libgnss
-summary: NMEA数据处理
-version: 1.0
-date: 2020.07.03
----
-
---------------------------------------------------
-# libgnss.parse
-
-```lua
-libgnss.parse(str)
-```
-
-处理nmea数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 原始nmea数据
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", json.encode(libgnss.getRmc()))
-```
-
-
---------------------------------------------------
-# libgnss.isFix
-
-```lua
-libgnss.isFix()
-```
-
-当前是否已经定位成功
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 定位成功与否
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "isFix", libgnss.isFix())
-```
-
-
---------------------------------------------------
-# libgnss.getIntLocation
-
-```lua
-libgnss.getIntLocation()
-```
-
-获取位置信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| lat数据, 格式为 ddmmmmmmm
-2 |`int`| lng数据, 格式为 ddmmmmmmm
-3 |`int`| speed数据
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "loc", libgnss.getIntLocation())
-```
-
-
---------------------------------------------------
-# libgnss.getRmc
-
-```lua
-libgnss.getRmc()
-```
-
-获取原始RMC位置信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 原始rmc数据
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "rmc", json.encode(libgnss.getRmc()))
-```
-
-
---------------------------------------------------
-# libgnss.getGsv
-
-```lua
-libgnss.getGsv()
-```
-
-获取原始GSV信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 原始GSV数据
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "gsv", json.encode(libgnss.getGsv()))
-```
-
-
---------------------------------------------------
-# libgnss.getGsa
-
-```lua
-libgnss.getGsa()
-```
-
-获取原始GSA信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 原始GSA数据
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "gsa", json.encode(libgnss.getGsa()))
-```
-
-
---------------------------------------------------
-# libgnss.getVtg
-
-```lua
-libgnss.getVtg()
-```
-
-获取原始VTA位置信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 原始VTA数据
-
-## 调用示例
-
-```lua
--- 解析nmea
-libgnss.parse(indata)
-log.info("nmea", "vtg", json.encode(libgnss.getVtg()))
-```
-
-

docs/api/lua/luat_lib_log.md

@@ -1,183 +0,0 @@
----
-module: log
-summary: 日志库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# log.setLevel
-
-```lua
-log.setLevel(level)
-```
-
-设置日志级别
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`level`|`string`| level 日志级别,可用字符串或数值, 字符串为(SILENT,DEBUG,INFO,WARN,ERROR,FATAL), 数值为(0,1,2,3,4,5)
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 设置日志级别为INFO
-log.setLevel("INFO")
-```
-
-
---------------------------------------------------
-# log.getLevel
-
-```lua
-log.getLevel()
-```
-
-获取日志级别
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 日志级别对应0,1,2,3,4,5
-
-## 调用示例
-
-```lua
--- 得到日志级别
-log.getLevel()
-```
-
-
---------------------------------------------------
-# log.debug
-
-```lua
-log.debug(tag, val, val2, val3, ...)
-```
-
-输出日志,级别debug
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`tag`|`string`| tag         日志标识,必须是字符串
-`val`|`...`| 需打印的参数
-`val2`|`null`| *无*
-`val3`|`null`| *无*
-`...`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 日志输出 D/onenet connect ok
-log.debug("onenet", "connect ok")
-```
-
-
---------------------------------------------------
-# log.info
-
-```lua
-log.info(tag, val, val2, val3, ...)
-```
-
-输出日志,级别info
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`tag`|`string`| tag         日志标识,必须是字符串
-`val`|`...`| 需打印的参数
-`val2`|`null`| *无*
-`val3`|`null`| *无*
-`...`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 日志输出 I/onenet connect ok
-log.info("onenet", "connect ok")
-```
-
-
---------------------------------------------------
-# log.warn
-
-```lua
-log.warn(tag, val, val2, val3, ...)
-```
-
-输出日志,级别warn
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`tag`|`string`| tag         日志标识,必须是字符串
-`val`|`...`| 需打印的参数
-`val2`|`null`| *无*
-`val3`|`null`| *无*
-`...`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 日志输出 W/onenet connect ok
-log.warn("onenet", "connect ok")
-```
-
-
---------------------------------------------------
-# log.error
-
-```lua
-log.error(tag, val, val2, val3, ...)
-```
-
-输出日志,级别error
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`tag`|`string`| tag         日志标识,必须是字符串
-`val`|`...`| 需打印的参数
-`val2`|`null`| *无*
-`val3`|`null`| *无*
-`...`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 日志输出 E/onenet connect ok
-log.error("onenet", "connect ok")
-```
-
-

docs/api/lua/luat_lib_lpmem.md

@@ -1,88 +0,0 @@
----
-module: lpmem
-summary: 操作低功耗不掉电内存块
-version: V0002
-date: 2020.07.10
----
-
---------------------------------------------------
-# lpmem.read
-
-```lua
-lpmem.read(offset, size)
-```
-
-读取内存块
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`offset`|`int`| 内存偏移量
-`size`|`int`| 读取大小,单位字节
-
-## 返回值
-
-> `string`: 读取成功返回字符串,否则返回nil
-
-## 调用示例
-
-```lua
--- 读取1kb的内存
-local data = lpmem.read(0, 1024)
-```
-
-
---------------------------------------------------
-# lpmem.write
-
-```lua
-lpmem.write(offset, str)
-```
-
-写入内存块
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`offset`|`int`| 内存偏移量
-`str`|`string`| 待写入的数据
-
-## 返回值
-
-> `boolean`: 成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 往偏移量为512字节的位置, 写入数据
-lpmem.write(512, data)
-```
-
-
---------------------------------------------------
-# lpmem.size
-
-```lua
-lpmem.size()
-```
-
-获取内存块的总大小
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 内存块的大小
-
-## 调用示例
-
-```lua
--- 
-lpmem.size()
-```
-
-

docs/api/lua/luat_lib_nbiot.md

@@ -1,1007 +0,0 @@
----
-module: nbiot
-summary: NB-IOT操作库
-version: V0001
-date: 2020.04.30
----
-
---------------------------------------------------
-# nbiot.isReady
-
-```lua
-nbiot.isReady()
-```
-
-网络是否就绪
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 已联网返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 判断是否已经联网
-if nbiot.isReady() then 
-    log.info("nbiot", "net is ready")
-end
-```
-
-
---------------------------------------------------
-# nbiot.imsi
-
-```lua
-nbiot.imsi()
-```
-
-读取IMSI
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 返回IMSI值，如果不存在就返回nil
-
-## 调用示例
-
-```lua
--- 读取imsi
-log.info("nbiot", "imsi", nbiot.imsi())
-```
-
-
---------------------------------------------------
-# nbiot.iccid
-
-```lua
-nbiot.iccid()
-```
-
-读取ICCID
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 返回ICCID值，如果不存在就返回nil
-
-## 调用示例
-
-```lua
--- 读取iccid
-log.info("nbiot", "iccid", nbiot.iccid())
-```
-
-
---------------------------------------------------
-# nbiot.imei
-
-```lua
-nbiot.imei(val)
-```
-
-读取或设置IMEI
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`string`| 传入需要设置的imei值，不传就是读取
-
-## 返回值
-
-> `string`: 返回imei值，如果不存在就返回nil
-
-## 调用示例
-
-```lua
--- 读取imei
-log.info("nbiot", "imei", nbiot.imei())
--------------------------
--- 设置imei
-log.info("nbiot", "imei", nbiot.imei("898989898989899898"))
-```
-
-
---------------------------------------------------
-# nbiot.rssi
-
-```lua
-nbiot.rssi()
-```
-
-读取RSSI
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回rssi值
-
-## 调用示例
-
-```lua
--- 读取rssi
-log.info("nbiot", "rssi", nbiot.rssi())
-```
-
-
---------------------------------------------------
-# nbiot.apn
-
-```lua
-nbiot.apn()
-```
-
-读取APN
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 返回apn值
-
-## 调用示例
-
-```lua
--- 读取APN
-log.info("nbiot", "apn", nbiot.apn())
-```
-
-
---------------------------------------------------
-# nbiot.tac
-
-```lua
-nbiot.tac()
-```
-
-读取TAC
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回TAC值
-
-## 调用示例
-
-```lua
--- 读取TAC
-log.info("nbiot", "tac", nbiot.tac())
-```
-
-
---------------------------------------------------
-# nbiot.tauTime
-
-```lua
-nbiot.tauTime()
-```
-
-读取Tau Time
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回Tau Time值
-
-## 调用示例
-
-```lua
--- 读取Tau Time
-log.info("nbiot", "tau time", nbiot.tauTime())
-```
-
-
---------------------------------------------------
-# nbiot.activeTime
-
-```lua
-nbiot.activeTime()
-```
-
-读取Active Time
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回Active Time值
-
-## 调用示例
-
-```lua
--- 读取Active Time
-log.info("nbiot", "Active Time", nbiot.activeTime())
-```
-
-
---------------------------------------------------
-# nbiot.cellID
-
-```lua
-nbiot.cellID()
-```
-
-读取CellID
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回CellID值
-
-## 调用示例
-
-```lua
--- 读取CellID
-log.info("nbiot", "CellID", nbiot.cellID())
-```
-
-
---------------------------------------------------
-# nbiot.snr
-
-```lua
-nbiot.snr()
-```
-
-读取SNR
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回SNR值
-
-## 调用示例
-
-```lua
--- 读取SNR
-log.info("nbiot", "SNR", nbiot.snr())
-```
-
-
---------------------------------------------------
-# nbiot.csq
-
-```lua
-nbiot.csq()
-```
-
-读取CSQ, 并不完全等价于GSM的CSQ
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回csq值
-
-## 调用示例
-
-```lua
--- 读取csq
-log.info("nbiot", "csq", nbiot.csq())
-```
-
-
---------------------------------------------------
-# nbiot.ceLevel
-
-```lua
-nbiot.ceLevel()
-```
-
-读取CE Level
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 返回CE Level值
-
-## 调用示例
-
-```lua
--- 读取CE Level
-log.info("nbiot", "CE Level", nbiot.ceLevel())
-```
-
-
---------------------------------------------------
-# nbiot.sn
-
-```lua
-nbiot.sn(val)
-```
-
-读取或设置SN,普通刷机(刷底层/刷脚本)不会清除
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`string`| 需要设置的SN值(只能是可见字符),不传值则为读取
-
-## 返回值
-
-> `string`: 返回SN值
-
-## 调用示例
-
-```lua
--- 读取SN
-log.info("nbiot", "SN", nbiot.sn())
--------------------------
--- 设置SN
-log.info("nbiot", "SN", nbiot.sn("My Custom SN"))
-```
-
-
---------------------------------------------------
-# nbiot.updateCellInfo
-
-```lua
-nbiot.updateCellInfo()
-```
-
-刷新网络信息,可通过定时任务刷新,最小间隔5秒
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 成功启动刷新线程返回true，否则返回false.
-
-## 调用示例
-
-```lua
--- 刷新网络信息
-nbiot.updateCellInfo()
-sys.waitUntil("CELL_INFO_IND", 3000)
-log.info("nbiot", "cell", json.encode(nbiot.getCellInfo()))
-```
-
-
---------------------------------------------------
-# nbiot.mcc
-
-```lua
-nbiot.mcc()
-```
-
-读取MCC值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商MCC值
-
-## 调用示例
-
-```lua
--- 读取MCC
-log.info("nbiot", "mcc", nbiot.mcc())
-```
-
-
---------------------------------------------------
-# nbiot.mnc
-
-```lua
-nbiot.mnc()
-```
-
-读取MNC值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商MNC值
-
-## 调用示例
-
-```lua
--- 读取MNC
-log.info("nbiot", "mnc", nbiot.mnc())
-```
-
-
---------------------------------------------------
-# nbiot.earfcn
-
-```lua
-nbiot.earfcn()
-```
-
-读取earfcn值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商earfcn值
-
-## 调用示例
-
-```lua
--- 读取earfcn
-log.info("nbiot", "earfcn", nbiot.earfcn())
-```
-
-
---------------------------------------------------
-# nbiot.phyCellId
-
-```lua
-nbiot.phyCellId()
-```
-
-读取phyCellId值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商phyCellId值
-
-## 调用示例
-
-```lua
--- 读取phyCellId
-log.info("nbiot", "phyCellId", nbiot.phyCellId())
-```
-
-
---------------------------------------------------
-# nbiot.rsrq
-
-```lua
-nbiot.rsrq()
-```
-
-读取rsrq值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商ersrq值
-
-## 调用示例
-
-```lua
--- 读取rsrq
-log.info("nbiot", "rsrq", nbiot.rsrq())
-```
-
-
---------------------------------------------------
-# nbiot.rsrp
-
-```lua
-nbiot.rsrp()
-```
-
-读取rsrp值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商rsrp值
-
-## 调用示例
-
-```lua
--- 读取rsrp
-log.info("nbiot", "rsrp", nbiot.rsrp())
-```
-
-
---------------------------------------------------
-# nbiot.powerLevel
-
-```lua
-nbiot.powerLevel()
-```
-
-读取PowerLevel值,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 运营商PowerLevel值
-
-## 调用示例
-
-```lua
--- 读取PowerLevel
-log.info("nbiot", "PowerLevel", nbiot.powerLevel())
-```
-
-
---------------------------------------------------
-# nbiot.getCellInfo
-
-```lua
-nbiot.getCellInfo()
-```
-
-获取网络基站详情,注册网络后可用,通过nbiot.updateCellInfo()刷新
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 网络基站详情
-
-## 调用示例
-
-```lua
--- 读取基站信息
-log.info("nbiot", "cell info", json.encode(nbiot.getCellInfo()))
-```
-
-
---------------------------------------------------
-# nbiot.setCFUN
-
-```lua
-nbiot.setCFUN(val)
-```
-
-进入或退出飞行模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`int`| 0飞行模式,1普通联网模式
-
-## 返回值
-
-> `boolean`: 设置成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 进入飞行模式
-nbiot.setCFUN(0)
-```
-
-
---------------------------------------------------
-# nbiot.setBootCFUN
-
-```lua
-nbiot.setBootCFUN(val)
-```
-
-设置设备上电启动时，是否进入飞行模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`int`| 0飞行模式,1普通联网模式
-
-## 返回值
-
-> `boolean`: 设置成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 设置为上电进入飞行模式
-nbiot.setBootCFUN(0)
-```
-
-
---------------------------------------------------
-# nbiot.getBootCFUN
-
-```lua
-nbiot.getBootCFUN(val)
-```
-
-获取设备上电启动时，是否进入飞行模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`null`| *无*
-
-## 返回值
-
-> `int`: 开机就进入飞行模式返回0,进入普通模式返回1
-
-## 调用示例
-
-```lua
--- 获取上电模式
-nbiot.getBootCFUN()
-```
-
-
---------------------------------------------------
-# nbiot.setPSM
-
-```lua
-nbiot.setPSM(psmMode, tauTimeS, activeTimeS)
-```
-
-设置PSM参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`psmMode`|`int`| psm模式, CMI_MM_DISABLE_PSM(0)/CMI_MM_ENABLE_PSM(1)/CMI_MM_DISCARD_PSM(2)
-`tauTimeS`|`int`| TAU time(unit: S)---related to T3412
-`activeTimeS`|`int`| active time(unit: S)---related to T3324
-
-## 返回值
-
-> `boolean`: 设置成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 设置PSM
-nbiot.setPSM(1, 60, 120)
-```
-
-
---------------------------------------------------
-# nbiot.setEDRX
-
-```lua
-nbiot.setEDRX(modeVal, actType, reqEdrxValueMs)
-```
-
-设置EDRX参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`modeVal`|`int`| 模式,CMI_MM_DISABLE_EDRX = 0/CMI_MM_ENABLE_EDRX_AND_DISABLE_IND = 1/CMI_MM_ENABLE_EDRX_AND_ENABLE_IND = 2/CMI_MM_DISCARD_EDRX = 3
-`actType`|`int`| 可选值, 0或者5. CMI_MM_EDRX_NO_ACT_OR_NOT_USE_EDRX = 0/CMI_MM_EDRX_NB_IOT = 5
-`reqEdrxValueMs`|`int`| edrx值,4个字节长度二进制字符串
-
-## 返回值
-
-> `boolean`: 设置成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 设置EDRX
-nbiot.setPSM(1, 5, "0101")
-```
-
-
---------------------------------------------------
-# nbiot.getPSM
-
-```lua
-nbiot.getPSM()
-```
-
-获取PSM参数
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| psm模式, CMI_MM_DISABLE_PSM(0)/CMI_MM_ENABLE_PSM(1)/CMI_MM_DISCARD_PSM(2)
-2 |`int`| TAU time(unit: S)---related to T3412
-3 |`int`| active time(unit: S)---related to T3324
-
-## 调用示例
-
-```lua
--- 获取PSM
-log.info("psm", nbiot.getPSM())
-```
-
-
---------------------------------------------------
-# nbiot.getEDRX
-
-```lua
-nbiot.getEDRX()
-```
-
-获取EDRX参数
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 模式,CMI_MM_DISABLE_EDRX = 0/CMI_MM_ENABLE_EDRX_AND_DISABLE_IND = 1/CMI_MM_ENABLE_EDRX_AND_ENABLE_IND = 2/CMI_MM_DISCARD_EDRX = 3
-2 |`int`| 可选值, 0或者5. CMI_MM_EDRX_NO_ACT_OR_NOT_USE_EDRX = 0/CMI_MM_EDRX_NB_IOT = 5
-3 |`int`| edrx值,单位毫秒
-
-## 调用示例
-
-```lua
--- 获取EDRX
-log.info("edrx", nbiot.getEDRX())
-```
-
-
---------------------------------------------------
-# nbiot.setTZ
-
-```lua
-nbiot.setTZ(tz, auto)
-```
-
-设置时区参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`tz`|`int`| 时区参数,可选, 单位是1/4时区, 默认为 东8区, 对应的值为32
-`auto`|`boolean`| 是否自动设置时区,可选, 默认为true
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 设置为东8区,禁用自动更新时区功能
-nbiot.setTZ(32, false)
--------------------------
--- 启用自动更新时区功能
-nbiot.setTZ(nil, true)
-```
-
-
---------------------------------------------------
-# nbiot.getTZ
-
-```lua
-nbiot.getTZ()
-```
-
-获取时区参数
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 时区参数,单位1/4时区, 默认东8区, 值为32
-2 |`boolean`| 自动设置时区,默认为true
-
-## 调用示例
-
-```lua
--- 获取时区参数
-log.info("timezone", nbiot.getTZ())
-```
-
-
---------------------------------------------------
-# nbiot.setBands
-
-```lua
-nbiot.setBands(modes)
-```
-
-设置Band模式(暂不可用)
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`modes`|`any`| 模式,需要是一个table形式的数组,必须传入
-
-## 返回值
-
-> `boolean`: 设置结果
-
-## 调用示例
-
-```lua
--- 仅搜索band 8
-log.info("band", nbiot.setBands({8}))
-```
-
-
---------------------------------------------------
-# nbiot.getBands
-
-```lua
-nbiot.getBands()
-```
-
-获取当前使用的Band模式(暂不可用)
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `table`: 所设置的band的数组
-
-## 调用示例
-
-```lua
--- 仅搜索band 8
-log.info("band", json.encode(nbiot.getBands()))
-```
-
-
---------------------------------------------------
-# nbiot.setEDRXPtw
-
-```lua
-nbiot.setEDRXPtw(val)
-```
-
-设置EDRX PTW参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`val`|`int`| 需要设置的值
-
-## 返回值
-
-> `boolean`: 成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 设置PTW值为X
--- 可选值
-nbiot.setEDRXPtw(val)
-reqPtwValue:
-NB-S1 mode
-The field contains the PTW value in seconds for NB-S1 mode.The PTW value is used
-as specified in 3GPP TS 23.682 [133a].The PTW value is derived as follows:
-bit
-         Paging Time Window length
-0 0 0 0  2,56 seconds
-0 0 0 1  5,12 seconds
-0 0 1 0  7,68 seconds
-0 0 1 1  10,24 seconds
-0 1 0 0  12,8 seconds
-0 1 0 1  15,36 seconds
-0 1 1 0  17,92 seconds
-0 1 1 1  20,48 seconds
-1 0 0 0  23,04 seconds
-1 0 0 1  25,6 seconds
-1 0 1 0  28,16 seconds
-1 0 1 1  30,72 seconds
-1 1 0 0  33,28 seconds
-1 1 0 1  35,84 seconds
-1 1 1 0  38,4 seconds
-1 1 1 1  40,96 seconds
- 
--------------------------
--- 设置PTW值为X
--- 可选值
-nbiot.setEDRXPtw(val)
-reqPtwValue:
-NB-S1 mode
-The field contains the PTW value in seconds for NB-S1 mode.The PTW value is used
-as specified in 3GPP TS 23.682 [133a].The PTW value is derived as follows:
-bit
-         Paging Time Window length
-0 0 0 0  2,56 seconds
-0 0 0 1  5,12 seconds
-0 0 1 0  7,68 seconds
-0 0 1 1  10,24 seconds
-0 1 0 0  12,8 seconds
-0 1 0 1  15,36 seconds
-0 1 1 0  17,92 seconds
-0 1 1 1  20,48 seconds
-1 0 0 0  23,04 seconds
-1 0 0 1  25,6 seconds
-1 0 1 0  28,16 seconds
-1 0 1 1  30,72 seconds
-1 1 0 0  33,28 seconds
-1 1 0 1  35,84 seconds
-1 1 1 0  38,4 seconds
-1 1 1 1  40,96 seconds
- 
-```
-
-
---------------------------------------------------
-# nbiot.getEDRXPtw
-
-```lua
-nbiot.getEDRXPtw()
-```
-
-获取EDRX PTW参数
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: ptw值
-
-## 调用示例
-
-```lua
--- 打印PTW值
-log.info("ptw", nbiot.getEDRXPtw())
-```
-
-

docs/api/lua/luat_lib_pm.md

@@ -1,204 +0,0 @@
----
-module: pm
-summary: 电源管理
-version: 1.0
-date: 2020.07.02
----
-
---------------------------------------------------
-# pm.request
-
-```lua
-pm.request(mode)
-```
-
-请求进入指定的休眠模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`mode`|`int`| 休眠模式,例如pm.IDLE/LIGHT/DEEP/HIB
-
-## 返回值
-
-> `boolean`: 处理结果,即使返回成功,也不一定会进入, 也不会马上进入
-
-## 调用示例
-
-```lua
--- 请求进入休眠模式
-pm.request(pm.HIB)
-```
-
-
---------------------------------------------------
-# pm.dtimerStart
-
-```lua
-pm.dtimerStart(id, timeout)
-```
-
-启动底层定时器,在休眠模式下依然生效. 只触发一次
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 定时器id,通常是0-3
-`timeout`|`int`| 定时时长,单位毫秒
-
-## 返回值
-
-> `boolean`: 处理结果
-
-## 调用示例
-
-```lua
--- 添加底层定时器
-pm.dtimerStart(0, 300 * 1000) -- 5分钟后唤醒
-```
-
-
---------------------------------------------------
-# pm.dtimerStop
-
-```lua
-pm.dtimerStop(id)
-```
-
-关闭底层定时器
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 定时器id
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭底层定时器
-pm.dtimerStop(0) -- 关闭id=0的底层定时器
-```
-
-
---------------------------------------------------
-# pm.dtimerCheck
-
-```lua
-pm.dtimerCheck(id)
-```
-
-检查底层定时器是不是在运行
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 定时器id
-
-## 返回值
-
-> `boolean`: 处理结果,true还在运行，false不在运行
-
-## 调用示例
-
-```lua
--- 检查底层定时器是不是在运行
-pm.dtimerCheck(0) -- 检查id=0的底层定时器
-```
-
-
---------------------------------------------------
-# pm.lastReson
-
-```lua
-pm.lastReson()
-```
-
-开机原因,用于判断是从休眠模块开机,还是电源/复位开机
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 0-上电开机, RTC开机, WakeupIn/Pad开机
-2 |`int`| 0-普通开机(上电/复位),3-深睡眠开机,4-休眠开机
-
-## 调用示例
-
-```lua
--- 是哪种方式开机呢
-log.info("pm", "last power reson", pm.lastReson)
-```
-
-
---------------------------------------------------
-# pm.force
-
-```lua
-pm.force(mode)
-```
-
-强制进入指定的休眠模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`mode`|`int`| 休眠模式,仅pm.DEEP/HIB
-
-## 返回值
-
-> `boolean`: 处理结果,若返回成功,大概率会马上进入该休眠模式
-
-## 调用示例
-
-```lua
--- 请求进入休眠模式
-pm.force(pm.HIB)
-```
-
-
---------------------------------------------------
-# pm.check
-
-```lua
-pm.check()
-```
-
-检查休眠状态
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`boolean`| 处理结果,如果能顺利进入休眠,返回true,否则返回false
-2 |`int`| 底层返回值,0代表能进入最底层休眠,其他值代表最低可休眠级别
-
-## 调用示例
-
-```lua
--- 请求进入休眠模式,然后检查是否能真的休眠
-pm.request(pm.HIB)
-if pm.check() then
-    log.info("pm", "it is ok to hib")
-else
-    pm.force(pm.HIB) -- 强制休眠
-end
-```
-
-

docs/api/lua/luat_lib_pwm.md

@@ -1,63 +0,0 @@
----
-module: pwm
-summary: PWM模块
-version: 1.0
-date: 2020.07.03
----
-
---------------------------------------------------
-# pwm.open
-
-```lua
-pwm.open(channel, period, pulse)
-```
-
-开启指定的PWM通道
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`channel`|`int`| PWM通道
-`period`|`int`| 频率, 1-1000000hz
-`pulse`|`int`| 占空比 0-100
-
-## 返回值
-
-> `boolean`: 处理结果,成功返回true,失败返回false
-
-## 调用示例
-
-```lua
--- 打开PWM5, 频率1kHz, 占空比50%
-pwm.open(5, 1000, 50)
-```
-
-
---------------------------------------------------
-# pwm.close
-
-```lua
-pwm.close(channel)
-```
-
-关闭指定的PWM通道
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`channel`|`int`| PWM通道
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭PWM5
-pwm.close(5)
-```
-
-

docs/api/lua/luat_lib_rtos.md

@@ -1,275 +0,0 @@
----
-module: rtos
-summary: RTOS底层操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# rtos.receive
-
-```lua
-rtos.receive(timeout)
-```
-
-接受并处理底层消息队列.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`timeout`|`int`| 超时时长,通常是-1,永久等待
-
-## 返回值
-
-> `msgid`: 如果是定时器消息,会返回定时器消息id及附加信息, 其他消息由底层决定,不向lua层进行任何保证.
-
-## 调用示例
-
-```lua
--- 本方法通过sys.run()调用, 普通用户不要使用
-rtos.receive(-1)
-```
-
-
---------------------------------------------------
-# rtos.timer_start
-
-```lua
-rtos.timer_start(id, timeout, _repeat)
-```
-
-启动一个定时器
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 定时器id
-`timeout`|`int`| 超时时长,单位毫秒
-`_repeat`|`int`| 重复次数,默认是0
-
-## 返回值
-
-> `id`: 如果是定时器消息,会返回定时器消息id及附加信息, 其他消息由底层决定,不向lua层进行任何保证.
-
-## 调用示例
-
-```lua
--- 用户代码请使用 sys.timerStart
--- 启动一个3秒的循环定时器
-rtos.timer_start(10000, 3000, -1)
-```
-
-
---------------------------------------------------
-# rtos.timer_stop
-
-```lua
-rtos.timer_stop(id)
-```
-
-关闭并释放一个定时器
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 定时器id
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 用户代码请使用sys.timerStop
-rtos.timer_stop(100000)
-```
-
-
---------------------------------------------------
-# rtos.reboot
-
-```lua
-rtos.reboot()
-```
-
-设备重启
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 立即重启设备
-rtos.reboot()
-```
-
-
---------------------------------------------------
-# rtos.buildDate
-
-```lua
-rtos.buildDate()
-```
-
-获取固件编译日期
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 固件编译日期
-
-## 调用示例
-
-```lua
--- 获取编译日期
-local d = rtos.buildDate()
-```
-
-
---------------------------------------------------
-# rtos.bsp
-
-```lua
-rtos.bsp()
-```
-
-获取硬件bsp型号
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 硬件bsp型号
-
-## 调用示例
-
-```lua
--- 获取编译日期
-local bsp = rtos.bsp()
-```
-
-
---------------------------------------------------
-# rtos.version
-
-```lua
-rtos.version()
-```
-
- 获取固件版本号
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 固件版本号,例如"1.0.2"
-
-## 调用示例
-
-```lua
--- 读取版本号
-local luatos_version = rtos.version()
-```
-
-
---------------------------------------------------
-# rtos.standy
-
-```lua
-rtos.standy(timeout)
-```
-
-进入待机模式(部分设备可用,例如w60x)
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`timeout`|`int`| 休眠时长,单位毫秒
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 读取版本号
-local luatos_version = rtos.version()
-```
-
-
---------------------------------------------------
-# rtos.meminfo
-
-```lua
-rtos.meminfo(type)
-```
-
-获取内存信息
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`type`|`type`| "sys"系统内存, "lua"虚拟机内存, 默认为lua虚拟机内存
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 总内存大小,单位字节
-2 |`int`| 当前使用的内存大小,单位字节
-3 |`int`| 最大使用的内存大小,单位字节
-
-## 调用示例
-
-```lua
--- 打印内存占用
-log.info("mem.lua", rtos.meminfo())
-log.info("mem.sys", rtos.meminfo("sys"))
-```
-
-
---------------------------------------------------
-# rtos.firmware
-
-```lua
-rtos.firmware()
-```
-
-返回底层描述信息,格式为 LuatOS_$VERSION_$BSP,可用于OTA升级判断底层信息
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 底层描述信息
-
-## 调用示例
-
-```lua
--- 打印底层描述信息
-log.info("firmware", rtos.firmware())
-```
-
-

docs/api/lua/luat_lib_sensor.md

@@ -1,127 +0,0 @@
----
-module: sensor
-summary: 传感器操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# sensor.ds18b20
-
-```lua
-sensor.ds18b20(pin, ?)
-```
-
-获取DS18B20的温度数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| gpio端口号
-`?`|`boolean`| 是否校验crc值,默认为true. 不校验crc值能提高读取成功的概率,但可能会读取到错误的值
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 温度数据,单位0.1摄氏度
-2 |`boolean`| 成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 如果读取失败,会返回nil
-while 1 do 
-    sys.wait(5000) 
-    local val,result = sensor.ds18b20(17, true) -- GPIO17且校验CRC值
-    -- val 301 == 30.1摄氏度
-    -- result true 读取成功
-    log.info("ds18b20", val, result)
-end
-```
-
-
---------------------------------------------------
-# sensor.w1_reset
-
-```lua
-sensor.w1_reset(pin)
-```
-
-单总线协议,复位设备
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| gpio端口号
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# sensor.w1_reset
-
-```lua
-sensor.w1_reset(pin)
-```
-
-单总线协议,连接设备
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| gpio端口号
-
-## 返回值
-
-> `boolean`: 成功返回true,失败返回false
-
-
---------------------------------------------------
-# sensor.w1_write
-
-```lua
-sensor.w1_write(pin, data1, data2)
-```
-
-单总线协议,往总线写入数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| gpio端口号
-`data1`|`int`| 第一个数据
-`data2`|`int`| 第二个数据, 可以写N个数据
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# sensor.w1_read
-
-```lua
-sensor.w1_read(pin, len)
-```
-
-单总线协议,从总线读取数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`pin`|`int`| gpio端口号
-`len`|`int`| 读取的长度
-
-## 返回值
-
-> `int`: 按读取的长度返回N个整数
-
-

docs/api/lua/luat_lib_socket.md

@@ -1,457 +0,0 @@
----
-module: socket
-summary: socket操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# socket.ntpSync
-
-```lua
-socket.ntpSync(server)
-```
-
-ntp时间同步
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`server`|`string`| ntp服务器域名,默认值ntp1.aliyun.com
-
-## 返回值
-
-> `int`: 启动成功返回0, 失败返回1或者2
-
-## 调用示例
-
-```lua
--- 
-socket.ntpSync()
-sys.subscribe("NTP_UPDATE", function(re)
-    log.info("ntp", "result", re)
-end)
-```
-
-
---------------------------------------------------
-# socket.tsend
-
-```lua
-socket.tsend(host, port, data)
-```
-
-直接向地址发送一段数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`host`|`string`| 服务器域名或者ip
-`port`|`int`| 服务器端口号
-`data`|`string`| 待发送的数据
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-socket.tsend("www.baidu.com", 80, "GET / HTTP/1.0\r\n\r\n")
-```
-
-
---------------------------------------------------
-# socket.isReady
-
-```lua
-socket.isReady()
-```
-
-网络是否就绪
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 已联网返回true,否则返回false
-
-
---------------------------------------------------
-# socket.ip
-
-```lua
-socket.ip()
-```
-
-获取自身ip,通常是内网ip
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 已联网返回ip地址,否则返回nil
-
-
---------------------------------------------------
-# socket.tcp
-
-```lua
-socket.tcp()
-```
-
-新建一个tcp socket
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `object`: socket对象,如果创建失败会返回nil
-
-## 调用示例
-
-```lua
--- 如果读取失败,会返回nil
-local so = socket.tcp()
-if so then
-    so:host("www.baidu.com")
-    so:port(80)
-    so:on("connect", function(id, re)
-        if re == 1 then
-            so:send("GET / HTTP/1.0\r\n\r\n")
-        end
-    end)
-    so:on("recv", function(id, data)
-        log.info("netc", id, data)
-    end)
-    if so:start() == 1 then
-        sys.waitUntil("NETC_END_" .. so:id())
-    end
-    so:close()
-    so:clean()
-end
-```
-
-
---------------------------------------------------
-# socket.udp
-
-```lua
-socket.udp()
-```
-
-新建一个udp socket
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-
---------------------------------------------------
-# so:start
-
-```lua
-so:start(host, port)
-```
-
-启动socket线程
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`host`|`string`| 服务器域名或ip,如果已经使用so:host和so:port配置,就不需要传参数了
-`port`|`port`| 服务器端口,如果已经使用so:host和so:port配置,就不需要传参数了
-
-## 返回值
-
-> `int`: 成功返回1,失败返回0
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:close
-
-```lua
-so:close()
-```
-
-关闭socket对象
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:send
-
-```lua
-so:send(data, flags)
-```
-
-通过socket对象发送数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`data`|`string`| 待发送数据
-`flags`|`int`| 可选的额外参数,底层相关.例如NBIOT下的rai值, 传入2,代表数据已经全部发送完成,可更快进入休眠.
-
-## 返回值
-
-> `boolean`: 发送成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:id
-
-```lua
-so:id()
-```
-
-获取socket对象的id
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 对象id,全局唯一
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:host
-
-```lua
-so:host(host)
-```
-
-设置服务器域名或ip
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`host`|`string`| 服务器域名或ip
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:port
-
-```lua
-so:port(port)
-```
-
-设置服务器端口
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`port`|`int`| 服务器端口
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:clean
-
-```lua
-so:clean(0)
-```
-
-清理socket关联的资源,socket对象在废弃前必须调用
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`0`|`null`| *无*
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:on
-
-```lua
-so:on(event, func)
-```
-
-设置socket的事件回调
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`event`|`string`| 事件名称
-`func`|`function`| 回调方法
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:closed
-
-```lua
-so:closed()
-```
-
-socket是否已经断开?
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-No. | Type | Description
-----|------|--------------
-1 |`int`| 未断开0,已断开1
-2 |`bool`| 未断开返回false,已断开返回true, V0003新增
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:rebind
-
-```lua
-so:rebind(socket_id)
-```
-
-为netclient绑定socket id, 该操作仅在NBIOT模块下有意义.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`socket_id`|`int`| socket的id.
-
-## 返回值
-
-> `bool`: 成功返回true, 否则返回false. V0003新增
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-
---------------------------------------------------
-# so:sockid
-
-```lua
-so:sockid()
-```
-
-获取底层socket id
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 底层socket id
-
-## 调用示例
-
-```lua
--- 参考socket.tcp的说明, 并查阅demo
-
-```
-
-

docs/api/lua/luat_lib_spi.md

@@ -1,118 +0,0 @@
----
-module: spi
-summary: spi操作库
-version: 1.0
-date: 2020.04.23
----
-
---------------------------------------------------
-# spi.setup
-
-```lua
-spi.setup(id, cs, CPHA, CPOL, dataw, bandrate, bitdict, ms, mode)
-```
-
-设置并启用SPI
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| SPI号,例如0
-`cs`|`int`| CS 片选脚,暂不可用,请填nil
-`CPHA`|`int`| CPHA 默认0,可选0/1
-`CPOL`|`int`| CPOL 默认0,可选0/1
-`dataw`|`int`| 数据宽度,默认8bit
-`bandrate`|`int`| 波特率,默认2M=2000000
-`bitdict`|`int`| 大小端, 默认spi.MSB, 可选spi.LSB
-`ms`|`int`| 主从设置, 默认主1, 可选从机0. 通常只支持主机模式
-`mode`|`int`| 工作模式, 全双工1, 半双工0, 默认全双工
-
-## 返回值
-
-> `int`: 成功返回0,否则返回其他值
-
-
---------------------------------------------------
-# spi.close
-
-```lua
-spi.close(id)
-```
-
-关闭指定的SPI
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| SPI号,例如0
-
-## 返回值
-
-> `int`: 成功返回0,否则返回其他值
-
-
---------------------------------------------------
-# spi.transfer
-
-```lua
-spi.transfer(id, send_data)
-```
-
-传输SPI数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| SPI号,例如0
-`send_data`|`string`| 待发送的数据
-
-## 返回值
-
-> `string`: 读取成功返回字符串,否则返回nil
-
-
---------------------------------------------------
-# spi.recv
-
-```lua
-spi.recv(id, size)
-```
-
-接收指定长度的SPI数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| SPI号,例如0
-`size`|`int`| 数据长度
-
-## 返回值
-
-> `string`: 读取成功返回字符串,否则返回nil
-
-
---------------------------------------------------
-# spi.send
-
-```lua
-spi.send(id, data)
-```
-
-发送SPI数据
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| SPI号,例如0
-`data`|`string`| 待发送的数据
-
-## 返回值
-
-> `int`: 发送结果
-
-

docs/api/lua/luat_lib_timer.md

@@ -1,34 +0,0 @@
----
-module: timer
-summary: 操作底层定时器
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# timer.mdelay
-
-```lua
-timer.mdelay(timeout)
-```
-
-硬阻塞指定时长,期间没有任何luat代码会执行,包括底层消息处理机制
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`timeout`|`int`| 阻塞时长
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 本方法通常不会使用,除非你很清楚会发生什么
-timer.mdelay(10)
-```
-
-

docs/api/lua/luat_lib_u8g2.md

@@ -1,605 +0,0 @@
----
-module: u8g2
-summary: u8g2图形处理库
-version: 1.0
-date: 2021.01.25
----
-
---------------------------------------------------
-# u8g2.begin
-
-```lua
-u8g2.begin("ssd1306")
-```
-
-u8g2显示屏初始化
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`"ssd1306"`|`string`| 配置信息
-
-## 返回值
-
-> `int`: 正常初始化1,已经初始化过2,内存不够3,初始化失败返回4
-
-## 调用示例
-
-```lua
--- 初始化i2c1的ssd1306
-u8g2.begin("ssd1306")
-```
-
-
---------------------------------------------------
-# u8g2.close
-
-```lua
-u8g2.close()
-```
-
-关闭显示屏
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 关闭disp,再次使用disp相关API的话,需要重新初始化
-u8g2.close()
-```
-
-
---------------------------------------------------
-# u8g2.ClearBuffer
-
-```lua
-u8g2.ClearBuffer()
-```
-
-清屏，清除内存帧缓冲区中的所有像素
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 清屏
-u8g2.ClearBuffer()
-```
-
-
---------------------------------------------------
-# u8g2.SendBuffer
-
-```lua
-u8g2.SendBuffer()
-```
-
-将数据更新到屏幕，将存储器帧缓冲区的内容发送到显示器
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 把显示数据更新到屏幕
-u8g2.SendBuffer()
-```
-
-
---------------------------------------------------
-# u8g2.DrawUTF8
-
-```lua
-u8g2.DrawUTF8(str, x, y)
-```
-
-在显示屏上画一段文字，在显示屏上画一段文字,要调用u8g2.SendBuffer()才会更新到屏幕
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`str`|`string`| 文件内容
-`x`|`int`| 横坐标
-`y`|`int`| 竖坐标
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawUTF8("wifi is ready", 10, 20)
-```
-
-
---------------------------------------------------
-# u8g2.SetFontMode
-
-```lua
-u8g2.SetFontMode(mode)
-```
-
-设置字体模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`mode`|`int`| mode字体模式，启用（1）或禁用（0）透明模式
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.SetFontMode(1)
-```
-
-
---------------------------------------------------
-# u8g2.SetFont
-
-```lua
-u8g2.SetFont(font)
-```
-
-设置字体
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`font`|`string`| font, "u8g2_font_ncenB08_tr"为纯英文8x8字节,"u8g2_font_wqy12_t_gb2312"为12x12全中文,"u8g2_font_unifont_t_symbols"为符号.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 设置为中文字体,对之后的drawStr有效,使用中文字体需在luat_base.h开启#define USE_U8G2_WQY12_T_GB2312
-u8g2.setFont("u8g2_font_wqy12_t_gb2312")
-```
-
-
---------------------------------------------------
-# u8g2.GetDisplayHeight
-
-```lua
-u8g2.GetDisplayHeight()
-```
-
-获取显示屏高度
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 显示屏高度
-
-## 调用示例
-
-```lua
--- 
-u8g2.GetDisplayHeight()
-```
-
-
---------------------------------------------------
-# u8g2.GetDisplayWidth
-
-```lua
-u8g2.GetDisplayWidth()
-```
-
-获取显示屏宽度
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 显示屏宽度
-
-## 调用示例
-
-```lua
--- 
-u8g2.GetDisplayWidth()
-```
-
-
---------------------------------------------------
-# u8g2.DrawLine
-
-```lua
-u8g2.DrawLine(x0, y0, x1, y1)
-```
-
-在两点之间画一条线.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 第一个点的X位置.
-`y0`|`int`| 第一个点的Y位置.
-`x1`|`int`| 第二个点的X位置.
-`y1`|`int`| 第二个点的Y位置.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawLine(20, 5, 5, 32)
-```
-
-
---------------------------------------------------
-# u8g2.DrawCircle
-
-```lua
-u8g2.DrawCircle(x0, y0, rad, opt)
-```
-
-在x,y位置画一个半径为rad的空心圆.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 圆心位置
-`y0`|`int`| 圆心位置
-`rad`|`int`| 圆半径.
-`opt`|`int`| 选择圆的部分或全部.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawCircle(60,30,8,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawDisc
-
-```lua
-u8g2.DrawDisc(x0, y0, rad, opt)
-```
-
-在x,y位置画一个半径为rad的实心圆.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 圆心位置
-`y0`|`int`| 圆心位置
-`rad`|`int`| 圆半径.
-`opt`|`int`| 选择圆的部分或全部.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawDisc(60,30,8,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawEllipse
-
-```lua
-u8g2.DrawEllipse(x0, y0, rx, ry, opt)
-```
-
-在x,y位置画一个半径为rad的空心椭圆.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 圆心位置
-`y0`|`int`| 圆心位置
-`rx`|`int`| 椭圆大小
-`ry`|`int`| 椭圆大小
-`opt`|`int`| 选择圆的部分或全部.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawEllipse(60,30,8,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawFilledEllipse
-
-```lua
-u8g2.DrawFilledEllipse(x0, y0, rx, ry, opt)
-```
-
-在x,y位置画一个半径为rad的实心椭圆.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 圆心位置
-`y0`|`int`| 圆心位置
-`rx`|`int`| 椭圆大小
-`ry`|`int`| 椭圆大小
-`opt`|`int`| 选择圆的部分或全部.
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawFilledEllipse(60,30,8,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawBox
-
-```lua
-u8g2.DrawBox(x, y, w, h)
-```
-
-从x / y位置（左上边缘）开始绘制一个框（填充的框）.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 左上边缘的X位置
-`y`|`int`| 左上边缘的Y位置
-`w`|`int`| 盒子的宽度
-`h`|`int`| 盒子的高度
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawBox(3,7,25,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawFrame
-
-```lua
-u8g2.DrawFrame(x, y, w, h)
-```
-
-从x / y位置（左上边缘）开始绘制一个框（空框）.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 左上边缘的X位置
-`y`|`int`| 左上边缘的Y位置
-`w`|`int`| 盒子的宽度
-`h`|`int`| 盒子的高度
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawFrame(3,7,25,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawRBox
-
-```lua
-u8g2.DrawRBox(x, y, w, h, r)
-```
-
-绘制一个从x / y位置（左上边缘）开始具有圆形边缘的填充框/框架.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 左上边缘的X位置
-`y`|`int`| 左上边缘的Y位置
-`w`|`int`| 盒子的宽度
-`h`|`int`| 盒子的高度
-`r`|`int`| 四个边缘的半径
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawRBox(3,7,25,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawRFrame
-
-```lua
-u8g2.DrawRFrame(x, y, w, h, r)
-```
-
-绘制一个从x / y位置（左上边缘）开始具有圆形边缘的空框/框架.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 左上边缘的X位置
-`y`|`int`| 左上边缘的Y位置
-`w`|`int`| 盒子的宽度
-`h`|`int`| 盒子的高度
-`r`|`int`| 四个边缘的半径
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawRFrame(3,7,25,15)
-```
-
-
---------------------------------------------------
-# u8g2.DrawGlyph
-
-```lua
-u8g2.DrawGlyph(x, y, encoding)
-```
-
-绘制一个图形字符。字符放置在指定的像素位置x和y.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x`|`int`| 字符在显示屏上的位置
-`y`|`int`| 字符在显示屏上的位置
-`encoding`|`int`| 字符的Unicode值
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.SetFont(u8g2_font_unifont_t_symbols)
-u8g2.DrawGlyph(5, 20, 0x2603)	-- dec 9731/hex 2603 Snowman
-```
-
-
---------------------------------------------------
-# u8g2.DrawTriangle
-
-```lua
-u8g2.DrawTriangle(x0, y0, x1, y1, x2, y2)
-```
-
-绘制一个三角形（实心多边形）.
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`x0`|`int`| 点0X位置
-`y0`|`int`| 点0Y位置
-`x1`|`int`| 点1X位置
-`y1`|`int`| 点1Y位置
-`x2`|`int`| 点2X位置
-`y2`|`int`| 点2Y位置
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.DrawTriangle(20,5, 27,50, 5,32)
-```
-
-
---------------------------------------------------
-# u8g2.SetBitmapMode
-
-```lua
-u8g2.SetBitmapMode(mode)
-```
-
-定义位图函数是否将写入背景色
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`mode`|`int`| mode字体模式，启用（1）或禁用（0）透明模式
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-u8g2.SetBitmapMode(1)
-```
-
-

docs/api/lua/luat_lib_uart.md

@@ -1,161 +0,0 @@
----
-module: uart
-summary: 串口操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# uart.setup
-
-```lua
-uart.setup(id, baud_rate, data_bits, stop_bits, partiy, bit_order, buff_size)
-```
-
-配置串口参数
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 串口id, uart0写0, uart1写1
-`baud_rate`|`int`| 波特率 9600~115200
-`data_bits`|`int`| 数据位 7或8, 一般是8
-`stop_bits`|`int`| 停止位 1或0, 一般是1
-`partiy`|`int`| 校验位, 可选 uart.None/uart.Even/uart.Odd
-`bit_order`|`int`| 大小端, 默认小端 uart.LSB, 可选 uart.MSB
-`buff_size`|`int`| 缓冲区大小, 默认值1024
-
-## 返回值
-
-> `int`: 成功返回0,失败返回其他值
-
-## 调用示例
-
-```lua
--- 最常用115200 8N1
--- 可以简写为 uart.setup(1)
-uart.setup(1, 115200, 8, 1, uart.NONE)
--------------------------
--- 最常用115200 8N1
--- 可以简写为 uart.setup(1)
-uart.setup(1, 115200, 8, 1, uart.NONE)
-```
-
-
---------------------------------------------------
-# uart.write
-
-```lua
-uart.write(id, data)
-```
-
-写串口
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 串口id, uart0写0, uart1写1
-`data`|`string`| 待写入的数据
-
-## 返回值
-
-> `int`: 成功的数据长度
-
-## 调用示例
-
-```lua
--- 
-uart.write(1, "rdy\r\n")
-```
-
-
---------------------------------------------------
-# uart.read
-
-```lua
-uart.read(id, len, ?)
-```
-
-读串口
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 串口id, uart0写0, uart1写1
-`len`|`int`| 读取长度
-`?`|`int`| 文件句柄(可选)
-
-## 返回值
-
-> `string`: 读取到的数据
-
-## 调用示例
-
-```lua
--- 
-uart.read(1, 16)
-```
-
-
---------------------------------------------------
-# uart.close
-
-```lua
-uart.close(id)
-```
-
-关闭串口
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 串口id, uart0写0, uart1写1
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-uart.close(1)
-```
-
-
---------------------------------------------------
-# uart.on
-
-```lua
-uart.on(id, event, func)
-```
-
-注册串口事件回调
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`id`|`int`| 串口id, uart0写0, uart1写1
-`event`|`string`| 事件名称
-`func`|`function`| 回调方法
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 
-uart.on("receive", function(id, len)
-    local data = uart.read(id, len)
-    log.info("uart", id, len, data)
-end)
-```
-
-

docs/api/lua/luat_lib_wlan.md

@@ -1,467 +0,0 @@
----
-module: wlan
-summary: wifi操作库
-version: 1.0
-date: 2020.03.30
----
-
---------------------------------------------------
-# wlan.getMode
-
-```lua
-wlan.getMode(dev)
-```
-
-获取wifi模式
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`dev`|`string`| 设备名称,字符串或数值, 可选值0/1, "wlan0","wlan1". 默认"wlan0"
-
-## 返回值
-
-> `int`: 模式wlan.NONE, wlan.STATION, wlan.AP
-
-## 调用示例
-
-```lua
--- 获取wlan0的当前模式
-local m = wlan.getMode("wlan0")
-```
-
-
---------------------------------------------------
-# wlan.setMode
-
-```lua
-wlan.setMode(dev, mode)
-```
-
-设置wifi模式,通常不需要设置
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`dev`|`string`| 设备名称,字符串或数值, 可选值0/1, "wlan0","wlan1". 默认"wlan0"
-`mode`|`int`| 模式wlan.NONE, wlan.STATION, wlan.AP
-
-## 返回值
-
-> `int`: 设置成功与否,通常不检查
-
-## 调用示例
-
-```lua
--- 将wlan设置为wifi客户端模式
-wlan.setMode("wlan0",wlan.STATION) 
-```
-
-
---------------------------------------------------
-# wlan.connect
-
-```lua
-wlan.connect(ssid, password)
-```
-
-连接wifi,成功启动联网线程不等于联网成功!!
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`ssid`|`string`| ssid  wifi的SSID
-`password`|`string`| password wifi的密码,可选
-
-## 返回值
-
-> `boolean`: 如果正常启动联网线程,无返回值,否则返回出错信息.
-
-## 调用示例
-
-```lua
--- 连接到uiot,密码1234567890
-wlan.connect("uiot", "1234567890")
-```
-
-
---------------------------------------------------
-# wlan.disconnect
-
-```lua
-wlan.disconnect()
-```
-
-断开wifi
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 断开wifi连接
-wlan.disconnect()
-```
-
-
---------------------------------------------------
-# wlan.connected
-
-```lua
-wlan.connected()
-```
-
-是否已经连上wifi网络
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 已连接返回true0,未连接返回false
-
-## 调用示例
-
-```lua
--- 连上wifi网络,只代表密码正确, 不一定拿到了ip
-wlan.connected()
-```
-
-
---------------------------------------------------
-# wlan.autoreconnect
-
-```lua
-wlan.autoreconnect(enable)
-```
-
-设置或查询wifi station是否自动连接
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`enable`|`int`| 传入1启用自动连接(自动重连wifi), 传入0关闭. 不传这个参数就是查询
-
-## 返回值
-
-> `int`: 已启用自动连接(自动重连wifi)返回1, 否则返回0
-
-## 调用示例
-
-```lua
--- 查询自动连接的设置
-wlan.autoreconnect()
--------------------------
--- 设置自动连接
-wlan.autoreconnect(1)
-```
-
-
---------------------------------------------------
-# wlan.scan
-
-```lua
-wlan.scan()
-```
-
-开始扫网,通常配合wlan.scanResult使用
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 启动结果,一般为true
-
-## 调用示例
-
-```lua
--- 扫描并查询结果
-wlan.scan()
-sys.waitUntil("WLAN_SCAN_DONE", 30000)
-local re = wlan.scanResult()
-for i in ipairs(re) do
-    log.info("wlan", "info", re[i].ssid, re[i].rssi)
-end
-```
-
-
---------------------------------------------------
-# wlan.scanResult
-
-```lua
-wlan.scanResult(num)
-```
-
-获取扫网结果,需要先执行wlan.scan,并等待WLAN_SCAN_DONE事件
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`num`|`int`| 最大结果数量,默认50
-
-## 返回值
-
-> `table`: 扫描结果的数组
-
-## 调用示例
-
-```lua
--- 扫描并查询结果
-wlan.scan()
-sys.waitUntil("WLAN_SCAN_DONE", 30000)
-local re = wlan.scanResult()
-for i in ipairs(re) do
-    log.info("wlan", "info", re[i].ssid, re[i].rssi)
-end
-```
-
-
---------------------------------------------------
-# wlan.get_mac
-
-```lua
-wlan.get_mac()
-```
-
-获取mac地址
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 长度为12的HEX字符串,如果不存在就返回值nil
-
-## 调用示例
-
-```lua
--- 获取MAC地址
-log.info("wlan", "mac addr", wlan.get_mac())
-```
-
-
---------------------------------------------------
-# wlan.get_mac_raw
-
-```lua
-wlan.get_mac_raw()
-```
-
-获取mac地址,raw格式
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `string`: 6字节的mac地址串
-
-## 调用示例
-
-```lua
--- 查询mac地址, 二进制模式
-local mac_raw  = wlan.get_mac_raw()
-if mac_raw then
-    log.info("wlan", "mac addr", mac_raw:toHex())
-end
-```
-
-
---------------------------------------------------
-# wlan.ready
-
-```lua
-wlan.ready()
-```
-
-wifi是否已经获取ip
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 已经有ip返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 查询是否已经wifi联网
-if wlan.ready() then
-    log.info("wlan", "wifi ok", "Let's Rock!")
-end
-```
-
-
---------------------------------------------------
-# wlan.oneShotStart
-
-```lua
-wlan.oneShotStart(mode, ssid, passwd)
-```
-
-启动配网过程,支持UDP/SOCKET/APWEB配网
-
-## 参数表
-
-Name | Type | Description
------|------|--------------
-`mode`|`int`| 配网模式: 0-UDP配网, 1-SOCKET配网, 2-AP网页配网
-`ssid`|`string`| AP网页配网时的SSID,默认值为luatos
-`passwd`|`string`| AP网页配网时的密钥,默认值为12345678
-
-## 返回值
-
-> `boolean`: 启动成功返回true,否则返回false
-
-## 调用示例
-
-```lua
--- UDP配网,需要下载联德盛测试APP,2.0版本
-wlan.oneShotStart(0)
--------------------------
--- SOCKET配网,需要下载联德盛测试APP,2.0版本
-wlan.oneShotStart(1)
--------------------------
--- AP网页配网,手机搜索wifi "W600APWEB", 密码12345678. 连上之后,保持wifi连接,浏览器访问 192.168.168.1, 按提示输入.
-wlan.oneShotStart(2, "W600APWEB", "12345678")
--------------------------
--- 监听配网信息
-sys.subscribe("WLAN_PW_RE", function(ssid, passwd)
-    if ssid then
-        log.info("wlan", "Got ssid and passwd", ssid, passwd)
-    else
-        log.info("wlan", "oneshot fail")
-    end
-end)
-```
-
-
---------------------------------------------------
-# wlan.oneshotStop
-
-```lua
-wlan.oneshotStop()
-```
-
-停止配网, 通常不需要调用
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> *无返回值*
-
-## 调用示例
-
-```lua
--- 停止配网
-wlan.oneshotStop()
-```
-
-
---------------------------------------------------
-# wlan.oneshotState
-
-```lua
-wlan.oneshotState()
-```
-
-查询配网状态
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `boolean`: 配网中返回true,否则返回false
-
-## 调用示例
-
-```lua
--- 查询
-if wlan.oneshotState() then
-    log.info("wlan", "配网中")
-end
-```
-
-
---------------------------------------------------
-# wlan.rssi
-
-```lua
-wlan.rssi()
-```
-
-获取wifi信号强度值rssi
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `int`: 如果是station模式,返回正的rssi值,否则返回负值
-
-## 调用示例
-
-```lua
--- 信号强度
-log.info("wlan", wlan.rssi())
-```
-
-
---------------------------------------------------
-# wlan.airkiss_start
-
-```lua
-wlan.airkiss_start()
-```
-
-启动airkiss配网线程
-
-## 参数表
-
-> 无参数
-
-## 返回值
-
-> `re`: 启动成功返回1,否则返回0
-
-## 调用示例
-
-```lua
--- 启动airkiss配网
-wlan.airkiss_start()
--------------------------
--- 监听配网信息
-sys.subscribe("WLAN_PW_RE", function(ssid, passwd)
-    if ssid then
-        log.info("wlan", "Got ssid and passwd", ssid, passwd)
-    else
-        log.info("wlan", "oneshot fail")
-    end
-end)
-```
-
-