fota.init(storge_location, len, param1)#
初始化fota流程
参数
| 传入值类型 | 解释 |
|---|---|
| int/string | fota数据存储的起始位置 |
| int | 数据存储的最大空间 |
| userdata | param1，如果数据存储在spiflash时,为spi_device |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 成功返回true, 失败返回false |
例子
-- 初始化fota流程 local result = fota.init(0, 0x00300000, spi_device) --由于105的flash从0x01000000开始，所以0就是外部spiflash local result = fota.init() --ec618使用固定内部地址，所以不需要参数了
fota.wait()
等待底层fota流程准备好
参数
| 传入值类型 | 解释 |
|---|---|
| boolean | 是否完整走完流程，true 表示正确走完流程了 |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 准备好返回true |
例子
local isDone = fota.wait()
fota.run(buff)
写入fota数据
参数
| 传入值类型 | 解释 |
|---|---|
| zbuff/string | fota数据，尽量用zbuff，如果传入的是zbuff，写入成功后，自动清空zbuff内的数据 |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 有异常返回false，无异常返回true |
| boolean | 接收到最后一块返回true |
| int | 还未写入的数据量，超过64K必须做等待 |
例子
local result, isDone, cache = fota.run(buf) -- 写入fota流程
fota.file(path)
从指定文件读取fota数据
参数
| 传入值类型 | 解释 |
|---|---|
| string | 文件路径 |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 有异常返回false，无异常返回true |
| boolean | 接收到最后一块返回true |
| int | 还未写入的数据量，超过64K必须做等待 |
例子
local result, isDone, cache = fota.file("/xxx.bin") -- 写入fota流程
-- 本API于2023.03.23 添加
fota.isDone()
等待底层fota流程完成
参数
无
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 有异常返回false，无异常返回true |
| boolean | 写入到最后一块返回true |
例子
local result, isDone = fota.isDone()
fota.finish(is_ok)
结束fota流程
参数
| 传入值类型 | 解释 |
|---|---|
| boolean | 是否完整走完流程，true 表示正确走完流程了 |
返回值
| 返回值类型 | 解释 |
|---|---|
| boolean | 成功返回true, 失败返回false |
例子
-- 结束fota流程 local result = fota.finish(true)
)
)
