@ray-js/api 1.7.69 → 1.7.71

package/@types/ThirdPartyDeviceKit.d.ts

@@ -0,0 +1,410 @@
+/**
+ * ThirdPartyDeviceKit
+ *
+ * @version 1.0.0-rc.4
+ */
+declare namespace ty.thirdpartydevice {
+  /**
+   * 根据设备id获取设备信息
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function getDeviceInfo(params: {
+    /**
+     * 设备 id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 设备 id
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceId: string
+      /**
+       * 设备名称
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      name: string
+      /**
+       * 设备所示家庭id
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      gId: string
+      /**
+       * 设备所属房间id,没有房间为空
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      rId: string
+      /**
+       * 设备类型： SWITCH("switch"), OUTLET("outlet"), LIGHT("light")
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceType: string
+      /**
+       * 设备连接状态
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      isConnected: boolean
+      /**
+       * 设备 特征列表
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceTraits: DeviceTrait[]
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 控制设备
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function sendCommand(params: {
+    /**
+     * 设备id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /**
+     * 设备功能状态点集合
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpValList: DeviceTraitCommand[]
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: {
+      /**
+       * 设备 id
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceId: string
+      /**
+       * 设备名称
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      name: string
+      /**
+       * 设备所示家庭id
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      gId: string
+      /**
+       * 设备所属房间id,没有房间为空
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      rId: string
+      /**
+       * 设备类型： SWITCH("switch"), OUTLET("outlet"), LIGHT("light")
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceType: string
+      /**
+       * 设备连接状态
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      isConnected: boolean
+      /**
+       * 设备 特征列表
+       * @since ThirdPartyDeviceKit 1.0.0
+       */
+      deviceTraits: DeviceTrait[]
+    }) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 注册设备状态监听
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function registerDeviceInfoChangeListener(params: {
+    /**
+     * 设备 id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 解除注册设备状态监听
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function unregisterDeviceInfoChangeListener(params: {
+    /**
+     * 设备 id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /** 接口调用结束的回调函数（调用成功、失败都会执行） */
+    complete?: () => void
+    /** 接口调用成功的回调函数 */
+    success?: (params: null) => void
+    /** 接口调用失败的回调函数 */
+    fail?: (params: {
+      /** 错误信息 */
+      errorMsg: string
+      /** 错误码 */
+      errorCode: string | number
+      /** 错误扩展 */
+      innerError: {
+        /** 错误扩展码 */
+        errorCode: string | number
+        /** 错误扩展信息 */
+        errorMsg: string
+      }
+    }) => void
+  }): void
+
+  /**
+   * 进入设备面板以后，监听设备在线状态事件
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function onConnectStateChange(
+    listener: (params: onConnectStateChangeBody) => void
+  ): void
+
+  /**
+   * 进入设备面板以后，监听设备在线状态事件
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function offConnectStateChange(
+    listener: (params: onConnectStateChangeBody) => void
+  ): void
+
+  /**
+   * 进入设备面板以后，设备在线状态事件
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function onDeviceTraitInfoChange(
+    listener: (params: onDeviceTraitInfoChangeBody) => void
+  ): void
+
+  /**
+   * 进入设备面板以后，设备在线状态事件
+   * @public
+   * @since ThirdPartyDeviceKit 1.0.0
+   * @platform iOS Android
+   */
+  export function offDeviceTraitInfoChange(
+    listener: (params: onDeviceTraitInfoChangeBody) => void
+  ): void
+
+  /** @since ThirdPartyDeviceKit 1.0.0 */
+  export interface Device {
+    /**
+     * 设备 id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+  }
+
+  /**
+   * 设备特征模型
+   * @since ThirdPartyDeviceKit 1.0.0
+   */
+  export interface DeviceTrait {
+    /**
+     * 设备特征id:参照：文档参考： https://developers.home.google.com/matter/clusters?hl=zh-cn
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    traitId: string
+    /**
+     * 设备特征功能code:目前暂时只支持插座，开关，灯。dpcode 我们定义如下:
+     *  switch:开关
+     *  bright:亮度
+     *  color_hue:色调
+     *  color_saturation:饱和度
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpCode: string
+    /**
+     * 设备特征功能code对应的值
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpValue: string
+    /**
+     * 设备特征功能code对应的值的类型
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    valType: string
+    /**
+     * 设备特征功能code对应的值的最大值
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    maxValue: number
+    /**
+     * 设备特征功能code对应的值的最小值
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    minValue: number
+  }
+
+  /**
+   * 设备信息模型
+   * @since ThirdPartyDeviceKit 1.0.0
+   */
+  export interface DeviceInfoResponse {
+    /**
+     * 设备 id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /**
+     * 设备名称
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    name: string
+    /**
+     * 设备所示家庭id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    gId: string
+    /**
+     * 设备所属房间id,没有房间为空
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    rId: string
+    /**
+     * 设备类型： SWITCH("switch"), OUTLET("outlet"), LIGHT("light")
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceType: string
+    /**
+     * 设备连接状态
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    isConnected: boolean
+    /**
+     * 设备 特征列表
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceTraits: DeviceTrait[]
+  }
+
+  /**
+   * 设备特征控制功能点模型
+   * @since ThirdPartyDeviceKit 1.0.0
+   */
+  export interface DeviceTraitCommand {
+    /**
+     * 设备特征功能code
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpCode: string
+    /**
+     * 设备特征功能code对应变化的值
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpVal: string
+  }
+
+  /**
+   * 设备特征控制模型
+   * @since ThirdPartyDeviceKit 1.0.0
+   */
+  export interface DeviceCommandParam {
+    /**
+     * 设备id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /**
+     * 设备功能状态点集合
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpValList: DeviceTraitCommand[]
+  }
+
+  /** @since ThirdPartyDeviceKit 1.0.0 */
+  export interface onConnectStateChangeBody {
+    /**
+     * 设备id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /**
+     * 设备连接状态
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    isConnected: boolean
+  }
+
+  /** @since ThirdPartyDeviceKit 1.0.0 */
+  export interface onDeviceTraitInfoChangeBody {
+    /**
+     * 设备id
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    deviceId: string
+    /**
+     * 设备特征功能code
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpCode: string
+    /**
+     * 设备特征功能code对应变化的值
+     * @since ThirdPartyDeviceKit 1.0.0
+     */
+    dpVal: string
+  }
+}