设备绑定
接口功能
设备第一次接入物联网平台时需要进行绑定操作，上层应用通过调用该接口传入设备序列号或者MAC地址以及设备信息来绑定到物联网平台。
在绑定前需要调用绑定配置接口设置物联网平台的IP与端口。
设备绑定是指设备第一次接入物联网平台的过程，需要开发者先在物联网平台注册直连设备，之后在设备上发起绑定操作，将设备绑定到物联网平台上。如果未在物联网平台注册该设备，则绑定操作会失败，Agent Lite将会等待一段时间继续尝试。
接口描述
1
|
public static boolean bind(String verifyCode, IotaDeviceInfo deviceInfo); |
接口所属类
BindService
参数说明
|
字段 |
必选/可选 |
类型 |
描述 |
|---|---|---|---|
|
verifyCode |
必选 |
String |
设备绑定验证码。
|
|
deviceInfo |
必选 |
设备信息。 |
|
字段 |
必选/可选 |
类型 |
描述 |
|---|---|---|---|
|
nodeId |
必选 |
String |
关键参数，对接平台的网关下设备唯一标识，设备填写，平台用于判重。 |
|
name |
可选 |
String |
设备名称。 |
|
description |
可选 |
String |
设备描述。 |
|
manufacturerId |
必选 |
String |
厂商ID。 |
|
manufacturerName |
可选 |
String |
厂商名。 |
|
mac |
可选 |
String |
设备MAC地址。 |
|
location |
可选 |
String |
设备的位置。 |
|
deviceType |
必选 |
String |
设备类型。 |
|
model |
必选 |
String |
型号。
|
|
swVersion |
可选 |
String |
软件版本。 Z-Wave ：主版本号.次版本号，如：1.1。 |
|
fwVersion |
可选 |
String |
固件版本。 |
|
hwVersion |
可选 |
String |
硬件版本。 |
|
protocolType |
必选 |
String |
协议类型 ：Z-Wave。 |
|
bridgeId |
可选 |
String |
表示设备通过哪个Bridge接入平台。 |
|
status |
可选 |
String |
表示设备是否在线。
|
|
statusDetail |
可选 |
String |
状态详情，如果pcStatus不为空，则该参数必选。 参数值：
|
|
mute |
可选 |
String |
表示设备是否被屏蔽。
|
接口返回值
|
返回值 |
描述 |
|---|---|
|
true |
成功。 |
|
false |
失败。 |
此返回值是调用接口的同步返回结果，返回true只是说明接口调用成功，并不说明绑定成功，绑定成功需要收到BindService.TOPIC_BINDDEVICE_RSP广播。
当前绑定流程的重试策略为：如果绑定失败，则30秒后继续进行重试，如果重试超过5次（总计尝试超过6次），则返回失败，不再进行重试。如果想要重新发起绑定，需要重启设备。
返回结果
|
广播名称 |
广播参数 |
成员 |
描述 |
|---|---|---|---|
|
TOPIC_BINDDEVICE_RSP |
IotaMessage对象 （使用intent.getSerializableExtra(BindService.BIND_BROADCAST_MSG_IE_IOTAMSG)方法获取） |
BIND_IE_RESULT |
绑定结果。 |
|
BIND_IE_DEVICEID |
平台分配的逻辑设备ID。 |
||
|
BIND_IE_DEVICESECRET |
设备接入的鉴权密钥。 |
||
|
BIND_IE_APPID |
开发者应用ID。 |
||
|
BIND_IE_HA_ADDR |
HA服务器地址。 |
||
|
BIND_IE_LVS_ADDR |
LVS服务器地址。 |
BIND_IE_RESULT：
|
枚举项 |
枚举值 |
类型 |
描述 |
|---|---|---|---|
|
BIND_RESULT_SUCCESS |
0 |
NA |
绑定成功。 |
|
BIND_RESULT_DEV_NOT_BIND |
1 |
NA |
未扫码。 |
|
BIND_RESULT_VERIFYCODE_EXPIRED |
2 |
NA |
验证码过期。 |
|
BIND_RESULT_FAILED |
255 |
NA |
其余失败。 |
示例
调用设备绑定接口。
1
|
BindService.bind(new IotaDeviceInfo("nodeId", "manufacturerId", " Gateway", "model", "protocolType")); |
接收设备绑定响应消息。
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
//当设备成功绑定之后，Agent Lite会返回给UI如下几个参数，需要UI进行持久化存储，设备登录前需要提前进行配置 BroadcastReceiver mBindRsp; mBindRsp = new BroadcastReceiver() { @Override public void onReceive(Context context, Intent intent) { //Do Something IotaMessage iotaMsg = (IotaMessage)intent.getSerializableExtra(BindService.BIND_BROADCAST_MSG_IE_IOTAMSG); int result = iotaMsg.getUint(BindService.BIND_IE_RESULT, 0); String deviceId = iotaMsg.getString(BindService.BIND_IE_DEVICEID); String Secret = iotaMsg.getString(BindService.BIND_IE_DEVICESECRET); String Appid = iotaMsg.getString(BindService.BIND_IE_APPID); String haAddr = iotaMsg.getString(BindService.BIND_IE_HA_ADDR); String lvsAddr = iotaMsg.getString(BindService.BIND_IE_LVS_ADDR); return; } }; mLocalBroadcastManager = LocalBroadcastManager.getInstance(this); IntentFilter filterBind = new IntentFilter(BindService.TOPIC_BINDDEVICE_RSP); mLocalBroadcastManager.registerReceiver(mBindRsp, filterBind); |
