子设备管理 - 设备接入Link SDK

本节内容将结合src/dev_model/examples/linkkit_example_gateway.c为例讲解网关产品的编程方法。

背景信息


名词	说明
网关	能够直接连接物联网平台的设备，且具有子设备管理功能，能够代理子设备连接云端。
子设备	本质上也是设备。子设备不能直接连接物联网平台，只能通过网关连接。
设备ID	Device ID，也就是设备句柄，在网关场景中用于标识一个具体的设备，调用`IOT_Linkkit_Open`时返回。
拓扑关系	子设备和网关的关联关系为拓扑关系，子设备与网关建立拓扑关系后，便可以复用网关的物理通道进行数据通信。
子设备动态注册	子设备在注册时只需将productKey和deviceName上报给网关，网关代替子设备向云端发起身份认证并获取云端返回的deviceSecret用之后的上线操作。

管理子设备

网关与云端建连。

网关的建连过程与单品直连设备的建连过程完全一致。

调用IOT_RegisterCallback注册必要的回调处理函数，如连接事件处理，设备连云初始化完成处理，属性设置事件处理等回调函数。子设备和网关共用一组回调处理函数，以参数DeviceID来区分不同的设备。

    IOT_RegisterCallback(ITE_CONNECT_SUCC, user_connected_event_handler);
    IOT_RegisterCallback(ITE_DISCONNECTED, user_disconnected_event_handler);
    IOT_RegisterCallback(ITE_PROPERTY_SET, user_property_set_event_handler);
    IOT_RegisterCallback(ITE_REPORT_REPLY, user_report_reply_event_handler);
    IOT_RegisterCallback(ITE_TIMESTAMP_REPLY, user_timestamp_reply_event_handler);
    IOT_RegisterCallback(ITE_INITIALIZE_COMPLETED, user_initialized);
    IOT_RegisterCallback(ITE_PERMIT_JOIN, user_permit_join_event_handler);

调用IOT_Ioctl进行必要的配置，如选择服务器站点，选择是否使用一型一密等等。

    /* Choose Login Server */
    int domain_type = IOTX_CLOUD_REGION_SHANGHAI;
    IOT_Ioctl(IOTX_IOCTL_SET_DOMAIN, (void *)&domain_type);

    /* Choose Login Method */
    int dynamic_register = 0;
    IOT_Ioctl(IOTX_IOCTL_SET_DYNAMIC_REGISTER, (void *)&dynamic_register);

使用IOTX_LINKKIT_DEV_TYPE_MASTER参数调用IOT_Linkkit_Open初始化主设备资源。

    iotx_linkkit_dev_meta_info_t master_meta_info;

    memset(&master_meta_info, 0, sizeof(iotx_linkkit_dev_meta_info_t));
    memcpy(master_meta_info.product_key, PRODUCT_KEY, strlen(PRODUCT_KEY));
    memcpy(master_meta_info.product_secret, PRODUCT_SECRET, strlen(PRODUCT_SECRET));
    memcpy(master_meta_info.device_name, DEVICE_NAME, strlen(DEVICE_NAME));
    memcpy(master_meta_info.device_secret, DEVICE_SECRET, strlen(DEVICE_SECRET));

    /* Create Master Device Resources */
    user_example_ctx->master_devid = IOT_Linkkit_Open(IOTX_LINKKIT_DEV_TYPE_MASTER, &master_meta_info);
    if (user_example_ctx->master_devid < 0) {
        EXAMPLE_TRACE("IOT_Linkkit_Open Failed\n");
        return -1;
    }

同样使用IOTX_LINKKIT_DEV_TYPE_MASTER参数调用IOT_Linkkit_Connect与云端建立连接。

    /* Start Connect Aliyun Server */
    res = IOT_Linkkit_Connect(user_example_ctx->master_devid);
    if (res < 0) {
        EXAMPLE_TRACE("IOT_Linkkit_Connect Failed\n");
        return -1;
    }

在ITE_INITIALIZE_COMPLETED事件处理函数中确认网关连云初始化完成后，便可以进行下一步添加子设备的操作。

说明不要在步骤1中注册的回调函数中进行会阻塞线程操作，如调用IOT_Linkkit_Connect进行子设备建连，调用IOT_Linkkit_Report进行子设备上下线等。

添加子设备。
添加子设备主要由4个步骤完成。
1. 使用IOTX_LINKKIT_DEV_TYPE_SLAVE参数调用IOT_Linkkit_Open初始化子设备资源。
  
  说明如果需要使用动态注册，只需要将设备信息参数的device_secret配置为空字符串即可。启用动态注册功能需要把子设备的DeviceName事先在物联网控制台预注册。
2. 调用IOT_Linkkit_Connect将子设备连上云端，这个接口为同步接口，会自动完成子设备注册和拓扑关系的添加。
3. 使用ITM_MSG_LOGIN参数调用IOT_Linkkit_Report完成子设备上线操作。
4. 在ITE_INITIALIZE_COMPLETED事件处理函数中确认对应的子设备连云初始化完成后，便可以进行子设备与云端的数据交互了。
```
int example_add_subdev(iotx_linkkit_dev_meta_info_t *meta_info)
{
    int res = 0, devid = -1;
    devid = IOT_Linkkit_Open(IOTX_LINKKIT_DEV_TYPE_SLAVE, meta_info);
    if (devid == FAIL_RETURN) {
        EXAMPLE_TRACE("subdev open Failed\n");
        return FAIL_RETURN;
    }
    EXAMPLE_TRACE("subdev open susseed, devid = %d\n", devid);

    res = IOT_Linkkit_Connect(devid);
    if (res == FAIL_RETURN) {
        EXAMPLE_TRACE("subdev connect Failed\n");
        return res;
    }
    EXAMPLE_TRACE("subdev connect success: devid = %d\n", devid);

    res = IOT_Linkkit_Report(devid, ITM_MSG_LOGIN, NULL, 0);
    if (res == FAIL_RETURN) {
        EXAMPLE_TRACE("subdev login Failed\n");
        return res;
    }
    EXAMPLE_TRACE("subdev login success: devid = %d\n", devid);
    return res;
}
                                
```
注意使用相同ProductKey, DeviceName重复调用IOT_Linkkit_Open初始化子设备资源，将返回相同的devid，SDK不会重复创建子设备资源。因此，在子设备创建成功后，用户可通过重复调用IOT_Linkkit_Open来查询ProductKey, DeviceName对应的子设备devid。

子设备管理相关操作。

子设备登出。

使用ITM_MSG_LOGOUT选项调用IOT_Linkkit_Report即可完成子设备登出。子设备登出功能主要用于通知云端控制台设备处于离线状态。

    res = IOT_Linkkit_Report(devid, ITM_MSG_LOGOUT, NULL, 0);
    if (res == FAIL_RETURN) {
        EXAMPLE_TRACE("subdev logout Failed\n");
        return res;
    }
    EXAMPLE_TRACE("subdev logout success: devid = %d\n", devid);

获取子设备列表。
网关可以用ITM_MSG_QUERY_TOPOLIST选项来调用IOT_Linkkit_Query以获取与其存在拓扑关系的所有子设备信息。列表信息将在ITE_TOPOLIST_REPLY事件回调中返回。
删除子设备拓扑关系。
用户可以用ITM_MSG_DELETE_TOPO选项调用IOT_Linkkit_Report以删除参数devid指定的子设备拓扑关系，执行该命令后云端不会再将该子设备与本网关进行关联。

子设备OTA。

用户使用IOT_Ioctl配置要升级的子设备，再用IOT_Linkkit_Query来触发子设备升级。

调用IOT_RegisterCallback注册固件升级所用的回调函数user_fota_event_handler。

IOT_RegisterCallback(ITE_FOTA, user_fota_event_handler);
IOT_RegisterCallback(ITE_INITIALIZE_COMPLETED, user_initialized);

使用IOTX_LINKKIT_DEV_TYPE_MASTER参数调用IOT_Linkkit_Open初始化主设备资源。

iotx_linkkit_dev_meta_info_t master_meta_info;

memset(&master_meta_info, 0, sizeof(iotx_linkkit_dev_meta_info_t));
memcpy(master_meta_info.product_key, PRODUCT_KEY, strlen(PRODUCT_KEY));
memcpy(master_meta_info.product_secret, PRODUCT_SECRET, strlen(PRODUCT_SECRET));
memcpy(master_meta_info.device_name, DEVICE_NAME, strlen(DEVICE_NAME));
memcpy(master_meta_info.device_secret, DEVICE_SECRET, strlen(DEVICE_SECRET));

/* Create Master Device Resources */
user_example_ctx->master_devid = IOT_Linkkit_Open(IOTX_LINKKIT_DEV_TYPE_MASTER, &master_meta_info); 
if (user_example_ctx->master_devid < 0) {
    EXAMPLE_TRACE("IOT_Linkkit_Open Failed\n");
    return -1;
}

调用IOT_Linkkit_Connect与云端建立连接。

/* Start Connect Aliyun Server */
res = IOT_Linkkit_Connect(user_example_ctx->master_devid);
if (res < 0) {
    EXAMPLE_TRACE("IOT_Linkkit_Connect Failed\n");
    return -1;
}

添加子设备，进行子设备OTA。

/* Add subdev */
while (user_example_ctx->subdev_index < EXAMPLE_SUBDEV_ADD_NUM) {
    if (user_example_ctx->master_initialized && user_example_ctx->subdev_index >= 0 &&
        (0 == current_ota_running) && (user_example_ctx->auto_add_subdev == 1 || user_example_ctx->permit_join != 0)) {
        /* Add next subdev */
        if (example_add_subdev((iotx_linkkit_dev_meta_info_t *)&subdevArr[user_example_ctx->subdev_index]) == SUCCESS_RETURN) {
            EXAMPLE_TRACE("subdev %s add succeed", subdevArr[user_example_ctx->subdev_index].device_name);
        } else {
            EXAMPLE_TRACE("subdev %s add failed", subdevArr[user_example_ctx->subdev_index].device_name);
        }
        user_example_ctx->subdev_index++;
        user_example_ctx->permit_join = 0;
        /* check each sub dev has remote ota message */
        do_subdev_ota(user_example_ctx->subdev_index);
        /* wait remote ota message */
        HAL_SleepMs(10000);
    }
}

do_subdev_ota函数详解。

用户通过IOT_Ioctl这个接口来切换OTA通道为某个子设备（以devid区分_使用。切换后，只有这个子设备的升级消息能够被接收到。同时通过IOT_Linkkit_Query接口向云端查询是否有适合当前子设备的固件版本信息，如果有则走入OTA流程（触发用户自定义的OTA回调函数user_fota_event_handler）。

void do_subdev_ota(int devid)
{
    if (status_list[devid] == SUB_OTA_SUCCESS) {
        HAL_Printf("current devid is %d, its has checked remote ota message, skip\n", devid);
        return;
    }

    if (current_ota_running == 1) {
        return;
    }

    HAL_Printf("current devid running ota is %d\n", devid);
    int ota_result = 0;
    ota_result = IOT_Ioctl(IOTX_IOCTL_SET_OTA_DEV_ID, (void *)(&devid));
    if (0 != ota_result) {
        status_list[devid] = SUB_OTA_FAILED_SET_DEV_ID;
        HAL_Printf("IOTX_IOCTL_SET_OTA_DEV_ID failed, id is %d\n", devid);
        return;
    }
    ota_result = IOT_Linkkit_Query(devid, ITM_MSG_REQUEST_FOTA_IMAGE, (unsigned char *)current_subdev_version,
                                   strlen(current_subdev_version));
    HAL_Printf("current devid is %d, ITM_MSG_REQUEST_FOTA_IMAGE ret is %d\n", devid, ota_result);
    if (0 != ota_result) {
        status_list[devid] = SUB_OTA_FAILED_QUERY;
        return;
    }
    status_list[devid] = SUB_OTA_SUCCESS;
}

子设备数据交互。
子设备与云端的数据交互方法与单品产品完全一致，详情可查看物模型编程章节。
- 调用IOT_Linkkit_Report上报属性，上报透传数据，更新设备标签信息，删除设备标签信息。
- 调用IOT_Linkkit_TriggerEvent进行Event的主动上报。
- 在ITE_RAWDATA_ARRIVED事件回调中接收云端下发的透传数据。
- 在ITE_SERVICE_REQUST事件回调中接收服务请求（同步服务和异步服务）。
- 在ITE_PROPERTY_SET事件回调中处理云端下发的属性设置。
- 在ITE_PROPERTY_GET事件回调中处理本地通信下发的属性获取

注意事项

网关设备必须支持多线程，并使用独立线程用于执行IOT_Linkkit_Yield。

 void *user_dispatch_yield(void *args) 
 {
     while (1){
         IOT_Linkkit_Yield(USER_EXAMPLE_YIELD_TIMEOUT_MS);
     }

     return NULL;
 }

 res = HAL_ThreadCreate(&g_user_dispatch_thread, user_dispatch_yield, NULL, NULL, NULL);
 if (res < 0) {
     EXAMPLE_TRACE("HAL_ThreadCreate Failed\n");
     IOT_Linkkit_Close(user_example_ctx->master_devid);
     return -1;
 }

对接智能生活开放平台时，只有在收到云端下发的ITE_PERMIT_JOIN事件后，才可以执行子设备添加流程。
当用户通过App扫码发起子设备添加时，App将会向云端发送PermitJoin命令，之后云端会将该命令转发给网关。ITE_PERMIT_JOIN事件会下发子设备的productKey和允许子设备接入的时间窗口timeoutSec（一般为60秒），厂商可在此窗口时间内去执行子设备的发现和绑定，并执行添加子设备流程上报云端，上报成功后便可以在App界面查看到添加的子设备。此功能让子设备的添加被有效的管控起来，只有在窗口时间内才可以添加子设备int user_permit_join_event_handler(const char product_key, const int time){ user_example_ctx_t user_example_ctx = user_example_get_ctx();。
```
EXAMPLE_TRACE(“Product Key: %s, Time: %d”, product_key, time);
user_example_ctx->permit_join = 1;
return 0;
}
```
```
在SDK主目录的make.setting文件中添加FEATURE_DEVICE_MODEL_GATEWAY=y，再运行make命令即可编译出网关例程。

网关相关API


函数名	说明
IOT_Linkkit_Open	创建本地资源，在进行网络报文交互之前，必须先调用此接口，得到一个会话的句柄。
IOT_Linkkit_Connect	对主设备/网关来说，将会建立设备与云端的通信。对于子设备来说，将向云端注册该子设备（若需要），并添加主子设备拓扑关系。
IOT_Linkkit_Yield	若SDK占有独立线程，该函数内容为空，否则表示将CPU交给SDK让其接收网络报文并将消息分发到用户的回调函数中。
IOT_Linkkit_Close	若入参中的会话句柄为主设备/网关，则关闭网络连接并释放SDK为该会话所占用的所有资源。
IOT_Linkkit_Report	向云端发送没有云端业务数据下发的上行报文，包括属性值/设备标签/二进制透传数据/子设备管理等各种报文。
IOT_Linkkit_Query	向云端发送存在云端业务数据下发的查询报文，包括OTA状态查询/OTA固件下载/子设备拓扑查询/NTP时间查询等各种报文。
IOT_Linkkit_TriggerEvent	向云端发送事件报文、如错误码、异常告警等。


其他通用函数名	说明
IOT_Ioctl	设置SDK运行时的可配置选项
IOT_RegisterCallback	注册事件回调函数