IoT 上云框架

概述

IoT API 定义了数据处理及上云接口，规范不同的云平台，采用一致的编程习惯，降低用户使用不同平台的学习成本。

YoC 中 uDATA 是根据物联网的特点，设计成的面对IoT的感知设备处理框架。对数据上云的数据模型进行抽象，隐藏不同云平台协议的差异，消除不同云平台SDK 的差异。

uDATA 框架主要分 IoT 框架和 uDATA 数据模型两层：

• IoT 框架负责完成与云端的数据对接，通过云平台官方提供的 SDK，完成数据的上行与下发。
• uDATA 数据模型，负责数据的采集与反馈处理。系统定时的将外围的传感器数据收集起来，保存在uDATA中，定时通过 IoT 框架将数据模型上传到云平台。云平台下发的数据，通过 IoT 框架的传换，存入到 uDATA 数据模型中，并触发数据更新事件。

应用接口介绍

创建 IoT 上云实例

iot_t *iot_new_oceancon(iot_oceancon_config_t *config);
iot_t *iot_new_onenet(iot_onenet_config_t *config);
iot_t *iot_new_alicoap(iot_alicop_config_t *config);
iot_t *iot_new_alimqtt(iot_alimqtt_config_t *config);

创建IoT上云实例，不同云平台采用不同的创建函数及参数。

• 参数
  • config: 通道配置项，详细见示例代码

• 返回值

  • 创建成功返回IoT对象指针，失败返回NULL

• 示例代码

/* OceanConnet 配置 */
iot_oceancon_config_t config = {
        "coap://180.101.147.115:5683", /* 服务器地址 */
        left_time, /* 同步时间间隔 */
        udata_to_buffer, /* udata到用户数据的转化处理 */
        buffer_to_udata, /* 用户数据到udata的转化处理 */
        50               /* 数据转化的缓冲大小 */
    };
iot_new_oceancon(&config);

/* OneNET 配置 */
iot_onenet_config_t config = {
  .lifetime = left_time /* 同步时间间隔 */
  };
iot_new_onenet(&config);

/* AliCoAP 配置 */
iot_alicoap_config_t cfg = {
    /* 服务器访问地址后缀，括号部分为阿里云三要素(元组)的pruduct key. 
    coaps://[product_key].iot-as-coap.cn-shanghai.aliyuncs.com:1883
    由于SDK固化未提供配置接口，该参数暂时无效
    */
    .server_url_suffix = "iot-as-mqtt.cn-shanghai.aliyuncs.com:1883"
};
iot_new_alicoap(&cfg);

/* AliMQTT 配置 */
iot_alimqtt_config_t cfg = {
    /* 服务器访问地址后缀，括号部分为阿里云三要素(元组)的pruduct key. 
    [product_key].iot-as-coap.cn-shanghai.aliyuncs.com:5684
    */
    .server_url_suffix = "iot-as-coap.cn-shanghai.aliyuncs.com:5684"
};
iot_new_alicoap(&cfg);
`

销毁 IoT 上云实例

int iot_destroy(iot_t *iot);

销毁指定的通道，释放资源

• 参数:
  • iot: IoT对象指针
• 返回值:
  • 0: 销毁成功
  • 小于0：销毁失败

订阅 IoT 事件

#include <yoc/uservice.h>
#include <yoc/eventid.h>
void event_subscribe(uint32_t event_id, event_callback_t cb, void *context);

订阅事件通过回调函数告知事件，iot_event_id 是回调函数的事件， 支持的事件如下：

• 参数:
  • iot: IoT对象指针
  • cb: 事件回调函数
  • arg: 用户参数，回调函数传出
• 返回值:
  • 0: 订阅成功
  • 小于0: 订阅失败

打开通道

iot_channel_t *iot_channel_open(iot_t *iot, const char *ch_arg);

通道实例初始化，每个通道的参数需要看具体的IoT平台

• 参数:
  • iot: IoT对象指针
  • ch_arg: 通道初始化参数
• 返回值:
  • 通道对象指针
  • NULL: 打开失败

启动通道

int iot_channel_start(iot_channel_t *ch);

启动通道，接入云平台

• 参数:
  • ch: 通道对象指针
• 返回值:
  • 0: 成功
  • 小于0: 失败

关闭通道

int iot_channel_close(iot_channel_t *ch);

关闭通道

• 参数:
  • ch: 通道对象指针
• 返回值:
  • 0: 成功
  • 小于0: 失败

配置通道数据处理回调

IoT API以数据节点(key/value)的方式定义了传感器和uData的交互过程， 推送数据时会调用channel_get 回调，用户需要把传感数据同步到uData，API会把更新的数据进行上传； 接收到云端数据，API会自动更新数据，并回调channel_set，用户继续做相应的处理。

typedef void (*channel_set_t)(uData *udata, void *arg);
typedef void (*channel_get_t)(uData *udata, void *arg);
int iot_channel_config(iot_channel_t *ch, channel_set_t set, channel_get_t get, void *arg);

• 参数:
  • ch: 通道对象指针
  • set: channel_set回调函数
  • get: channel_get回调函数
• 返回值:
  • 0: 成功
  • 小于0: 失败

示例代码

static void channel_set(uData *udata, void *arg)
{
    uData *node;
    /* 遍历所有数据节点，使用node->value.updated判断更新的数据 */
    slist_for_each_entry(&udata->head, node, uData, head) {
        if (node->value.updated) {
            if (node->value.type == TYPE_STR) {
                LOGI(TAG, "ch set (%s,%s)", node->key.v_str, node->value.v_str);
            } else {
                LOGI(TAG, "ch set (%s,%d)", node->key.v_str, node->value.v_int);
            }
        }
    }
}

static void channel_get(uData *udata, void *arg)
{
    /* yoc_udata_set 的第三个参数为1，强制更新，会上发数据到云端，为0，判断有变化才上传 */
    yoc_udata_set(udata, value_s("3303/0/5700"), value_i(rand() % 40), 1);
    yoc_udata_set(udata, value_s("3303/0/5701"), value_s("degree"), 0);

    yoc_udata_set(udata, value_s("3311/0/5850"), value_b(rand() % 2), 1);
    yoc_udata_set(udata, value_s("3311/0/5851"), value_i(rand() % 80), 0);
}

推送数据

推送数据到云端，推送前会先触发channel_set回调。

int iot_channel_push(iot_channel_t *ch, uint8_t sync);

• 参数:
  • ch: 通道对象指针
  • sync: 是否为同步推送
• 返回值:
  • 0: 成功
  • 小于0: 失败

原生数据推送

提供通道的原生数据推送接口

int iot_channel_raw_push(iot_channel_t *ch, void *payload, int len);

• 参数:
  • ch: 通道对象指针
  • payload: 数据缓冲
  • len: 数据长度
• 返回值:
  • 0: 成功
  • 小于0: 失败

云端 SDK 对接

IoT 上云框架中已实现“oceancon”、“阿里云coap”、“阿里云mqtt”、"OnetNET"的官方 SDK的对接。

iot_t *iot_new_oceancon(void **config*);
iot_t *iot_new_alicoap(void **config*);
iot_t *iot_new_alimqtt(void **config*);
iot_t *iot_new_onenet(void **config*);

IoT 模型

框架中定义了数据结构 iot_t ，

typedef struct _iot {
    slist_t       udata_list;
    void         *user_cfg;
    void         *ch_cfg_arg; /* iot_channel_config arg */
    iot_ops_t     ops;
    iot_config_t *config; /* iot_channel_config arg */
    aos_mutex_t   ch_mutex;
    void         *priv;
} iot_t;

IoT 数据操作

typedef struct _iot_ops {
    const char *name;
    int (*open)(iot_channel_t *ch);
    int (*start)(iot_channel_t *ch);
    int (*send)(iot_channel_t *ch);
    int (*raw_send)(iot_channel_t *ch, void *payload, int len);
    int (*recv)(iot_channel_t *ch);
    void (*close)(iot_channel_t *ch);
    int (*destroy)(iot_t *iot);
    slist_t udata_list;
} iot_ops_t;

IoT 配置

typedef struct iot_config {
    void *data;
    void (*on_update)(iot_t *iot, uData *udata); /* recv data from cloud, do user action */
    void (*on_read)(iot_t *iot, uData *udata); /* before push data to cloud, user update uData from hardware */
    void (*on_pushed)(iot_t *iot, uData *udata);
    void (*on_push_fail)(iot_t *iot, uData *udata);
    void (*on_connected)(iot_t *iot);
    void (*on_connnect_fail)(iot_t *iot);
    void (*on_disconnect)(iot_t *iot);
} iot_config_t;

定义初始化函数

根据IoT 框架的初始化函数定义规定，格式如下：

iot_t *iot_new_xxxx(void **config*);

其他 xxxx 为云平台的关键字，如阿里云MQTT协议的关键字为 alimqtt。