【小程序】API能力集成指南——子设备API汇总（一）

ty.device.getSubDeviceInfoList

获取子设备信息

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
meshId	string		是	网关设备 id 或上级节点 id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 

ty.device.offSubDeviceInfoUpdateEvent

取消监听：子设备配网结果事件

需引入DeviceKit，且在>=2.1.6版本才可使用

参数

function callback

取消监听：子设备配网结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
gwId	string		是	网关模型 gwId 网关设备 Id

 👉 立即开发。 

ty.device.onSubDeviceInfoUpdateEvent

子设备配网结果事件

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

function callback

子设备配网结果事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	设备模型 deviceId 设备 Id
gwId	string		是	网关模型 gwId 网关设备 Id

ty.device.registerZigbeeGateWaySubDeviceListener

注册 Zigbee 网关子设备监听器

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId 设备 id 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	any		否	dps
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 

ty.device.unregisterZigbeeGateWaySubDeviceListener

注销 Zigbee 网关子设备监听器

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId 设备 id 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	any		否	dps
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 

ty.device.startGWActivation

使网关进入配网模式，对其子设备进行配网

调用此 API 后，网关设备会进入配网模式，网关自动扫描附近可配网子设备，若扫描到设备，则自动将设备配网并关联到网关。

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
gateway	Gateway		是	网关子设备激活数据 gateway Gateway 网关模型
timeout	number		是	timeout 超时时间设定（秒），建议值 120
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

Gateway

属性	类型	默认值	必填	说明
gwId	string		是	网关模型 gwId 网关设备 Id

 

ty.device.stopGWActivation

停止网关的配网模式

与 startGWActivation 成对调用，调用此 API后，网关会停止扫描子设备并退出配网模式。

需引入DeviceKit，且在>=1.2.6版本才可使用

参数

Object object

属性	类型	默认值	必填	说明
gwId	string		是	网关模型 gwId 网关设备 Id
complete	function		否	接口调用结束的回调函数（调用成功、失败都会执行）
success	function		否	接口调用成功的回调函数
fail	function		否	接口调用失败的回调函数

 

ty.device.onSubDeviceAdded

网关添加子设备的事件

需引入 DeviceKit，且在 >=3.1.2 版本才可使用。

参数

function callback

网关添加子设备的事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId：设备 ID。支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	object		否	dps：科学变化的数据

函数定义示例

/**
 * 网关添加子设备的事件
 */
export function onSubDeviceAdded(
  listener: (params: {
    /**
     * deviceId：设备 ID
     * 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 ID 来进行获取
     */
    deviceId: string;
    /** dps：科学变化的数据 */
    dps?: Record<string, {}>;
  }) => void,
): void;

ty.device.offSubDeviceAdded

取消监听：网关添加子设备的事件

需引入 DeviceKit，且在 >=3.1.2 版本才可使用。

参数

function callback

取消监听：网关添加子设备的事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId：设备 ID。支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	object		否	dps：科学变化的数据

函数定义示例

/**
 * 取消监听：网关添加子设备的事件
 */
export function offSubDeviceAdded(
  listener: (params: {
    /**
     * deviceId 设备 ID
     * 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 ID 来进行获取
     */
    deviceId: string;
    /** dps：科学变化的数据 */
    dps?: Record<string, {}>;
  }) => void,
): void;

 

ty.device.onSubDeviceDpUpdate

网关子设备 dp 信息变化事件

需引入 DeviceKit，且在 >=3.1.2 版本才可使用。

参数

function callback

网关子设备 DP 信息变化事件的回调函数

回调参数 Object res

属性	类型	默认值	必填	说明
deviceId	string		是	deviceId：设备 ID。支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
dps	object		否	dps：科学变化的数据

函数定义示例

/**
 * 网关子设备 DP 信息变化事件
 */
export function onSubDeviceDpUpdate(
  listener: (params: {
    /**
     * deviceId：设备 ID
     * 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 ID 来进行获取
     */
    deviceId: string;
    /** dps：科学变化的数据 */
    dps?: Record<string, {}>;
  }) => void,
): void;

👉 立即开发。