文档首页> 设备管理 IoTDM（联通用户专用）> API参考> Agent Lite API参考(C)> 接口列表> 直连设备接入> 设备绑定
更新时间：2022-02-24 GMT+08:00
查看PDF

设备绑定

接口功能

设备第一次接入物联网平台时需要进行绑定操作，上层应用通过调用该接口传入设备序列号或者MAC地址以及设备信息来绑定到物联网平台。

在绑定前需要调用设置业务参数接口设置绑定服务器IP与端口（IoCM服务器地址与端口，Agent Lite会配置默认端口8943），对应参数配置为EN_IOTA_CFG_IOCM_ADDR和EN_IOTA_CFG_IOCM_PORT。

说明：

设备绑定是指设备第一次接入IoT平台的过程，需要开发者先在IoT平台注册直连设备，之后在设备上发起绑定操作，将设备绑定到IoT平台上。如果未在IoT平台注册该设备，则绑定操作会失败，Agent Lite将会等待一段时间继续尝试。

接口描述

1
 
HW_INT IOTA_Bind(const HW_CHAR *pcVerifyCode, const ST_IOTA_DEVICE_INFO *pstInfo);

参数说明

字段

必选/可选

类型

描述

pcVerifyCode

必选

String

设备绑定验证码，pcVerifyCode必须带结束符‘\0’。

  • 如果通过管理门户注册设备，则pcVerifyCode填写为设备注册时设置的preSecret（预置密钥）。
  • 如果通过开发中心注册设备，则pcVerifyCode填写为设备注册时设置的nodeId（设备标识）。

pstInfo

必选

ST_IOTA_DEVICE_INFO 结构体

设备信息，pstInfo结构体中的成员必须带结束符‘\0’。

接口返回值

参见2. 函数标准返回值

说明：
  • 此返回值是调用接口的同步返回结果，返回0只是说明接口调用成功，并不说明绑定成功，绑定成功需要收到IOTA_TOPIC_BIND_RSP广播。
  • 当前绑定流程的重试策略为：如果绑定失败，则30秒后继续进行重试，如果重试超过5次（总计尝试超过6次），则返回失败，不再进行重试。如果想要重新发起绑定，建议让用户重启设备。

返回结果

广播名称

广播参数

成员

描述

IOTA_TOPIC_BIND_RSP

HW_MSG对象

EN_IOTA_BIND_IE_TYPE

绑定返回结果（详见枚举EN_IOTA_BIND_IE_TYPE）。

示例

调用IOTA_Bind()接口进行设备绑定。

1
2
3
4
5
6
7
8
9
 
//开发者调用该接口进行设备绑定 
ST_HW_DEVICE_INFO stDeviceInfo 
stDeviceInfo.pcNodeId = “SN Number”; 
stDeviceInfo.pcManufacturerId = “Huawei”; 
stDeviceInfo.pcDeviceType = “Gateway”; 
stDeviceInfo.pcModel = “HW_GW101”; 
stDeviceInfo.pcProtocolType = “HuaweiM2M”; 

IOTA_Bind(“SN Number”, &stDeviceInfo);

当设备成功绑定之后，Agent Lite会返回给UI如下几个参数，需要UI进行持久化存储，设备登录前需要提前进行配置。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
 
//注册广播接收处理函数 
HW_BroadCastReg(“IOTA_TOPIC_BIND_RSP”, Device_RegResultHandler);
// 开发者注册该函数处理绑定结果 
HW_iNT Device_RegResultHandler(HW_UiNT uiCookie, HW_MSG pstMsg) 
{
    HW_cHAR *pcDeviceId;
    HW_cHAR *pcDeviceSecret;
    HW_cHAR *pcAppId;
    HW_cHAR *pcIoCMServerAddr;
    HW_UiNT uiIoCMServerPort;
    HW_cHAR *pcMqttServerAddr;
    HW_UiNT uiMqttServerPort;
    If (HW_SUCCESS != HW_MsgGetUint(pstMsg, EN_IOTA_BIND_IE_RESULT, 0)) 
    {
        Return 0;
    }
    pcDeviceId = HW_MsgGetStr(pstMsg, EN_IOTA_BIND_IE_DEVICEID);
    pcDeviceSecret = HW_MsgGetStr(pstMsg, EN_IOTA_BIND_IE_DEVICESECRET);
    pcAppId = HW_MsgGetStr(pstMsg, EN_IOTA_BIND_IE_APPID);
    pcIoCMServerAddr = HW_MsgGetStr(pstMsg, EN_IOTA_ BIND_IE_IOCM_ADDR );
    uiIoCMServerPort = HW_MsgGetUint(pstMsg, EN_IOTA_BIND_IE_IOCM_PORT, 0);
    pcMqttServerAddr = HW_MsgGetStr(pstMsg, EN_IOTA_ BIND_IE_IOCM_ADDR );
    uiMqttServerPort = HW_MsgGetUint(pstMsg, EN_IOTA_BIND_IE_IOCM_PORT, 0);
    Config_save(“DeviceId”,pcDeviceId);
    Config_save(“DeviceSecret”,pcDeviceSecret);
    Config_save(“AppId”,pcAppId);
    Config_save(“IoCMAddr”,pcIoCMServerAddr);
    Config_save(“IoCMPort”,pcIoCMServerPort);
    Config_save(“MqttAddr”,pcMqttServerAddr);
    Config_save(“MqttPort”,pcMqttServerPort);
    return 0;
}
父主题： 直连设备接入