合作伙伴工作台
注册

平台操作指导

SOTA升级概述及前提条件

天翼物联网平台(AIoT) -通用组件服务(以下简称“平台”)提供了基于LWM2M的固件升级功能,用于模组的固件升级。但是由于多数模组并未提供升级接口给MCU,所以MCU升级只能基于应用层来实现升级,为了避免和模组的升级混淆,我们把MCU的升级称为软件升级。

OTA升级服务除每个租户提供100条免费升级次数外,将需在物联网市场购买升级服务次数,购买地址

操作安全提示:

建议您登录平台之后,通过控制台页面进行远程升级操作。

如通过API进行远程升级操作,将带来一定的安全风险,请慎重使用;并需要在平台相关页面进行申请。

设备安全提示:

升级包下载之后,设备升级前,请对升级包内容进行合法性校验。

请务必使用平台为升级包生成的摘要校验升级包完整性。

前提条件:

  • 目前仅支持LWM2M协议的设备升级

  • 升级包大小5M以内,升级时按软件包中设置值分片,默认500字节

  • 仅支持.zip类型的文件

  • 同一产品下最多创建100个升级包

操作步骤

前提条件:平台对升级的软件有格式要求,厂商需要根据软件包制作规范制作软件包,并上传到平台。

软件包制作

i.准备升级软件包文件

设备厂商自行发布用于设备升级的软件包版本文件。

说明:需要将所有要在升级时传给设备的软件版本文件都打成一个升级文件;软件包文件名称不支持包含中文字符。

制作设备升级版本包:

步骤1 新建文件夹命名为"DM",在DM文件夹下创建设备系统类型文件夹,例如嵌入式设备通常采用"linux",将厂商发布的软件包描述文件"UpgradeDesc.json"文件至于"linux"目录下,参见下图:

UpgradeDesc.json文件字段说明参见下表,文件编码格式为UTF-8无BOM。

字段名称

字段描述

是否必填




specVersion

描述文件版本号,固定值:"1.0"

fileName

软件包文件名,例如:ExamplePackage_V1.0.xx

version

软件包版本号备注:升级协议类型为PCP的设备软件版本号长度不超过16个字节

deviceType

设备类型

manufacturerName

制造商名称

model

产品型号

packageType

软件包必须设置为:"softwarePackage"

protocolType

设备接入协议类型,例如:"CoAP"

date

出包时间,格式为:"yyyy-MM-dd"

description

对软件包的自定义描述

supportSourceVersionList

List\支持用于升级此版本包的设备源版本列表。不配置该字段说明该版本可用于任意源版本进行升级(具体见下表)

versionCheckCode

设备厂商出包时用于版本包校验的校验码说明:该字段有配置的话,在平台通知设备做版本下载时会将该字段作为参数发送给设备,由设备侧自行进行版本校验。发送给设备时会转换成16进制,限制2字符或者4字符。

deviceShard

终端下载软件包的每个分片的大小,单位为byte,如果不设置默认为500byte。大小为32~500之间。

SupportSourceVersion的字段说明

字段名

字段描述

是否必填




swVersion

支持用于升级此版本包的设备源软件版本号。支持通配符配置,*代表匹配任意0~n个字符,?代表匹配单个任意字符


步骤2 在与"DM"同级目录下创建平台类型文件夹,例如"linux",该文件夹名称必须同步骤1中的平台类型文件夹一致,将厂商软件包至于该目录,参见下图

  • UpgradeDesc.json文件模板如下:

    {
    "specVersion": "1.0",
    "fileName": "ExamplePackage_V1.0.xx",
    "packageType": "softwarePackage",
    "version": "V1.0",
    "deviceType": "BikeLock",
    "manufacturerName": "ofo",
    "model": "twx2",
    "protocolType":"CoAP",
    "description":"Test software package",
    "versionCheckCode":"e4",
    "deviceShard":"128",
    "date":"2017-08-11"
    }复制

       

步骤3 选中"DM"和"linux"文件夹,使用winRAR等压缩工具打包成ZIP格式的压缩包package.zip(注意package.zip下不能包含package这层目录,如图8-1-3所示。不能压缩成其他格式例如rar然后在手动修改文件类型为zip)

步骤 4 选中“package.zip”再次使用7-ZIP等压缩工具打包成ZIP格式的压缩包package.zip(注意,这里是将package.zip再次压缩打包,形成双层zip文件包)


ⅱ.平台升级协议

本协议规定设备和天翼物联网平台(AIoT之间的应用层升级协议(简称PCP协议),用于实现设备的升级。更多详情请咨询物联网运营人员。

软件升级操作步骤如下:

第一步:登录天翼物联网平台(AIoT)的控制台>远程升级管理。

选择SOTA升级>升级包管理>创建升级包,将升级包信息上传至云端。

  • 升级包版本名称和升级包版本号需要按格式填写。

  • 需保证升级包大小2M以内。

第二步:选择SOTA升级>创建任务,开始创建升级任务。

第三步:选择SOTA升级>升级设备管理,开始加入待升级设备。包括导入设备、加入升级、一键加入,其中导入设备为异步导入,您可以点击“导入结果查询”模块查看导入任务执行情况,若导入存在部分失败,支持点击操作中“下载”按钮,查看失败原因。

第四步:确认已选择设备。

第五步:选择SOTA升级>开始启动,开始启动升级任务。,若您在升级设备管理中操作“一键加入”“批量导入”设备的操作仍在进行中,系统将提示您“升级设备管理中您进行的一键加入/批量导入操作在进行中,请等待”;若存在部分失败情况,将提示您“升级设备管理中您进行的一键加入/批量导入操作存在部分失败,请确定是否继续启动?”,确定后将对加入成功的设备生成升级任务。

第六步:选择FOTA升级>查看设备升级详情,可以查看设备升级的状态和结果。

任务状态说明:

远程升级管理中产品的固件包、软件包及升级任务的所属机构与产品的所属机构一致,每个用户仅可查看本机构及子机构下的产品、固件包、软件包、升级任务。因此若无法查看别人创建的产品、升级包、升级任务,可联系本租户主账号调整产品的所属机构。

  • 未执行:任务未启动

  • 执行中:正在升级,存在未完成的任务

  • 已完毕:全部升级任务都达到终止状态,升级完成或升级失败


远程升级管理中产品的固件包、软件包及升级任务的所属机构与产品的所属机构一致,每个用户仅可查看本机构及子机构下的产品、固件包、软件包、升级任务。因此若无法查看别人创建的产品、升级包、升级任务,可联系本租户主账号调整产品的所属机构。


这篇文档是否帮助您解决了问题?
如果您愿意进一步帮助我们改进文档 ,请留下您的联系方式。