fota - 底层固件升级#

已适配 Air780E/Air700E Air780EP Air601 Air101/Air103 Air105

备注

本页文档由这个文件自动生成。如有错误,请提交issue或帮忙修改后pr,谢谢!

小技巧

本库有专属demo,点此链接查看fota的demo例子

示例

-- 如果是从http获取升级包, 那么看demo/fota就可以了
-- 以下是从其他途径获取更新包后, 调用本fota库的基本逻辑

-- 逐段传入
sys.taskInit(function()
    fota.init()
    while 1 do
        local buf = xxx -- 这里是从其他途径获取的升级包片段
        -- buf 可以是zbuff 也可以是string
        -- 每次写入的数据长度最大不应超过4k
        local result, isDone, cache = fota.run(buf) 
        if not result then
            log.info("fota", "出错了")
            break
        end
        if isDone then
            while true do
                local succ,fotaDone  = fota.isDone()
                if not succ then
                    log.info("fota", "出错了")
                    break
                end
                if fotaDone then
                    log.info("fota", "已完成")
                    break
                end
                sys.wait(100)
            end
            break
        end
        sys.wait(100)
    end
end)

-- 使用文件一次性传入
sys.taskInit(function()
    fota.init()
    fota.file("/xxx") -- 传入具体的路径
end)

fota.init(storge_location, len, param1)#

初始化fota流程

参数

传入值类型

解释

int/string

fota数据存储的起始位置
如果是int,则是由芯片平台具体判断
如果是string,则存储在文件系统中
如果为nil,则由底层决定存储位置

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, offset, len)#

写入fota数据

参数

传入值类型

解释

zbuff/string

fota数据,尽量用zbuff

int

起始偏移量,传入zbuff时有效,默认是0

int

写入长度,传入zbuff时有效,默认是zbuff:used()

返回值

返回值类型

解释

boolean

有异常返回false,无异常返回true

boolean

接收到最后一块返回true

int

还未写入的数据量,超过64K必须做等待

例子

local result, isDone, cache = fota.run(buf) -- 写入fota流程

-- 提示: ,如果传入的是zbuff,写入成功后,请自行清空zbuff内的数据

-- 2024.4.3新增offset, len参数, 仅对zbuff有效
fota.run(buff, 0, 1024)

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)