@ray-js/api 1.7.79 → 1.7.80

package/lib/cloud/alarm.d.ts

@@ -1,14 +1,47 @@
 import { AlarmList, ISetAlarmSwitch } from './interface';
 /**
  * 根据设备 ID 查询告警列表信息
- * @param {string} devId 设备Id
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param devId - 设备 ID
+ * @returns 告警规则列表，包含告警 ID、名称、启用状态、绑定信息等
+ * @example 基础用法
+ * ```ts
+ * import { getDevAlarmList } from '@ray-js/ray';
+ *
+ * getDevAlarmList('vdevo169477319679442').then((res) => {
+ *   console.log('告警列表:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getDevAlarmList: (devId: string) => Promise<AlarmList[]>;
 /**
- * 启用或者禁用设备的告警
- * @param {string} devId 设备Id
- * @param {string} ruleIds 要开启或关闭的告警id, 用","隔开
- * @param {bool} disabled 是否禁用
+ * 启用或者禁用设备的告警开关
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.ruleIds - 要开启或关闭的告警规则 ID，多个 ID 用英文逗号隔开
+ * @param params.disabled - 是否禁用告警，'true' 表示禁用，'false' 表示启用
+ * @returns 是否设置成功
+ * @example 基础用法
+ * ```ts
+ * import { setAlarmSwitch } from '@ray-js/ray';
+ *
+ * setAlarmSwitch({
+ *   devId: 'vdevo169477319679442',
+ *   ruleIds: '123456,789012',
+ *   disabled: 'false',
+ * }).then((res) => {
+ *   console.log('设置结果:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const setAlarmSwitch: (params: ISetAlarmSwitch) => Promise<boolean>;
 export { getDevAlarmList, setAlarmSwitch };

package/lib/cloud/alarm.js

@@ -4,7 +4,21 @@ import { requestCloud } from '../';
 import { THING } from '../constants';
 /**
  * 根据设备 ID 查询告警列表信息
- * @param {string} devId 设备Id
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param devId - 设备 ID
+ * @returns 告警规则列表，包含告警 ID、名称、启用状态、绑定信息等
+ * @example 基础用法
+ * ```ts
+ * import { getDevAlarmList } from '@ray-js/ray';
+ *
+ * getDevAlarmList('vdevo169477319679442').then((res) => {
+ *   console.log('告警列表:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getDevAlarmList = devId => {
   return requestCloud({
@@ -17,10 +31,29 @@ const getDevAlarmList = devId => {
 };
 
 /**
- * 启用或者禁用设备的告警
- * @param {string} devId 设备Id
- * @param {string} ruleIds 要开启或关闭的告警id, 用","隔开
- * @param {bool} disabled 是否禁用
+ * 启用或者禁用设备的告警开关
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.ruleIds - 要开启或关闭的告警规则 ID，多个 ID 用英文逗号隔开
+ * @param params.disabled - 是否禁用告警，'true' 表示禁用，'false' 表示启用
+ * @returns 是否设置成功
+ * @example 基础用法
+ * ```ts
+ * import { setAlarmSwitch } from '@ray-js/ray';
+ *
+ * setAlarmSwitch({
+ *   devId: 'vdevo169477319679442',
+ *   ruleIds: '123456,789012',
+ *   disabled: 'false',
+ * }).then((res) => {
+ *   console.log('设置结果:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const setAlarmSwitch = params => {
   return requestCloud({

package/lib/cloud/device.d.ts

@@ -87,15 +87,51 @@ declare const getGroupDpsInfos: (groupId: string) => Promise<IGetGroupDpsInfosRe
  */
 declare const updateGroupDpName: (params: IUpdateGroupDpName) => Promise<boolean>;
 /**
- * 通过设备 ID 获取当天天气
- * @param {string} devId 设备Id
- * @param {boolean} isLocal 要查询的信息
+ * 通过设备 ID 获取当天天气及空气质量
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.isLocal - 是否查询本地天气
+ * @returns 天气及空气质量信息，包含城市信息、温度、湿度、风向、风速、空气质量指数等
+ * @example 基础用法
+ * ```ts
+ * import { getWeatherQuality } from '@ray-js/ray';
+ *
+ * getWeatherQuality({
+ *   devId: 'vdevo169477319679442',
+ *   isLocal: true,
+ * }).then((res) => {
+ *   console.log('天气信息:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getWeatherQuality: (params: IGetWeatherQuality) => Promise<IGetWeatherQualityResponse>;
 /**
- * 天气预报接口
- * @param {string} devId 设备Id
- * @param {number} dataRange 预报天数（默认值为 7，最大可预报天数为 7）
+ * 获取天气预报信息
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dataRange - 预报天数（默认值为 7，最大可预报天数为 7）
+ * @returns 天气预报信息，包含城市信息及未来多日的天气数据（温度、湿度、风向、风速、日出日落时间等）
+ * @example 基础用法
+ * ```ts
+ * import { getWeathers } from '@ray-js/ray';
+ *
+ * getWeathers({
+ *   devId: 'vdevo169477319679442',
+ *   dataRange: 7,
+ * }).then((res) => {
+ *   console.log('天气预报:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 declare const getWeathers: (params: IGetWeathers) => Promise<IGetWeathersResponse>;
 /**

package/lib/cloud/device.js

@@ -120,9 +120,27 @@ const updateGroupDpName = params => {
 };
 
 /**
- * 通过设备 ID 获取当天天气
- * @param {string} devId 设备Id
- * @param {boolean} isLocal 要查询的信息
+ * 通过设备 ID 获取当天天气及空气质量
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.isLocal - 是否查询本地天气
+ * @returns 天气及空气质量信息，包含城市信息、温度、湿度、风向、风速、空气质量指数等
+ * @example 基础用法
+ * ```ts
+ * import { getWeatherQuality } from '@ray-js/ray';
+ *
+ * getWeatherQuality({
+ *   devId: 'vdevo169477319679442',
+ *   isLocal: true,
+ * }).then((res) => {
+ *   console.log('天气信息:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getWeatherQuality = params => {
   return requestCloud({
@@ -133,9 +151,27 @@ const getWeatherQuality = params => {
 };
 
 /**
- * 天气预报接口
- * @param {string} devId 设备Id
- * @param {number} dataRange 预报天数（默认值为 7，最大可预报天数为 7）
+ * 获取天气预报信息
+ *
+ * @public
+ * @since @ray-js/ray 1.5.2
+ * @param params - 请求参数
+ * @param params.devId - 设备 ID
+ * @param params.dataRange - 预报天数（默认值为 7，最大可预报天数为 7）
+ * @returns 天气预报信息，包含城市信息及未来多日的天气数据（温度、湿度、风向、风速、日出日落时间等）
+ * @example 基础用法
+ * ```ts
+ * import { getWeathers } from '@ray-js/ray';
+ *
+ * getWeathers({
+ *   devId: 'vdevo169477319679442',
+ *   dataRange: 7,
+ * }).then((res) => {
+ *   console.log('天气预报:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getWeathers = params => {
   return requestCloud({

package/lib/cloud/gateway.d.ts

@@ -2,6 +2,22 @@
 /// <reference path="../../@types/gateway.d.ts" />
 /**
  * @public
+ * @example
+ * ```tsx
+ * import { gateway } from '@ray-js/ray';
+ *
+ * const { hasParamsMethod } = gateway;
+ *
+ * hasParamsMethod({
+ *   testDeviceID: 0,
+ *   success: (result) => {
+ *     console.log('hasParamsMethod success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('hasParamsMethod fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export declare const hasParamsMethod: typeof ty.groupcitest.hasParamsMethod;
 /**

package/lib/cloud/gateway.js

@@ -4,6 +4,22 @@ import { factory } from '../utils';
 
 /**
  * @public
+ * @example
+ * ```tsx
+ * import { gateway } from '@ray-js/ray';
+ *
+ * const { hasParamsMethod } = gateway;
+ *
+ * hasParamsMethod({
+ *   testDeviceID: 0,
+ *   success: (result) => {
+ *     console.log('hasParamsMethod success', result);
+ *   },
+ *   fail: (error) => {
+ *     console.log('hasParamsMethod fail', error.errorMsg);
+ *   },
+ * });
+ * ```
  */
 export const hasParamsMethod = factory('hasParamsMethod', {
   namespace: 'groupcitest'

package/lib/cloud/health.d.ts

@@ -1,4 +1,5 @@
 /// <reference path="../../@types/health.d.ts" />
+/// <reference path="../../@types/health.d.ts" />
 export declare const health: {
     addPanelUser: typeof ty.health.addPanelUser;
     updatePanelUser: typeof ty.health.updatePanelUser;

package/lib/cloud/health.js

@@ -1,5 +1,7 @@
 /// <reference path="../../@types/health.d.ts" />
 
+/// <reference path="../../@types/health.d.ts" />
+
 import { factory } from '../utils';
 
 /**
@@ -7,6 +9,29 @@ import { factory } from '../utils';
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.addPanelUser({
+ *   userInfo: {
+ *     devId: 'vdevo169477319679442',
+ *     type: 1,
+ *     userName: '张三',
+ *     sex: 0,
+ *     birthday: 946656000000,
+ *     height: 175,
+ *     heightUnit: 'cm',
+ *     weight: 70,
+ *     weightUnit: 'kg',
+ *     userType: 1,
+ *   },
+ * }).then((userId) => {
+ *   console.log('添加成功，用户ID:', userId);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const addPanelUser = factory('addPanelUser', {
   namespace: 'health'
@@ -17,6 +42,30 @@ const addPanelUser = factory('addPanelUser', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.updatePanelUser({
+ *   userInfo: {
+ *     userId: 'user123',
+ *     devId: 'vdevo169477319679442',
+ *     type: 1,
+ *     userName: '张三',
+ *     sex: 0,
+ *     birthday: 946656000000,
+ *     height: 178,
+ *     heightUnit: 'cm',
+ *     weight: 72,
+ *     weightUnit: 'kg',
+ *     userType: 1,
+ *   },
+ * }).then((success) => {
+ *   console.log('更新结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const updatePanelUser = factory('updatePanelUser', {
   namespace: 'health'
@@ -27,6 +76,18 @@ const updatePanelUser = factory('updatePanelUser', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.deletePanelUser({
+ *   userId: 'user123',
+ * }).then((success) => {
+ *   console.log('删除结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const deletePanelUser = factory('deletePanelUser', {
   namespace: 'health'
@@ -37,6 +98,18 @@ const deletePanelUser = factory('deletePanelUser', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getPanelUserList({
+ *   devId: 'vdevo169477319679442',
+ * }).then((userList) => {
+ *   console.log('用户列表:', userList);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getPanelUserList = factory('getPanelUserList', {
   namespace: 'health'
@@ -47,6 +120,18 @@ const getPanelUserList = factory('getPanelUserList', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getDefaultAvatarList({
+ *   bizCode: 'default_avatar',
+ * }).then((avatarList) => {
+ *   console.log('头像列表:', avatarList);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getDefaultAvatarList = factory('getDefaultAvatarList', {
   namespace: 'health'
@@ -57,6 +142,29 @@ const getDefaultAvatarList = factory('getDefaultAvatarList', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.reportPanelBpgData({
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ *   dataJson: [{
+ *     dps: {
+ *       1: 120,
+ *       2: 80,
+ *       3: 72,
+ *       4: false,
+ *       9: 'user123',
+ *     },
+ *     dpsTime: Date.now(),
+ *   }],
+ * }).then((res) => {
+ *   console.log('上传结果:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const reportPanelBpgData = factory('reportPanelBpgData', {
   namespace: 'health'
@@ -67,6 +175,26 @@ const reportPanelBpgData = factory('reportPanelBpgData', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.reportSingleBpgData({
+ *   dataInfo: {
+ *     devId: 'vdevo169477319679442',
+ *     userId: 'user123',
+ *     sys: 120,
+ *     dia: 80,
+ *     pulse: 72,
+ *     time: Date.now(),
+ *     remark: '早晨测量',
+ *   },
+ * }).then((res) => {
+ *   console.log('上传结果:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const reportSingleBpgData = factory('reportSingleBpgData', {
   namespace: 'health'
@@ -77,6 +205,19 @@ const reportSingleBpgData = factory('reportSingleBpgData', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.updateBpgDataRemark({
+ *   uuid: 'bpg123',
+ *   remark: '饭后测量',
+ * }).then((success) => {
+ *   console.log('更新结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const updateBpgDataRemark = factory('updateBpgDataRemark', {
   namespace: 'health'
@@ -87,6 +228,19 @@ const updateBpgDataRemark = factory('updateBpgDataRemark', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.deleteBpgData({
+ *   userId: 'user123',
+ *   uuids: 'bpg123,bpg456',
+ * }).then((success) => {
+ *   console.log('删除结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const deleteBpgData = factory('deleteBpgData', {
   namespace: 'health'
@@ -97,6 +251,25 @@ const deleteBpgData = factory('deleteBpgData', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataHistory({
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ *   startTime: Date.now() - 30 * 24 * 60 * 60 * 1000,
+ *   endTime: Date.now(),
+ *   bpLevels: '',
+ *   existRemark: '',
+ *   offset: 0,
+ *   limit: 20,
+ * }).then((res) => {
+ *   console.log('历史数据:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataHistory = factory('getBpgDataHistory', {
   namespace: 'health'
@@ -107,6 +280,19 @@ const getBpgDataHistory = factory('getBpgDataHistory', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataTrendLatest({
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ * }).then((res) => {
+ *   console.log('最新统计:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataTrendLatest = factory('getBpgDataTrendLatest', {
   namespace: 'health'
@@ -117,6 +303,21 @@ const getBpgDataTrendLatest = factory('getBpgDataTrendLatest', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataLevnum({
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ *   startTime: Date.now() - 30 * 24 * 60 * 60 * 1000,
+ *   endTime: Date.now(),
+ * }).then((res) => {
+ *   console.log('等级统计:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataLevnum = factory('getBpgDataLevnum', {
   namespace: 'health'
@@ -127,6 +328,22 @@ const getBpgDataLevnum = factory('getBpgDataLevnum', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataTrend({
+ *   dataType: 'week',
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ *   startTime: Date.now() - 7 * 24 * 60 * 60 * 1000,
+ *   endTime: Date.now(),
+ * }).then((res) => {
+ *   console.log('统计趋势:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataTrend = factory('getBpgDataTrend', {
   namespace: 'health'
@@ -137,6 +354,21 @@ const getBpgDataTrend = factory('getBpgDataTrend', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataDays({
+ *   devId: 'vdevo169477319679442',
+ *   userId: 'user123',
+ *   startTime: Date.now() - 30 * 24 * 60 * 60 * 1000,
+ *   endTime: Date.now(),
+ * }).then((days) => {
+ *   console.log('有数据的日期:', days);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataDays = factory('getBpgDataDays', {
   namespace: 'health'
@@ -147,6 +379,20 @@ const getBpgDataDays = factory('getBpgDataDays', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.getBpgDataUnallocated({
+ *   devId: 'vdevo169477319679442',
+ *   offset: 0,
+ *   limit: 20,
+ * }).then((res) => {
+ *   console.log('未分配数据:', res);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const getBpgDataUnallocated = factory('getBpgDataUnallocated', {
   namespace: 'health'
@@ -157,6 +403,20 @@ const getBpgDataUnallocated = factory('getBpgDataUnallocated', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.updateBpgDataUnallocated({
+ *   userId: 'user123',
+ *   uuids: 'bpg123,bpg456',
+ *   devId: 'vdevo169477319679442',
+ * }).then((success) => {
+ *   console.log('分配结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const updateBpgDataUnallocated = factory('updateBpgDataUnallocated', {
   namespace: 'health'
@@ -167,6 +427,18 @@ const updateBpgDataUnallocated = factory('updateBpgDataUnallocated', {
  *
  * @public
  * @since @ray-js/ray 1.5.40
+ * @example 基础用法
+ * ```ts
+ * import { health } from '@ray-js/ray';
+ *
+ * health.deleteBpgDataUnallocated({
+ *   uuids: 'bpg123,bpg456',
+ * }).then((success) => {
+ *   console.log('删除结果:', success);
+ * }).catch((error) => {
+ *   console.error(error);
+ * });
+ * ```
  */
 const deleteBpgDataUnallocated = factory('deleteBpgDataUnallocated', {
   namespace: 'health'