@ray-js/api 1.7.79 → 1.7.80

package/lib/cloud/interface.d.ts

@@ -68,26 +68,80 @@ export interface Automation {
     uid: string;
 }
 export interface AlarmList {
+    /**
+     * 审核状态
+     */
     auditStatus: number;
+    /**
+     * 是否被场景面板绑定
+     */
     boundForPanel: boolean;
+    /**
+     * 是否被 WIFI 场景面板绑定
+     */
     boundForWiFiPanel: boolean;
+    /**
+     * 是否启用
+     */
     enabled: boolean;
+    /**
+     * 多语言数据体
+     */
     i18nData: {
+        /**
+         * 名称
+         */
         name: {
+            /**
+             * 英文名称
+             */
             en: string;
+            /**
+             * 中文名称
+             */
             zh: string;
         };
+        /**
+         * 内容
+         */
         content: {
+            /**
+             * 英文内容
+             */
             en: string;
+            /**
+             * 中文内容
+             */
             zh: string;
         };
     };
+    /**
+     * 规则 ID
+     */
     id: string;
+    /**
+     * 是否为 IoT 自动告警
+     */
     iotAutoAlarm: boolean;
+    /**
+     * 是否为逻辑规则
+     */
     isLogicRule: boolean;
+    /**
+     * 是否为本地联动
+     */
     localLinkage: boolean;
+    /**
+     * 规则名称
+     */
     name: string;
+    /**
+     * 是否为 APP 管控本地联动
+     */
     newLocalScene: boolean;
+    /**
+     * 场景是否显示在首页
+     */
     stickyOnTop: boolean;
 }
 export interface ISelectedScene {
@@ -446,6 +500,10 @@ export interface IUpdateAstronomicalStatus {
      */
     status: number;
 }
+export interface IRemoveAstronomicalParams {
+    /** 天文定时 ID */
+    id: string;
+}
 export interface IUpdateBillConfigure {
     devId: string;
     unit: number;
@@ -550,11 +608,23 @@ export interface IUpdateGroupDpName {
      */
     name: string;
 }
+/**
+ * 获取天气及空气质量请求参数
+ */
 export interface IGetWeatherQuality {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * 是否查询本地天气
+     */
     isLocal: boolean;
 }
 export interface IGetWeatherQualityResponse {
+    /**
+     * 城市列表
+     * */
     c: Array<{
         /**
          * 城市名称
@@ -565,6 +635,9 @@ export interface IGetWeatherQualityResponse {
          */
         id: number;
     }>;
+    /**
+     * 天气及空气质量信息
+     */
     w: Array<{
         /**
          * 风向
@@ -664,11 +737,23 @@ export interface IGetWeatherQualityResponse {
         sunRiseTimestamp: number;
     }>;
 }
+/**
+ * 获取天气预报请求参数
+ */
 export interface IGetWeathers {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * 预报天数（默认值为 7，最大可预报天数为 7）
+     */
     dataRange?: number;
 }
 export interface IGetWeathersResponse {
+    /**
+     * 城市信息
+     */
     c: Array<{
         /**
          * 城市名称
@@ -679,6 +764,9 @@ export interface IGetWeathersResponse {
          */
         id: number;
     }>;
+    /**
+     * 天气预报数据
+     */
     weathers: Array<{
         /**
          * 风向
@@ -788,13 +876,37 @@ export interface IGetCustomizePositionResponse {
      */
     lat: string;
 }
+/**
+ * 获取指定时间段上报日志请求参数
+ */
 export interface IGetLogInSpecifiedTime {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * DP 点 ID，多个 ID 用英文逗号隔开
+     */
     dpIds: string;
+    /**
+     * 分页偏移量
+     */
     offset: number;
+    /**
+     * 每页数量，最大值上限为 1000
+     */
     limit: number;
+    /**
+     * 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+     */
     sortType?: 'DESC' | 'ASC';
+    /**
+     * 查询起始时间戳（毫秒）
+     */
     startTime?: string;
+    /**
+     * 查询结束时间戳（毫秒）
+     */
     endTime?: string;
 }
 export type Dp = {
@@ -829,11 +941,29 @@ export interface IGetLogInSpecifiedTimeResponse {
      */
     hasNext: boolean;
 }
+/**
+ * 获取 DP 点上报日志请求参数
+ */
 export interface IGetDpReportLog {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * DP 点 ID，多个 ID 用英文逗号隔开
+     */
     dpIds: string;
+    /**
+     * 分页偏移量
+     */
     offset: number;
+    /**
+     * 每页数量，最大值上限为 1000
+     */
     limit: number;
+    /**
+     * 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+     */
     sortType?: 'DESC' | 'ASC';
 }
 export interface IGetDpReportLogResponse {
@@ -850,11 +980,29 @@ export interface IGetDpReportLogResponse {
      */
     hasNext: boolean;
 }
+/**
+ * 获取 DP 点每日统计数据请求参数
+ */
 export interface IGetDpLogDays {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * DP 点 ID
+     */
     dpId: string;
+    /**
+     * 统计类型：sum（求和）、min（最小值）或 max（最大值）
+     */
     type?: string;
+    /**
+     * 开始日期，格式为 yyyyMMdd，例如 20180529
+     */
     startDay: string;
+    /**
+     * 结束日期，格式为 yyyyMMdd，例如 20180531
+     */
     endDay: string;
 }
 export interface IGetDpLogDaysResponse {
@@ -963,9 +1111,21 @@ export interface IGetMultiDpsAllResultResponse {
      */
     value: string;
 }
+/**
+ * 设置告警开关请求参数
+ */
 export interface ISetAlarmSwitch {
+    /**
+     * 设备 ID
+     */
     devId: string;
+    /**
+     * 要开启或关闭的告警规则 ID，多个 ID 用英文逗号隔开
+     */
     ruleIds: string;
+    /**
+     * 是否禁用告警，'true' 表示禁用，'false' 表示启用
+     */
     disabled: string;
 }
 export interface IAlarmSdk {
@@ -1531,6 +1691,7 @@ export interface IZigbeeLocalGroupRelationItem {
     categoryCode: string;
 }
 export type IGetZigbeeLocalGroupRelationResponse = {
+    /** 遥控器群组 localId 关系列表 */
     locals: IZigbeeLocalGroupRelationItem[];
 };
 export interface IGetZigbeeLocalGroupDeviceList {

package/lib/cloud/interface.js

@@ -8,8 +8,26 @@
 // 云端定时接口
 // 电费统计接口
 // 设备接口
+/**
+ * 获取天气及空气质量请求参数
+ */
+/**
+ * 获取天气预报请求参数
+ */
 // 数据统计接口
+/**
+ * 获取指定时间段上报日志请求参数
+ */
+/**
+ * 获取 DP 点上报日志请求参数
+ */
+/**
+ * 获取 DP 点每日统计数据请求参数
+ */
 // 告警相关接口
+/**
+ * 设置告警开关请求参数
+ */
 // 联动相关
 /**
  * 一键执行类型的联动规则数据

package/lib/cloud/statistic.d.ts

@@ -1,40 +1,126 @@
 import { IGetLogInSpecifiedTime, IGetDpReportLog, IGetDpLogDays, IGetDpResultByMonth, IGetDpResultByHour, IGetDataWithSpecified, IGetWeekWithSpecified, IGetMonthWithSpecified, IGetMultiDpsAllResult, IGetLogInSpecifiedTimeResponse, IGetDpReportLogResponse, IGetDpLogDaysResponse, IGetDpResultByMonthResponse, IGetDpResultByHourResponse, IGetDataWithSpecifiedResponse, IGetWeekWithSpecifiedResponse, IGetMonthWithSpecifiedResponse, IGetMultiDpsAllResultResponse } from './interface';
 /**
- * 获取 DP 点指定时间段上报日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} startTime 设备上报的时间, 查询起始时间，单位为毫秒
- * @param {string} endTime 设备上报的时间，查询结束时间，单位为毫秒
- * @param {string} sortType DESC 倒序 或 ASC 顺序, 默认为 DESC
+ * 获取 DP 点指定时间段内的上报日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.startTime - 查询起始时间戳（毫秒）
+ * @param params.endTime - 查询结束时间戳（毫秒）
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getLogInSpecifiedTime } from '@ray-js/ray';
+ *
+ * getLogInSpecifiedTime({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   startTime: '1620000000000',
+ *   endTime: '1629999999999',
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('日志数据:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getLogInSpecifiedTime: (params: IGetLogInSpecifiedTime) => Promise<IGetLogInSpecifiedTimeResponse>;
 /**
- * 获取 DP 点上报日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} sortType 'DESC' 倒序 或 'ASC' 顺序, 默认为 'DESC'
+ * 获取 DP 点上报日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getDpReportLog } from '@ray-js/ray';
+ *
+ * getDpReportLog({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('上报日志:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getDpReportLog: (params: IGetDpReportLog) => Promise<IGetDpReportLogResponse>;
 /**
- * 获取用户操作的下发日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} sortType 'DESC' 倒序 或 'ASC' 顺序, 默认为 'DESC'
+ * 获取用户操作的下发日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 用户操作日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getLogUserAction } from '@ray-js/ray';
+ *
+ * getLogUserAction({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('用户操作日志:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getLogUserAction: (params: IGetDpReportLog) => Promise<IGetDpReportLogResponse>;
 /**
- * 获取设备月的每日上报的数据统计
- * @param {string} devId 设备Id
- * @param {string} dpId dpId
- * @param {string} startDay 开始日期，例如20180529
- * @param {string} endDay 结束日期，例如20180531
- * @param {string} type 统计的类型，sum、minux 或 max
+ * 获取指定日期范围内 DP 点每日上报的数据统计
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpId - DP 点 ID
+ * @param params.startDay - 开始日期，格式为 yyyyMMdd，例如 20180529
+ * @param params.endDay - 结束日期，格式为 yyyyMMdd，例如 20180531
+ * @param params.type - 统计类型：sum（求和）、min（最小值）或 max（最大值）
+ * @returns 每日统计数据，包含总条数、日期列表、对应每天的值列表
+ * @example 基础用法
+ * ```ts
+ * import { getDpLogDays } from '@ray-js/ray';
+ *
+ * getDpLogDays({
+ *   devId: 'vdevo169477319679442',
+ *   dpId: '1',
+ *   startDay: '20240101',
+ *   endDay: '20240131',
+ *   type: 'sum',
+ * }).then((res) => {
+ *   console.log('每日统计:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getDpLogDays: (params: IGetDpLogDays) => Promise<IGetDpLogDaysResponse>;
 /**

package/lib/cloud/statistic.js

@@ -3,14 +3,37 @@ import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import { requestCloud } from '../';
 import { THING } from '../constants';
 /**
- * 获取 DP 点指定时间段上报日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} startTime 设备上报的时间, 查询起始时间，单位为毫秒
- * @param {string} endTime 设备上报的时间，查询结束时间，单位为毫秒
- * @param {string} sortType DESC 倒序 或 ASC 顺序, 默认为 DESC
+ * 获取 DP 点指定时间段内的上报日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.startTime - 查询起始时间戳（毫秒）
+ * @param params.endTime - 查询结束时间戳（毫秒）
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getLogInSpecifiedTime } from '@ray-js/ray';
+ *
+ * getLogInSpecifiedTime({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   startTime: '1620000000000',
+ *   endTime: '1629999999999',
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('日志数据:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getLogInSpecifiedTime = params => {
   return requestCloud({
@@ -21,12 +44,33 @@ const getLogInSpecifiedTime = params => {
 };
 
 /**
- * 获取 DP 点上报日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} sortType 'DESC' 倒序 或 'ASC' 顺序, 默认为 'DESC'
+ * 获取 DP 点上报日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getDpReportLog } from '@ray-js/ray';
+ *
+ * getDpReportLog({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('上报日志:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getDpReportLog = params => {
   return requestCloud({
@@ -37,12 +81,33 @@ const getDpReportLog = params => {
 };
 
 /**
- * 获取用户操作的下发日志
- * @param {string} devId 设备Id
- * @param {string} dpIds dpId
- * @param {number} offset 偏离值
- * @param {number} limit 最大值, 最大值上限为 1000,
- * @param {string} sortType 'DESC' 倒序 或 'ASC' 顺序, 默认为 'DESC'
+ * 获取用户操作的下发日志（支持分页）
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpIds - DP 点 ID，多个 ID 用英文逗号隔开
+ * @param params.offset - 分页偏移量
+ * @param params.limit - 每页数量，最大值上限为 1000
+ * @param params.sortType - 排序方式：'DESC' 倒序（默认）或 'ASC' 顺序
+ * @returns 用户操作日志数据，包含总条数、DP 日志列表、是否有下一页
+ * @example 基础用法
+ * ```ts
+ * import { getLogUserAction } from '@ray-js/ray';
+ *
+ * getLogUserAction({
+ *   devId: 'vdevo169477319679442',
+ *   dpIds: '1,2',
+ *   offset: 0,
+ *   limit: 50,
+ *   sortType: 'DESC',
+ * }).then((res) => {
+ *   console.log('用户操作日志:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getLogUserAction = params => {
   return requestCloud({
@@ -53,12 +118,33 @@ const getLogUserAction = params => {
 };
 
 /**
- * 获取设备月的每日上报的数据统计
- * @param {string} devId 设备Id
- * @param {string} dpId dpId
- * @param {string} startDay 开始日期，例如20180529
- * @param {string} endDay 结束日期，例如20180531
- * @param {string} type 统计的类型，sum、minux 或 max
+ * 获取指定日期范围内 DP 点每日上报的数据统计
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dpId - DP 点 ID
+ * @param params.startDay - 开始日期，格式为 yyyyMMdd，例如 20180529
+ * @param params.endDay - 结束日期，格式为 yyyyMMdd，例如 20180531
+ * @param params.type - 统计类型：sum（求和）、min（最小值）或 max（最大值）
+ * @returns 每日统计数据，包含总条数、日期列表、对应每天的值列表
+ * @example 基础用法
+ * ```ts
+ * import { getDpLogDays } from '@ray-js/ray';
+ *
+ * getDpLogDays({
+ *   devId: 'vdevo169477319679442',
+ *   dpId: '1',
+ *   startDay: '20240101',
+ *   endDay: '20240131',
+ *   type: 'sum',
+ * }).then((res) => {
+ *   console.log('每日统计:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getDpLogDays = params => {
   return requestCloud({

package/lib/cloud/timer.d.ts

@@ -1,4 +1,4 @@
-import { IAndSingleTime, IQueryTimerTasks, IModifySingleTimer, IAndGroupTimer, IModifyGroupTimer, IModDeleteTaskByIds, IModDeleteTaskByCategory, IGetDpLastTimer, IGetLastTimerPeriod, IGetAstronomicalList, IAstronomical, IUpdateAstronomicalStatus, IQueryTimerTasksResponse, IGetDpLastTimerResponse, IGetLastTimerPeriodResponse, IGetAstronomicalListResponse } from './interface';
+import { IAndSingleTime, IQueryTimerTasks, IModifySingleTimer, IAndGroupTimer, IModifyGroupTimer, IModDeleteTaskByIds, IModDeleteTaskByCategory, IGetDpLastTimer, IGetLastTimerPeriod, IGetAstronomicalList, IAstronomical, IUpdateAstronomicalStatus, IRemoveAstronomicalParams, IQueryTimerTasksResponse, IGetDpLastTimerResponse, IGetLastTimerPeriodResponse, IGetAstronomicalListResponse } from './interface';
 /**
  * 添加单次定时
  * @param {string} bizId 单设备 ID（devId） 或者群组设备 ID（groupId)
@@ -218,7 +218,5 @@ declare const updateAstronomicalStatus: (params: IUpdateAstronomicalStatus) => P
  * });
  * ```
  */
-declare const removeAstronomical: (params: {
-    id: string;
-}) => Promise<boolean>;
+declare const removeAstronomical: (params: IRemoveAstronomicalParams) => Promise<boolean>;
 export { addSingleTimer, queryTimerTasks, modifySingleTimer, addGroupTimer, queryGroupTimerTasks, modifyGroupTimer, modDeleteTaskByIds, modDeleteTaskByCategory, getDpLastTimer, getDpsLastTimer, getLastTimerPeriod, getAstronomicalList, addAstronomical, updateAstronomical, updateAstronomicalStatus, removeAstronomical, };

package/lib/nativeRouters/outdoors.d.ts

@@ -8,7 +8,9 @@ type OpenOutdoorCyclingNavigationParams = {
  * @public
  * @since @ray-js/ray 1.4.29
  * @param params - 请求参数
+ * @returns 跳转成功时 resolve
  * @remarks 当前功能仅在智慧出行 App 开通使用，开发者工具环境无法使用，需要打包后或真机调试使用
+ * @returns 无
  * @example 基础用法
  * ```ts
  * import { openOutdoorCyclingNavigation } from '@ray-js/ray';

package/lib/nativeRouters/outdoors.js

@@ -5,7 +5,9 @@ import { nativeRouter } from './common';
  * @public
  * @since @ray-js/ray 1.4.29
  * @param params - 请求参数
+ * @returns 跳转成功时 resolve
  * @remarks 当前功能仅在智慧出行 App 开通使用，开发者工具环境无法使用，需要打包后或真机调试使用
+ * @returns 无
  * @example 基础用法
  * ```ts
  * import { openOutdoorCyclingNavigation } from '@ray-js/ray';

package/lib/nativeRouters/remoteGroup.d.ts

@@ -24,7 +24,9 @@ type OpenZigbeeLocalGroupParams = {
  * @public
  * @since @ray-js/ray 1.5.2
  * @param params - 请求参数
+ * @returns 跳转成功时 resolve
  * @remarks 当前仅针对 Zigbee 的部分品类开通了此类能力
+ * @returns 无
  * @example 基础用法
  * ```ts
  * import { openZigbeeLocalGroup } from '@ray-js/ray';

package/lib/nativeRouters/remoteGroup.js

@@ -6,7 +6,9 @@ import { nativeRouter } from './common';
  * @public
  * @since @ray-js/ray 1.5.2
  * @param params - 请求参数
+ * @returns 跳转成功时 resolve
  * @remarks 当前仅针对 Zigbee 的部分品类开通了此类能力
+ * @returns 无
  * @example 基础用法
  * ```ts
  * import { openZigbeeLocalGroup } from '@ray-js/ray';