一、背景
Link SDK(原名为Link Kit SDK)是阿里云物联网平台提供的设备端软件开发工具包,可使用尽量少的硬件资源,简化开发过程,实现设备快速接入阿里云物联网平台。目前LinkSDK已经覆盖的开发语言c、node.js、java、python、以及android、ios操作系统。
C LinkSDK 4.x于2020年5月初版上线,作为C LinkSDK的主版本与物联网平台功能同步更新,目前已经迭代近两年。在4.x推出之前,C LinkSDK已经迭代了三个大版本1.x、2.x、3.x,这三版本有一定的继承关系,可实现部分接口兼容。4.x则是完全的新版本,在接口上和之前的版本不再兼容。
为什么要推出新版本4.x呢?从功能及稳定性角度上看,3.x都可以满足使用需求,推出4.x最主要的原因是改善资源开销及易用性问题。IoT设备不同于互联网设备,碎片化问题很严重,为了LinkSDK应用范围广,在3.x提供了多种场景的接入方法及相关功能,从而导致接入硬件资源消耗大,提高了设备门槛;为了给3.x瘦身,我们提供了配置项、代码抽取工具帮助用户裁剪;最后结果就是,3.x发展成功能丰富、配置项多的一个大型IoT工具库,易用性反而下降了,提高了开发者使用门槛。因此,我们决定研发LinkSDK 4.x,以低消耗、易移植、易使用作为设计目标,帮助设备快速轻便的上云。
二、挑战
3.1 碎片化问题处理
问题是客观存在的,IoT设备的碎片化,部分设备资源有限,应用场景差异大。LinkSDK 4.x设计,既要满足多场景快速适配,又要用尽量少的硬件资源,还要满足能力定制化的需求。
IoT设备碎片化
IoT设备品类多,跨度大,有小型的智能开关、中型的音响、大型的机器人; 软件操作系统有RTOS、linux、windows,有些低端设备都没有操作系统;硬件平台架构和主频跨度都很大;跨平台运行能力是一大挑战。
IoT设备资源受限
资源是设备的成本,有些IoT设备为节约成本,只有几十K的rom,捉襟见肘。在IoT领域,大部分设备上使用的是mqtt协议,流行mqtt开源协议栈资源开销基本已大于100K。如何让资源受限设备上云,也是一大挑战。
实现接口易用
很多时候,开发成本也是设备成本的一个大头,做到接口易用也可以降低开发成本。但对于SDK来说,丰富的应用场景,要求SDK一定具有定制能力,可配置能力,如何解决易用且支持定制,也是一大挑战。
三、设计及实现
3.1 碎片化问题处理
- 功能聚焦
LinkSDK经过多年的发展,我们也明白了少即是多的道理,保留主要的功能才能带给大部分用户好的接入体验。所以4.x在功能设计上聚焦设备与物联网平台交互功能,云端一体的能力建设。不再处理与具体环境或具体业务相关内容,如本地通信,本地存储,业务应用。
- 减少依赖
4.x设计只保留必要的系统及网络接口,降低设备使用门槛。
- 互斥锁(可选):保证接口的线程安全,无OS或只会单线程调用LinkSDK可以不实现。
- 时钟:用于计算心跳发送间隔及重发逻辑
- 内存:用于动态内存申请,可以节省内存(RAM)使用
- 随机数:用于建连,增加随机数提高传输安全
- TCP:用于连云时的网络操作
3.2 资源受限问题处理
- 能力原子化,支持裁剪
LinkSDK除核心模块,其它功能封装成独立的组件,组件支持裁剪。在下载是基于可视化裁剪工具,零门槛完成裁剪。裁剪后,若只保留核心模块,可降至30K左右的rom消耗;
- 自建简节尺寸小的基础库
自研实现mqtt协议栈、http协议栈、json解析库,实现资源开销方面业内领先。
- 内存遵循使用时申请原则
SDK实现基本不使用静态变量及全局变量,保证模块独立同时避免不要的内存消耗;
- 提供mcu+模组上云方案
对于一些极端资源受限的设备,提供协议栈跑在模组上的方案,进一步降低连云对mcu资源需求。
3.3 易用性问题处理
3.3.1 下载阶段(定制化):
提供可视化SDK定制下载,用户下载LinkSDK时,可以通过简介快速了解组件功能,仅选择自己需要的功能,避免不必要的资源消耗;
3.3.2 移植阶段:
减少移植接口:
移植抽象目前接口已缩减至15个(4个可选实现),移植难度大幅降低;
常用系统免移植:
提供posix、linux、freertos等常用环境移植实现,用户可直接使用,免移植;
免mbedtls移植:
已基于移植抽象接口完成mbedtls开源库适配,用户不必关心mbedtls移植;
提供AT驱动框架:
对于MCU+通信模组接入方式,基于AT驱动框架可以快速开发模组驱动,用户只需要定义好AT指令格式,AT驱动框架会完成指令协议栈实现,以及完成模组驱动与LinkSDK移植抽象接口的适配工作,使用参考。
提供移植验证工具:
用户移植后,使用移植验证工具验证是否移植成功,使用参考;
3.3.3 开发阶段:
提升api易用性:
提供可视化低代码开发工具:
用户使用物模型进行业务开发时,LinkSDK只提供了基础的属性上报、属性设置、事件上报、服务调用接口。但是具体是什么样的属性、事件、服务处理,需要用户自己处理。可视化低代码开发工具,可以根据不同的产品物模型,自动生成对应物模型的具体代码。
工具入口:控制台-->选择产品-->功能定义-->生成设备端代码。
3.4 LinkSDK 4.x软件主体架构
- 核心组件:最重要的连云部分, 其内容是固定和精简的(因此不存在如何增删), 其接口也是充分丰富和细粒度的
- 上层组件:所有核心之外的能力, 都原子化拆分, 形成相互独立, 相互分离的平级上层组件
- 外部工具: 第三方软件库, 不是SDK的内容, 目前仅有mbedtls
四、使用示例
连接物联网平台需要具备公网连接的能力,根据网络连接的类型,大致可以分为四种接入方式。
直连设备:直连设备自己具备公网IP,直接集成LinkSDK即可完成接入,参考接入说明。
子设备与网关设备:子设备无公网IP,通过局域网与网关通信,由网关代理上云,网关需集成集成LinkSDK,参考接入说明。
MCU+通用模组设备:对于无公网IP的MCU,通过模组的TCP/TLS能力上云,参考接入说明。
MCU+云模组设备:云模组已集成LinkSDK,MCU可通过简单的AT指令完成接入,模组链接。
下面以ubuntu作为虚拟直连设备为例,介绍LinkSDK的使用过程。
- 定制化下载SDK后,解压,进入SDK根目录
├── ChangeLog.md
├── components /* 高级组件 */
├── core /* 核心模块 */
├── demos /* demo集合 */
├── external
├── LICENSE
├── Makefile
├── NOTICE
└── portfiles /* 移植接口实现,linux/posxi下载时已适配好 */
- 选择一个demo,此处以mqtt的基础功能demo为例,演示demo使用。
打开demo源码(./demos/mqtt_basic_demo.c),修改设备的认证信息及接入点信息,保存。
/* TODO: 替换为自己设备的三元组 */
char *product_key = "${YourProductKey}";
char *device_name = "${YourDeviceName}";
char *device_secret = "${YourDeviceSecret}";
/* TODO: 替换为自己实例的接入点 */
char *mqtt_host = "${YourInstanceId}.mqtt.iothub.aliyuncs.com";
- 编译make,结束后查看输出文件output/
output/
├── include /* LinkSDK输出头文件 */
├── lib /* LinkSDK输出库文件 */
├── mqtt-basic-demo /* mqtt基础功能demo */
├── ***-***-demo /* 其它demo */
- 运行demo,./output/mqtt-basic-demo,demo会自动完成建连及消息收发,流程如下。
- 探索体验更多功能,可以先查看功能列表,再从demos都能找到对应的demo体验。
五、功能列表
5.1 核心模块
核心组件 |
功能 |
功能说明 |
设备接入 (单选) |
MQTT上云(推荐) |
设备通过MQTT协议接入到物联网平台 |
HTTPS上云 |
设备通过HTTPS协议接入到物联网平台 |
|
设备认证 (单选) |
一机一密认证 |
每个设备使用独立的认证信息,固化至设备,设备使用该认证信息连接云云平台。 |
一型一密认证 (动态注册) |
同一个产品的设备使用一套相同产品认证信息,烧写至设备。设备在第一次连接云时,基于产品认证信息获取设备认证信息,往后使用设备认证信息连云。 |
|
X509认证 |
每个设备拥有单独的X509证书,连接时进行双向认证,提高安全等级。 |
|
设备消息 (多选) |
自定义消息 |
用户业务消息自定义,基于自定义消息进行通信,也可基于物模型定义(推荐)。 |
系统消息 |
部分通用的功能物联网已定义好,并已在SDK实现对应功能,封装成高级组件,具体功能可参考高级组件。 |
|
RRPC消息 |
一套请求和响应的同步机制,下行调用可以得到同步回复。 |
|
广播消息 |
向指定产品下的全量设备(设备无需订阅广播Topic),或订阅了指定Topic的所有设备发送消息。 |
5.2 高级组件
高级组件 |
功能 |
功能说明 |
高级组件 (多选) |
远程升级(OTA) |
给设备提供OTA升级服务。 |
物模型 |
物模型是阿里云物联网平台为产品定义的数据模型,实现设备上报属性和事件,以及物联网平台到设备的属性设置及服务调用命令。 |
|
文件上传 |
支持设备上传文件至物联网平台或者用户自己的文件存储空间OSS。 |
|
设备分发 |
设备分发实现设备跨地域、跨实例或跨账号的分发,设备可在不同地域,向物联网平台请求需要接入的域名和端口。 |
|
设备标签 |
为设备添加自定义标签,以便灵活管理设备。 |
|
安全隧道(远程登录) |
通过安全隧道功能,可以远程访问、远程诊断和管理设备 |
|
日志上报 |
将设备的运行日志上传至物联网平台,可在控制台查看。 |
|
设备影子 |
用于缓存设备上报的状态和下发的指令(弱网场景)。 |
|
远程配置 |
支持远程下发设备的配置文件。 |
|
网关与子设备 |
网关设备代理不具有IP的子设备连接上物联网平台。 |
|
时间同步 |
为设备提供网络时间同步的能力。 |
六、结束语
LinkSDK 4.x设计原则遵循低消耗、易移植、易使用,支持细粒度的功能裁剪,主要满足中小型的嵌入式设备的使用需求。对于一些中大型的设备,如IPC、机器人、网关等,它们对资源不那么敏感,大多也使用linux系统,不需要移植。往往对功能丰富性、易用性、性能有要求。对此,我们也在研发针对中大型设备使用的LinkSDK 5.x,进一步提高接口的易用性,功能的丰富性,以及更高的性能,或将于下半年发布,尽情期待。