【小程序】API能力集成指南——子设备API汇总（二）_设备能力api接口对接快速引导,可根据不同的设备类型查找对应设备能力合集。-优快云博客

本文介绍了DeviceKit库中关于网关子设备DP信息更新、设备信息变化以及事件监听的管理方法，包括onSubDeviceInfoUpdate,offSubDeviceDpUpdate,onSubDeviceRemoved和取消监听函数，适用于3.1.2及以上版本。

ty.device.offSubDeviceDpUpdate

取消监听：网关子设备 DP 信息变化事件

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

参数

function callback

取消监听：网关子设备 DP 信息变化事件的回调函数

回调参数 Object res

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

函数定义示例

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

ty.device.onSubDeviceInfoUpdate

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

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

参数

function callback

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

回调参数 Object res

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

函数定义示例

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

👉 立即开发。

ty.device.offSubDeviceInfoUpdate

取消监听：网关子设备信息变化的事件

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

参数

function callback

取消监听：网关子设备信息变化的事件的回调函数

回调参数 Object res

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

函数定义示例

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

ty.device.onSubDeviceRemoved

网关子设备被移除事件

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

参数

function callback

网关子设备被移除事件的回调函数

回调参数 Object res

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

函数定义示例

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

ty.device.offSubDeviceRemoved

取消监听：网关子设备被移除事件

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

参数

function callback

取消监听：网关子设备被移除事件的回调函数

回调参数 Object res

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

函数定义示例

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

ty.device.registerGateWaySubDeviceListener

注册网关子设备监听器

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

参数

Object object

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

函数定义示例

/**
 * 注册网关子设备监听器
 */
export function registerGateWaySubDeviceListener(params: {
  /**
   * deviceId：设备 ID
   * 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 id 来进行获取
   */
  deviceId: string;
  /** dps：科学变化的数据 */
  dps?: Record<string, {}>;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

ty.device.unregisterGateWaySubDeviceListener

注销网关子设备监听器

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

参数

Object object

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

函数定义示例

/**
 * 注销网关子设备监听器
 */
export function unregisterGateWaySubDeviceListener(params: {
  /**
   * deviceId：设备 ID
   * 支持跨面板获取其他的设备信息，当前面板可以传当前设备的 ID 来进行获取
   */
  deviceId: string;
  /** dps：科学变化的数据 */
  dps?: Record<string, {}>;
  /** 接口调用结束的回调函数（调用成功、失败都会执行） */
  complete?: () => void;
  /** 接口调用成功的回调函数 */
  success?: (params: null) => void;
  /** 接口调用失败的回调函数 */
  fail?: (params: {
    errorMsg: string;
    errorCode: string | number;
    innerError: {
      errorCode: string | number;
      errorMsg: string;
    };
  }) => void;
}): void;

👉 立即开发。