简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

子设备配网

更新时间:2022-01-07 07:03:32下载pdf

描述

子设备配网需要网关设备云在线的情况下才能发起,且子设备处于配网状态。

配网相关的接口封装在 TYDeviceRegistrationManager 中,请先初始化一个实例:let manager = TYDeviceRegistrationManager()

获取资产下的网关列表

在执行子设备配网操作之前,SDK 需要先获取资产下的网关列表:queryRegistrationGateways(in: completionHandle: )

参数说明

参数名 类型 是否必填 说明
assetID String true 资产 ID

TYGateway 说明

参数名 类型 说明
id String 设备 ID
name String 设备名称
isOnline Bool 设备在线状态
category String 品类

代码示例

manager.queryRegistrationGateways(in: "assetID") { (gatewayList, error) in
    guard error == nil else {
        print(error?.localizedDescription)
        return
    }

    // 处理获取的网关列表
}

使网关进入搜寻子设备状态

discoverSubDevices(gatewayDeviceID: duration: completionHandle: )

参数说明

参数名 类型 是否必填 说明
gatewayDeviceID String true 网关设备 ID
duration Int false 网关搜寻子设备的时长,取值范围为 0~3600 秒,默认值为 100 秒

返回示例

参数名 类型 说明
result Bool true:开启成功

获取网关新入网的子设备列表

querySubDeviceRegistrationResult(gatewayDeviceID: discoveryTime: completionHandle:)

参数说明

参数名 类型 是否必填 说明
gatewayDeviceID String true 网关设备 ID
discoveryTime TimeInterval true 网关发现子设备时间,精确到秒

TYPairedSubDevice 说明

参数名 类型 说明
id String 设备 ID
name String 设备名称
isOnline Boolean 设备在线状态
activeTime String 激活时间
updateTime String 设备状态更新时间
productID String 设备所属产品 ID
category String 品类
nodeID String 子设备 nodeId
assetId String 资产 ID
icon String 设备图标

代码示例

manager.querySubDeviceRegistrationResult(gatewayDeviceID: "gatewayDeviceID") { (subDeviceList, error) in
    guard error == nil else {
        print(error?.localizedDescription)
        return
    }

    // 处理获取的子设备列表
}

设备配网属于异步过程。设备配网的耗时取决于网络质量。您必须调用 API 来检查设备配网结果。当系统返回配网设备列表或配网任务超时后,轮询任务停止。

建议轮询任务设置为每隔 1 秒运行一次。配对任务的超时值建议设置为 100 秒。