ota

更正文档贡献说明

概述

OTA是over the air的缩写,是AliIOS Things 提供的完备的升级方案,对各种升级场景都有很好的支持。目前AliIOS Things除一般的整包升级外,现有的高阶能力有:压缩升级、差分升级及安全升级;支持的升级通道:http、https、BLE、3G/4G,NB等;复杂场景支持:网关及子设备升级,连接型模组升级非连接主设备的间接升级;完备的配套工具:差分工具、本地签名工具、ymodem辅助升级工具,多固件打包工具等;

主要功能列表如下: 1、支持乒乓升级:固件可在两个分区运行,支持固件版本回退,保证设备安全不变砖;

2、支持断点续传:弱网环境下,支持固件从断点处继续下载;

3、支持固件验签:固件可在云端或用本地签名工具进行数字签名(防止固件被篡改,对固件hash值进行非对称加密),设备端可完成对固件验签(用端侧的公钥对已签名的固件进行验签);

4、支持https安全下载方式:除支持http下载外,支持https下载方式;

5、支持MD5/SHA256固件完整性检验:为保证固件完成性,固件下载完成后,都有完整性校验;

6、支持网关子设备升级:当HaaS 100 做网关时,HaaS 100 OTA 除支持网关本身的升级外,也支持其子设备的升级;

版权信息

Apache license v2.0

目录结构

.
├── 2ndboot                               # 二级boot升级(差分恢复和固件解压缩)
├── hal                                   # OTA HAL适配层(适配flash、os)
│   ├── ota_hal_ctrl.c                    # flash和ota agent的中间层
│   ├── ota_hal_digest.c                  # 安全相关md5、sha256、rsa适配层
│   ├── ota_hal_digest.h
│   ├── ota_hal_fs_ctrl.c                 # 文件系统操作相关适配层
│   ├── ota_hal_fs_plat.c                 # 子设备升级文件相关接口
│   ├── ota_hal_os.c                      # os适配代码
│   ├── ota_hal_os.h
│   ├── ota_hal_param.c                   # bootloader相关参数
│   ├── ota_hal_vfs_plat.c                # flash相关适配
│   ├── ota_hal_trans.c                   # 传输底层适配层(比如mqtt、coap、http)
│   └── ota_hal_trans.h
├── include                               # 头文件
│   ├── ota_agent.h                       # 初始化和回调函数相关头文件
│   ├── ota_hal.h                         # hal层头文件
│   ├── ota_import.h                      # 内部使用头文件(错误码、类型定义、内部接口等)
│   ├── ota_log.h                         # ota日志头文件(对接各种日志接口)
│   └── ota_updater.h                     # 对外接口头文件
├── ota_agent                             # 所有下载和消息传输、加解密功能
│   ├── download
│   │   ├── ota_download_file2fs_http.c   # 通过http下载文件(放在flash中)
│   │   └── ota_download_http.c           # 通过http下载文件(放在flash中)
│   ├── mcu
│   │   ├── ota_download_uart.c           # 通过串口下载文件
│   │   ├── ota_mcu_ymodem.c              # 通过ymodem协议下载文件(设备是server端)
│   │   └── ota_slaver_upgrade.c          # 子设备下载文件
│   ├── ota_service.c                     # ota初始化函数和主逻辑下载文件
│   ├── transport
│   │   └── ota_transport_mqtt.c          # ota mqtt消息通道
│   └── verify
│       ├── ota_verify_hash.c             # 文件完整性校验,如md5,sha256
│       └── ota_verify_rsa.c              # 非对称加密验签
├── package.yaml                          # ymal编译环境配置文件
├── README.md                             # 说明文档
└── tools
    ├── ota_image_package.py              # 打包压缩文件
    ├── upack_data_file.c                 # js轻应用打包解压文件
    ├── upack_data_file.h
    └── xz                                # xz压缩算法库

依赖组件

  • cjson

  • mbedtls

  • linksdk

  • http

常用配置

系统中相关配置已有默认值,如需修改配置,统一在yaml中def_config节点修改,具体如下:

是否支持使用https方式: 默认0不支持, 如需支持,请修改在yaml中修改CONFIG_HTTP_SECURE配置如下

def_config:
  CONFIG_HTTP_SECURE: 1

API说明

ota_service_init 订阅mqtt topic和系统上报版本,在mqtt连接成功时候调用

ota_service_start 开始执行升级(如从flash中读取url进行升级)

ota_service_register_cb 注册用户升级回调函数

使用示例

组件使用示例相关的代码下载、编译和固件烧录均依赖AliOS Things配套的开发工具 alios-studio ,所以首先需要参考《aos-studio使用说明之搭建开发环境》,下载安装 alios-studio 。待开发环境搭建完成后,可以按照以下步骤进行示例的测试。

步骤1 创建或打开工程

打开已有工程

如果用于测试的案例工程已存在,可参考《aos-studio使用说明之打开工程》打开已有工程。

创建新的工程

组件的示例代码可以通过编译链接到AliOS Things的任意案例(solution)来运行,这里选择ota_demo案例。ota_demo案例相关的源代码下载可参考《aos-studio使用说明之创建工程》

步骤2 添加组件

因为ota_demo案例中已添加了对组件依赖,所以只需确认ota_demo组件的package.yaml中是否已经添加了依赖:

depends:
  - ota: dev_aos

步骤3 下载组件

在已安装了 alios-studio 的开发环境工具栏中,选择Terminal -> New Terminal启动终端,并且默认工作路径为当前工程的workspace,此时在终端命令行中输入:

aos install ota

上述命令执行成功后,组件源码则被下载到了./components/ota路径中。

步骤4 添加示例

示例代码参考solutions/ota_demo/otaappdemo.c,以运行ota_demo为例(更详细的使用流程请参考《HaaS物联网设备OTA解决方案》,示例主要完成如下:

示例代码分成3个主要部分:

1、注册ota回调函数

注册存储模块信息变量,默认支持3个模块

ota_register_module_store(&ctx, g_module_info, 3);

注册云端触发升级时的触发回调函数

ota_register_trigger_msg_cb(&ctx, (void *)ota_upgrade_cb, NULL);

注册状态上报函数

ota_register_report_percent_cb(&ctx, (void )ota_transport_status, (void )&ctx);

设置用户自定义模块信息

ota_set_module_information(&ctx, USER_MODE_NAME, SUBDEV_FILE_PATH, OTA_UPGRADE_CUST);

2、初始化ota模型

ret = ota_service_init(&ctx);

3、上报模块版本号

ota_report_module_version(&ctx, "default", MY_APP_VER);

4、在ota升级主函数中调用ota_service_start执行升级

aos_task_new("ota_demo", (void )ota_service_start, (void )pctx, 1024 * 6);

步骤5 编译固件

在示例代码已经添加至组件的配置文件,并且ota_demo已添加了对该组件的依赖后,就可以编译ota_demo案例来生成固件了,具体编译方法可参考《aos-studio使用说明之编译固件》

步骤6 烧录固件

ota_demo案例的固件生成后,可参考《aos-studio使用说明之烧录固件》来烧录固件。

步骤7 打开串口

固件烧录完成后,可以通过串口查看示例的运行结果,打开串口的具体方法可参考《aos-studio使用说明之查看日志》

当串口终端打开成功后,可在串口中输入help来查看已添加的测试命令。

步骤8 测试示例

CLI命令行输入:

netmgr -t wifi -c wifi_ssid wifi_password # 连接wifi

CLI关键日志:

[  16.497]<D>WIFI_SERVICE NETMGR_WIFI_EVENT_CONNECTED           # wifi连接成功
[  18.804]<D>WIFI_SERVICE NETMGR_DHCP_SUCCESS                   # DHCP完成,获取到IP地址
[  19.306]<I>WIFI_SERVICE [sntp] OK: sec 1616741677 usec 989111 # SNTP完成,获取到最新网络时间

云端执行升级

详细参考《HaaS物联网设备OTA解决方案》

CLI关键日志:

[ 119.366]<I>ota download start upg_flag:0x9669       # 开始ota升级
[ 130.827]<E>ota download complete:0                  # ota升级完成
[ 142.523]<E>ota Download complete, rebooting ret:0.  # ota升级完成并重启