update.lua 5.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. --[[
  2. @module update
  3. @summary 远程升级功能模块
  4. @version 1.0
  5. @date 2025.08.12
  6. @author 孟伟
  7. @usage
  8. 实现远程升级功能,具体流程如下:
  9. 1、判断网卡是否连接成功;
  10. 2、初始化fota2模块;
  11. 3、配置fota2模块的参数;
  12. 4、调用fota2模块的升级函数;
  13. 5、在升级结果的回调函数中,根据升级结果进行处理;
  14. ]]
  15. libfota2 = require "libfota2"
  16. -- 循环打印版本号, 方便看版本号变化, 非必须
  17. function get_version()
  18. log.info("fota", "脚本版本号", VERSION, "core版本号", rtos.version())
  19. end
  20. sys.timerLoopStart(get_version, 3000)
  21. -- 升级结果的回调函数
  22. -- 功能:获取fota的回调函数
  23. -- 参数:
  24. -- result:number类型
  25. -- 0表示成功
  26. -- 1表示连接失败
  27. -- 2表示url错误
  28. -- 3表示服务器断开
  29. -- 4表示接收报文错误
  30. -- 5缺少必要的PROJECT_KEY参数
  31. local function fota_cb(ret)
  32. log.info("fota", ret)
  33. if ret == 0 then
  34. log.info("升级包下载成功,重启模块")
  35. rtos.reboot()
  36. elseif ret == 1 then
  37. log.info("连接失败", "请检查url拼写或服务器配置(是否为内网)")
  38. elseif ret == 2 then
  39. log.info("url错误", "检查url拼写")
  40. elseif ret == 3 then
  41. log.info("服务器断开", "检查服务器白名单配置")
  42. elseif ret == 4 then
  43. log.error("FOTA 失败",
  44. "原因可能有:\n" ..
  45. "1) 服务器返回 200/206 但报文体为空(0 字节)—— 通常是升级包文件缺失或 URL 指向空文件;\n" ..
  46. "2) 服务器返回 4xx/5xx 等异常状态码 —— 请确认升级包已上传、URL 正确、鉴权信息有效;\n"..
  47. "3) 已经是最新版本,无需升级" )
  48. elseif ret == 5 then
  49. log.info("缺少必要的PROJECT_KEY参数")
  50. else
  51. log.info("不是上面几种情况 ret为", ret)
  52. end
  53. end
  54. -- 使用第三方服务器,配置ota_opts参数
  55. --[[
  56. -- opts参数说明, 所有参数都是可选的
  57. -- 1. opts.url string 升级所需要的URL, 若使用合宙iot平台,则不需要填
  58. -- 2. opts.version string 版本号, 默认是 BSP版本号.x.z格式
  59. -- 3. opts.timeout int 请求超时时间, 默认300000毫秒,单位毫秒
  60. -- 4. opts.project_key string 合宙IOT平台的项目key, 默认取全局变量PRODUCT_KEY. 自建服务器不用填
  61. -- 5. opts.imei string 设备识别码, 默认取IMEI(Cat.1模块)或WLAN MAC地址(wifi模块)或MCU唯一ID
  62. -- 6. opts.firmware_name string 固件名称,默认是 _G.PROJECT.. "_LuatOS-SoC_" .. rtos.bsp()
  63. -- 7. opts.server_cert string 服务器证书, 默认不使用
  64. -- 8. opts.client_cert string 客户端证书, 默认不使用
  65. -- 9. opts.client_key string 客户端私钥, 默认不使用
  66. -- 10. opts.client_password string 客户端私钥口令, 默认不使用
  67. -- 11. opts.method string 请求方法, 默认是GET
  68. -- 12. opts.headers table 额外添加的请求头,默认不需要
  69. -- 13. opts.body string 额外添加的请求body,默认不需要
  70. ]]
  71. local opts = {
  72. url = "###http://cdn.openluat-backend.openluat.com/upgrade_firmware/fotademo_2008.001.001_LuatOS-SoC_Air8000.bin_20250623184110381812",
  73. -- 合宙IOT平台的默认升级URL, 不填就是这个默认值
  74. -- 如果是自建的OTA服务器, 则需要填写正确的URL, 例如 http://192.168.1.5:8000/update
  75. -- 如果自建OTA服务器,且url包含全部参数,不需要额外添加参数, 请在url前面添加 ###
  76. -- 如果不加###,则默认会上传如下参数
  77. -- 1. opts.version string 版本号, 默认是 BSP版本号.x.z格式
  78. -- 2. opts.timeout int 请求超时时间, 默认300000毫秒,单位毫秒
  79. -- 3. opts.project_key string 合宙IOT平台的项目key, 默认取全局变量PRODUCT_KEY. 自建服务器不用填
  80. -- 4. opts.imei string 设备识别码, 默认取IMEI(Cat.1模块)或WLAN MAC地址(wifi模块)或MCU唯一ID
  81. -- 5. opts.firmware_name string 底层版本号
  82. -- 请求的版本号, 合宙IOT有一套版本号体系,不传就是合宙规则, 自建服务器的话当然是自行约定版本号了
  83. -- version = ""
  84. -- 其他更多参数, 请查阅libfota2的文档 https://docs.openluat.com/osapi/ext/libfota2/
  85. }
  86. function fota_task_func()
  87. -- 如果当前时间点设置的默认网卡还没有连接成功,一直在这里循环等待
  88. while not socket.adapter(socket.dft()) do
  89. log.warn("fota_task_func", "wait IP_READY", socket.dft())
  90. -- 在此处阻塞等待默认网卡连接成功的消息"IP_READY"
  91. -- 或者等待1秒超时退出阻塞等待状态;
  92. -- 注意:此处的1000毫秒超时不要修改的更长;
  93. -- 因为当使用libnetif.set_priority_order配置多个网卡连接外网的优先级时,会隐式的修改默认使用的网卡
  94. -- 当libnetif.set_priority_order的调用时序和此处的socket.adapter(socket.dft())判断时序有可能不匹配
  95. -- 此处的1秒,能够保证,即使时序不匹配,也能1秒钟退出阻塞状态,再去判断socket.adapter(socket.dft())
  96. sys.waitUntil("IP_READY", 1000)
  97. end
  98. -- 检测到了IP_READY消息
  99. log.info("fota_task_func", "recv IP_READY", socket.dft())
  100. ----这个判断是提醒要设置url的,且不要使用本文中的测试服务器,实际生产请删除
  101. if not opts.url or string.find(opts.url,"airtest.openluat.com") then
  102. while 1 do
  103. sys.wait(1000)
  104. log.info("fota", "当前URL",opts.url,"请修改正确的url")
  105. end
  106. end
  107. log.info("开始检查升级")
  108. libfota2.request(fota_cb, opts)
  109. end
  110. --创建并且启动一个task
  111. --运行这个task的主函数fota_task_func
  112. sys.taskInit(fota_task_func)
  113. -- 演示定时自动升级, 每隔4小时自动检查一次
  114. sys.timerLoopStart(libfota2.request, 4 * 3600000, fota_cb, opts)