简介

阿里云的物联网平台提供安全可靠的设备连接通信能力, 帮助用户将海量设备数据采集上云

设备可通过集成 Link SDK 具备连接物联网平台服务器的能力, 以及进而使用物联网平台的其它高级能力

---

这个SDK以C99编写, 开源发布, 支持多种操作系统和硬件平台, 阅读本文开始使用, 访问SDK的线上文档首页得到更多信息

了解SDK架构

获取SDK内容及用户编程导引

SDK基座: 下载地址

下载SDK基座得到的, 主要含上图中的**SDK核心模块**, 它本身已是完整可用的了, 点击以下链接阅读编程导引开始使用

• MQTT连云能力
• HTTP连云能力
• RRPC
• 在线设备接收广播

  ---

  除此以外, 以上获取的SDK基座上, 还可以由用户选择动态安插, 装备上其它高阶的能力, 点击以下链接阅读编程导引开始使用
• Bootstrap(引导服务)
• OTA(固件升级)
• Data-Model(物模型)
• Dynreg(动态注册)
• NTP(时间同步)
• Shadow(设备影子)
• Logpost(日志上云)
• Devinfo(设备标签)

  ---

  在面向应用的编程导引外, 以上所有组件也提供面向代码的详细手册, SDK的线上手册地址

装备高阶能力

以上高阶能力, 任意两两之间无依赖关系, 仅依赖SDK核心模块(core目录), 用户装备任一种能力的方式都是一致的

• 下载组件压缩包, 每一种高阶能力对应一个组件代码压缩包
• 解压组件压缩包, 放置到 components/xxx 目录

目前已就绪的高阶组件有

高阶组件	组件说明	下载地址
Bootstrap	实时动态的同步国家与地区的建连信息给设备	Bootstrap组件下载链接
OTA	固件升级和远程配置	OTA组件下载链接
Data-Model	使用属性, 事件, 服务构成的物模型描述设备	Data-Model组件下载链接
Dynreg	在设备运行时分配deviceSecret以简化烧录	Dynreg组件下载链接
NTP	基于MQTT协议从云平台获取标准时间	NTP组件下载链接
Shadow	基于MQTT协议获取或更新云端缓存模型	Shadow组件下载链接
Logpost	基于MQTT协议上报设备日志到云端控制台	Logpost组件下载链接
Devinfo	基于MQTT协议上报标签删除或标签更新请求	Devinfo组件下载链接

SDK使用的最佳实践

为直观的了解SDK的移植和使用, 可点击链接访问以下的实际场景中开发文档记录, 参考官方给出的使用者角度最佳实践

移植实例

• 乐鑫ESP8266移植
• 乐鑫ESP32移植
• MCU+TCP模组(SIM800C)移植
• MCU+MQTT模组(N720V5)移植
• Android源码树内移植
• Android源码树外NDK移植

特殊的TLS认证模式

• 基于PSK的TLS连接
• 基于X509的TLS连接

编译方式

**Link SDK完全由高移植性的C语言源文件构成**, 用户应使用惯用的任意编译方式, 将这些C文件(demos目录除外)跟自己的其它源文件编译到一起即可使用它

---

如果用户使用安装有GNU Make的Linux主机开发环境, 可在SDK源码根目录运行

make

编译SDK例程, 编好的例程在output/xxxx_demo, 运行这些例程可快速体验SDK和物联网平台的功能, 编程导引文档中也有例程的运行输出讲解

设计原则

不论是MQTT连云这样放在core的SDK核心模块, 还是固件升级这样放在components/xxx的高阶组件, 一致使用以下的设计原则

• 用户须知的API函数接口和数据结构, 在xxx/aiot_xxx_api.h头文件中列出, 以aiot_xxx_yyy风格命名
• 这些API函数的实现源码, 在xxx/aiot_xxx_api.c中
• 组件能力的使用范例, 在xxx/demos/xxx_{basic,posix}_demo.c中
• 组件的API函数原型, 遵循统一的设计模式
  • aiot_xxx_init(): 初始化1个会话实例, 并设置默认参数
  • aiot_xxx_deinit(): 销毁1个会话实例, 回收其占用资源
  • aiot_xxx_setopt(): 配置1个会话实例的运行参数, 可用参数及用法在编程手册中有指出
  • aiot_xxx_send_yyy(): 向云平台发起某种会话请求
  • aiot_xxx_recv(): 从云平台接收请求的应答
• 组件能力运行时, 对外表达信息的方式, 遵循统一的设计模式
  • API的返回值: 是1个16 bits的非正数整型, 也叫**状态码**, 0表成功, 其它值表达运行状态
    • retval = aiot_xxx_yyy()方式获取返回值
    • 所有返回值唯一对应内部运行分支, 含义详见core/aiot_state_api.h或components/xxx/aiot_xxx_api.h
    • 所有组件的返回值的值域互不重叠, 共同分别分布在0x0000 - 0xFFFF
  • 数据回调函数: 是1个用户实现并传入SDK的回调函数, SDK从外界读取到值得关注的数据报文时, SDK会调用它, 用户可在此处理数据流
    • aiot_xxx_setopt(handle, AIOT_XXXOPT_RECV_HANDLER, user_recv_cb)设置数据回调
  • 事件回调函数: 是1个用户实现并传入SDK的回调函数, SDK内部运行状态发生值得关注的变化时, SDK会调用它, 用户可在此处理控制流
    • aiot_xxx_setopt(handle, AIOT_XXXOPT_EVENT_HANDLER, user_event_cb)设置事件回调
  • 运行日志回调: 是1个用户实现并传入SDK的回调函数, SDK运行时, 详细的运行日志字符串会实时输入到这个回调
    • aiot_state_set_logcb(user_log_cb)设置日志回调
    • 若不想看到SDK运行日志, 回调为空即可
    • 日志格式统一为: [timestamp][LK-XXXX] message
      • XXXX以数字形式标识了日志字符串, 它和返回值共享一个**状态码**分布空间, 都在-0xFFFF ~ 0x0000
      • 利用SDK的高阶组件之一, 时间同步(ntp), 可进行网络对时, 此后日志中的timestamp会自动变成"年月日 时分秒"的易读模式

点此查看详细状态码清单, 比如-0x0305代表MQTT连云时设备鉴权失败