OTA 相关接口

API 列表

函数	说明
Ql_iotCmdOtaRequest()	向平台请求OTA升级计划
Ql_iotCmdOtaAction()	配置OTA升级行为
Ql_iotCmdOtaMcuFWDataRead()	读取保存在模块中的固件数据

API 详情

Ql_iotCmdOtaRequest

该函数用于向平台请求 OTA 升级计划。

函数原型

qbool Ql_iotCmdOtaRequest(quint32_t mode)

参数说明

• 输入参数
  • quint32_t  mode：额外信息请求。
    • 0： 不需要
    • 1： 需要

返回值

• True：   函数执行成功。
• False： 函数执行失败。

备注

• 2.8.2及以上版本支持

---

调用示例

qbool ret = Ql_iotCmdOtaRequest(0);

---

Ql_iotCmdOtaAction

该函数用于在设备接收到平台推送的升级任务时，配置 OTA 升级行为。

函数原型

qbool Ql_iotCmdOtaAction(quint8_t action)

参数说明

• 输入参数
  • quint8_t  action：OTA 确认升级行为。
    • 0：拒绝升级
    • 1：确认升级
    • 2：MCU 通知下载下一块固件数据
    • 3：MCU 上报更新中状态

返回值

• True：   函数执行成功。
• False： 函数执行失败。

备注

• 2.3.3及以上版本支持

---

调用示例

qbool ret = Ql_iotCmdOtaAction(1);

---

Ql_iotCmdOtaMcuFWDataRead

该函数用于读取保存模块中的固件数据。

函数原型

quint32_t Ql_iotCmdOtaMcuFWDataRead(quint32_t startAddr, quint8_t data[], quint32_t maxLen)

参数说明

• 输入参数
  • quint32_t startAddr： 读取数据开始位置。单位：字节。
  • quint8_t   data：指针，指向存放待读取数据的缓存。
  • quint32_t   maxLen：待读取数据的长度。

返回值

• 0：     数据读取失败。
• 大于0： 实际读取到的固件数据长度。

备注

• 2.3.3及以上版本支持

---

调用示例

quint8_t readBuf[1024];
quint32_t ret = Ql_iotCmdOtaMcuFWDataRead(0,readBuf,sizeof(readBuf));