@ray-js/robot-data-stream 0.0.10-beta-12 → 0.0.10-beta-13

package/lib/mqtt/useDevInfo.d.ts

@@ -1,4 +1,12 @@
-import { PromiseWithRejection } from './promise';
+interface DevInfoResponse {
+    reqType: string;
+    version: string;
+    info: string;
+    success: boolean;
+    errCode: number;
+    taskId: string;
+}
 export declare const useDevInfo: (devId: string) => {
-    requestDevInfo: () => PromiseWithRejection;
+    requestDevInfo: () => Promise<DevInfoResponse>;
 };
+export {};

package/lib/mqtt/useDevInfo.js

@@ -3,7 +3,8 @@ import { normalResolve } from './promise';
 var DevInfoEnum = /*#__PURE__*/function (DevInfoEnum) {
   DevInfoEnum["query"] = "devInfoQry";
   return DevInfoEnum;
-}(DevInfoEnum || {}); // 请求设备信息
+}(DevInfoEnum || {});
+// 请求设备信息
 export const useDevInfo = devId => {
   return {
     requestDevInfo: () => {

package/lib/mqtt/useHistoryMap.d.ts

@@ -1,7 +1,34 @@
-type TDeleteHistoryMap = (mapId: number) => Promise<void>;
+type TDeleteHistoryMap = (mapId: number) => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    version: string;
+    taskId: string;
+}>;
+type TChangeCurrentMap = (mapId: number, url: string) => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    mapId: number;
+    version: string;
+    taskId: string;
+}>;
+type TSaveMap = () => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    mapId: number;
+    version: string;
+    taskId: string;
+}>;
+/**
+ * 自定义 Hook，用于管理历史地图
+ * @param devId 设备ID
+ * @returns 包含删除历史地图、更改当前地图和保存地图的函数
+ */
 export declare const useHistoryMap: (devId: string) => {
     deleteHistoryMap: TDeleteHistoryMap;
-    changeCurrentMap: (mapId: number, url: string, taskId: string) => Promise<void>;
-    saveMap: () => Promise<void>;
+    changeCurrentMap: TChangeCurrentMap;
+    saveMap: TSaveMap;
 };
 export {};

package/lib/mqtt/useHistoryMap.js

@@ -5,14 +5,38 @@ import { DeleteMapEnum, SaveCurrentMapEnum, UseMapEnum } from './type';
 
 // 删除历史地图函数类型定义
 
+// 更改当前使用的地图函数类型定义
+
+/**
+ * 自定义 Hook，用于管理历史地图
+ * @param devId 设备ID
+ * @returns 包含删除历史地图、更改当前地图和保存地图的函数
+ */
 export const useHistoryMap = devId => {
-  // 删除历史地图
+  /**
+   * 删除历史地图
+   * @param mapId 地图ID
+   * @returns Promise<{ success: boolean; errCode: number; reqType: string; version: string; taskId: string; }> 响应结果
+   */
+
+  /**
+   * 保存当前地图
+   * @returns Promise<void> 响应结果
+   */
 
-  // 更改当前使用的地图
+  /**
+   * 更改当前使用的地图
+   * @param mapId 地图ID
+   * @param url 地图URL
+   * @returns Promise<{ success: boolean; errCode: number; reqType: string; mapId: number; version: string; taskId: string; }> 响应结果
+   */
 
   return {
     deleteHistoryMap: async mapId => {
       try {
+        if (!mapId) {
+          return Promise.reject(new Error('mapId is required'));
+        }
         await deleteMultipleMapFile(mapId, devId);
         const params = createSetCommonParams({
           deviceId: devId,
@@ -30,23 +54,27 @@ export const useHistoryMap = devId => {
         return Promise.reject(err);
       }
     },
-    changeCurrentMap: (mapId, url) => {
-      const sendData = {
-        reqType: UseMapEnum.set,
-        mapId,
-        url,
-        urlLen: url.length
-      };
-      const params = createSetCommonParams({
-        deviceId: devId,
-        reqType: UseMapEnum.set,
-        message: sendData
-      });
-      const {
-        taskId
-      } = params.message;
-      ty.device.sendMqttMessage(params);
-      return normalResolve(UseMapEnum.query, taskId);
+    changeCurrentMap: async (mapId, url) => {
+      try {
+        const sendData = {
+          reqType: UseMapEnum.set,
+          mapId,
+          url,
+          urlLen: url.length
+        };
+        const params = createSetCommonParams({
+          deviceId: devId,
+          reqType: UseMapEnum.set,
+          message: sendData
+        });
+        ty.device.sendMqttMessage(params);
+        const {
+          taskId
+        } = params.message;
+        return await normalResolve(UseMapEnum.query, taskId);
+      } catch (err) {
+        return Promise.reject(err);
+      }
     },
     saveMap: () => {
       const params = createSetCommonParams({
@@ -56,6 +84,7 @@ export const useHistoryMap = devId => {
           oper: 0
         }
       });
+      ty.device.sendMqttMessage(params);
       return normalResolve(SaveCurrentMapEnum.query, params.message.taskId);
     }
   };

package/lib/mqtt/usePartDivision.d.ts

@@ -1,6 +1,11 @@
 import { Point } from '../utils';
-import { PromiseWithRejection } from './promise';
-type TSetPartDivision = (points: Point[], roomId: number, origin: Point) => PromiseWithRejection;
+type TSetPartDivision = (points: Point[], roomId: number, origin: Point) => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    version: string;
+    taskId: string;
+}>;
 /**
  * 自定义 Hook，用于房间分隔
  * @param devId 设备ID

package/lib/mqtt/usePartMerge.d.ts

@@ -1,5 +1,10 @@
-import { PromiseWithRejection } from './promise';
-type TSetPartMerge = (ids: number[]) => PromiseWithRejection;
+type TSetPartMerge = (ids: number[]) => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    version: string;
+    taskId: string;
+}>;
 /**
  * 自定义 Hook，用于分区合并
  * @param devId 设备ID

package/lib/mqtt/usePartMerge.js

@@ -1,3 +1,5 @@
+import "core-js/modules/esnext.iterator.constructor.js";
+import "core-js/modules/esnext.iterator.some.js";
 // 分区合并
 import { createSetCommonParams } from './createCommonOptions';
 import { normalResolve } from './promise';
@@ -19,6 +21,12 @@ export const usePartMerge = devId => {
 
   return {
     setPartMerge: ids => {
+      if (!ids || ids.length < 2) {
+        return Promise.reject(new Error('ids is required and length must be greater than 1'));
+      }
+      if (ids.some(id => typeof id !== 'number')) {
+        return Promise.reject(new Error('ids must be an array of numbers'));
+      }
       const params = createSetCommonParams({
         deviceId: devId,
         reqType: PartMergeEnum.set,

package/lib/mqtt/useQuiteHours.d.ts

@@ -1,4 +1,35 @@
-import { PromiseWithRejection } from './promise';
+type Response = {
+    reqType: string;
+    /**
+     * 版本号
+     */
+    version: string;
+    /**
+     * 是否激活
+     * 0 表示未激活，1 表示激活
+     */
+    active: number;
+    /**
+     * 时间段数组，每个元素为 "开始时间, 结束时间" 的字符串
+     */
+    time: string[];
+    /**
+     * 星期几，1 表示星期一，2 表示星期二，以此类推
+     */
+    day: number;
+    /**
+     * 请求是否成功
+     */
+    success: boolean;
+    /**
+     * 错误代码，0 表示无错误
+     */
+    errCode: number;
+    /**
+     * 任务ID
+     */
+    taskId: string;
+};
 type TSetQuiteHours = (params: {
     startTime: {
         hour: number;
@@ -11,7 +42,7 @@ type TSetQuiteHours = (params: {
     active: number;
     day: number;
     version?: string;
-}) => PromiseWithRejection;
+}) => Promise<Response>;
 /**
  * 自定义 Hook，用于勿扰模式
  * @param devId 设备ID
@@ -19,6 +50,6 @@ type TSetQuiteHours = (params: {
  */
 export declare const useQuiteHours: (devId: string) => {
     setQuiteHours: TSetQuiteHours;
-    requestQuiteHours: () => PromiseWithRejection;
+    requestQuiteHours: () => Promise<Response>;
 };
 export {};

package/lib/mqtt/useResetMap.d.ts

@@ -1,3 +1,11 @@
+type TSetResetMap = () => Promise<{
+    success: boolean;
+    errCode: number;
+    reqType: string;
+    version: string;
+    taskId: string;
+}>;
 export declare const useResetMap: (devId: string) => {
-    setResetMap: () => Promise<void>;
+    setResetMap: TSetResetMap;
 };
+export {};

package/lib/mqtt/useRoomProperty.d.ts

@@ -1,4 +1,3 @@
-import { PromiseWithRejection } from './promise';
 import { BaseResponse, RoomPreference } from './type';
 type Response = BaseResponse & RoomPreference & {
     num: number;
@@ -6,7 +5,7 @@ type Response = BaseResponse & RoomPreference & {
 };
 type TSetRoomProperty = (message: Pick<Response, 'num' | 'suctions' | 'cisterns' | 'floorTypes' | 'names' | 'orders' | 'yMops' | 'sweepMopModes' | 'cleanCounts' | 'ids'>) => Promise<RoomPreference>;
 export declare const useRoomProperty: (devId: string) => {
-    requestRoomProperty: () => PromiseWithRejection;
+    requestRoomProperty: () => Promise<Response>;
     setRoomProperty: TSetRoomProperty;
 };
 export {};

package/lib/mqtt/useSchedule.d.ts

@@ -1,5 +1,4 @@
-import { PromiseWithRejection } from './promise';
-import { RoomPreference } from './type';
+import { RoomPreference, BaseResponse } from './type';
 type ScheduleItem = Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes' | 'ids'> & {
     active: number;
     cycle: number[];
@@ -9,8 +8,9 @@ interface Schedule {
     list: Array<ScheduleItem>;
     num: number;
 }
+type Response = BaseResponse & Schedule;
 export declare const useSchedule: (devId: string) => {
-    requestSchedule: () => PromiseWithRejection;
-    setSchedule: (message: Schedule) => PromiseWithRejection;
+    requestSchedule: () => Promise<Response>;
+    setSchedule: (message: Schedule) => Promise<Response>;
 };
 export {};

package/lib/mqtt/useSelectRoomClean.d.ts

@@ -1,11 +1,26 @@
+type Response = {
+    reqType: string;
+    version: string;
+    success: boolean;
+    errCode: number;
+    taskId: string;
+    ids: number[];
+    suctions?: string[];
+    cisterns?: string[];
+    cleanCounts?: number[];
+    yMops?: number[];
+    sweepMopModes?: string[];
+};
+type TSetRoomClean = (message: {
+    ids: number[];
+    suctions?: string[];
+    cisterns?: string[];
+    cleanCounts?: number[];
+    yMops?: number[];
+    sweepMopModes?: string[];
+}) => Promise<Response>;
 export declare const useSelectRoomClean: (devId: string) => {
-    requestSelectRoomClean: () => import("./promise").PromiseWithRejection;
-    setRoomClean: (message: {
-        ids: number[];
-        suctions?: string[] | undefined;
-        cisterns?: string[] | undefined;
-        cleanCounts?: number[] | undefined;
-        yMops?: number[] | undefined;
-        sweepMopModes?: string[] | undefined;
-    }) => Promise<never> | import("./promise").PromiseWithRejection;
+    requestSelectRoomClean: () => Promise<Response>;
+    setRoomClean: TSetRoomClean;
 };
+export {};

package/lib/mqtt/useSpotClean.d.ts

@@ -1,14 +1,18 @@
 import { RoomPreference } from './type';
+type Response = Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
+    polygons: string[];
+    names?: string[];
+};
 type TSetSpotClean = (message: Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
     polygons: string[];
     names?: string[];
-}) => Promise<void>;
+}) => Promise<Response>;
 /**
  * 定点清扫
  * @returns
  */
 export declare const useSpotClean: (devId: string) => {
-    requestSpotClean: () => Promise<void>;
+    requestSpotClean: () => Promise<Response>;
     setSpotClean: TSetSpotClean;
 };
 export {};

package/lib/mqtt/useVirtualArea.d.ts

@@ -1,4 +1,24 @@
+type Response = {
+    reqType: 'restrictedAreaQry';
+    version: string;
+    num: number;
+    modes: number[];
+    polygons: string[];
+    names: string[];
+    mapId: number;
+    success: boolean;
+    errCode: number;
+    taskId: string;
+};
+type TSetVirtualArea = (message: {
+    polygons: string[];
+    names?: string[];
+    modes: number[];
+    num?: number;
+}) => Promise<Response>;
+type TRequestVirtualArea = () => Promise<Response>;
 export declare const useVirtualArea: (devId: string) => {
-    requestVirtualArea: () => any;
-    setVirtualArea: (message: any) => any;
+    requestVirtualArea: TRequestVirtualArea;
+    setVirtualArea: TSetVirtualArea;
 };
+export {};

package/lib/mqtt/useVirtualArea.js

@@ -2,10 +2,24 @@
 import { createSetCommonParams } from './createCommonOptions';
 import { normalResolve } from './promise';
 import { VirtualAreaEnum } from './type';
+import { isArray } from 'lodash-es';
 // 禁区
 
 export const useVirtualArea = devId => {
-  // 请求禁区数据
+  /**
+   * 请求虚拟区域数据
+   * @returns Promise<VirtualAreaResponse> 响应结果
+   */
+
+  /**
+   * 设置虚拟区域数据
+   * @param message 包含虚拟区域设置参数的对象
+   * @param message.polygons 多边形数组，每个元素为一个多边形的坐标字符串
+   * @param message.names 名称数组，每个元素为一个区域的名称
+   * @param message.modes 模式数组，每个元素为一个区域的模式，0:全禁，1:禁扫，2:禁拖
+   * @param message.num 虚拟区域的数量
+   * @returns Promise<VirtualAreaResponse> 响应结果
+   */
 
   return {
     requestVirtualArea: () => {
@@ -17,10 +31,46 @@ export const useVirtualArea = devId => {
       return normalResolve(VirtualAreaEnum.query, params.message.taskId);
     },
     setVirtualArea: message => {
+      const {
+        polygons,
+        num,
+        modes,
+        names
+      } = message || {};
+      if (!isArray(polygons) || isArray(polygons) && polygons.length === 0) {
+        return Promise.reject(new Error('message polygons is required'));
+      }
+      const len = polygons.length;
+      if (!isArray(message.modes) || isArray(message.modes) && message.modes.length === 0) {
+        return Promise.reject(new Error('message modes is required'));
+      }
+      if (num && !Number.isInteger(num)) {
+        return Promise.reject(new Error('num is illegal'));
+      }
+      if (num && num !== len) {
+        return Promise.reject(new Error('num is not equal to points length'));
+      }
+      if (modes && !isArray(modes)) {
+        return Promise.reject(new Error('mode is illegal'));
+      }
+      if (modes && modes.length !== len) {
+        return Promise.reject(new Error('mode length is not equal to points length'));
+      }
+      if (names && !isArray(names)) {
+        return Promise.reject(new Error('names is illegal'));
+      }
+      if (names && names.length !== len) {
+        return Promise.reject(new Error('names length is not equal to points length'));
+      }
       const params = createSetCommonParams({
         deviceId: devId,
         reqType: VirtualAreaEnum.set,
-        message
+        message: {
+          polygons,
+          num: num || len,
+          modes: modes || new Array(len).fill(0),
+          names: names || new Array(len).fill('')
+        }
       });
       ty.device.sendMqttMessage(params);
       return normalResolve(VirtualAreaEnum.query, params.message.taskId);

package/lib/mqtt/useVirtualWall.d.ts

@@ -1,4 +1,22 @@
+type Response = {
+    modes: number[];
+    success: boolean;
+    errCode: number;
+    num: number;
+    reqType: 'virtualWallQry';
+    mapId: number;
+    version: string;
+    taskId: string;
+    points: string[];
+};
+type TRequestVirtualWall = () => Promise<Response>;
+type TSetVirtualWall = (message: {
+    points: string[];
+    num?: number;
+    mode?: number[];
+}) => Promise<Response>;
 export declare const useVirtualWall: (devId: string) => {
-    requestVirtualWall: () => import("./promise").PromiseWithRejection;
-    setVirtualWall: (message: any) => import("./promise").PromiseWithRejection;
+    requestVirtualWall: TRequestVirtualWall;
+    setVirtualWall: TSetVirtualWall;
 };
+export {};

package/lib/mqtt/useVirtualWall.js

@@ -4,13 +4,17 @@ import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
 import { createSetCommonParams } from './createCommonOptions';
 import { normalResolve } from './promise';
 import { VirtualWallEnum } from './type';
+import { isArray } from 'lodash-es';
 export const useVirtualWall = devId => {
   // 请求虚拟墙数据
 
   /**
-   *  设置虚拟墙数据
-   * @param message 下发给设备的数据
-   * @param isVerify
+   * 设置虚拟墙数据
+   * @param message 包含虚拟墙设置参数的对象
+   * @param message.points 虚拟墙的点数组
+   * @param message.num 虚拟墙的数量（可选）
+   * @param message.mode 虚拟墙的模式数组（可选）
+   * @returns Promise<Response> 响应结果
    */
 
   return {
@@ -24,10 +28,35 @@ export const useVirtualWall = devId => {
     },
     setVirtualWall: message => {
       const requestParams = _objectSpread({}, message);
+      if (!isArray(requestParams.points) || requestParams.points.length === 0) {
+        return Promise.reject(new Error('points is illegal'));
+      }
+      const len = requestParams.points.length;
+      if (requestParams.num && !Number.isInteger(requestParams.num)) {
+        return Promise.reject(new Error('num is illegal'));
+      }
+      if (requestParams.num && requestParams.num !== len) {
+        return Promise.reject(new Error('num is not equal to points length'));
+      }
+      if (requestParams.mode && !isArray(requestParams.mode)) {
+        return Promise.reject(new Error('mode is illegal'));
+      }
+      if (requestParams.mode && requestParams.mode.length !== len) {
+        return Promise.reject(new Error('mode length is not equal to points length'));
+      }
+      const {
+        points,
+        num,
+        mode
+      } = requestParams;
       const params = createSetCommonParams({
         deviceId: devId,
         reqType: VirtualWallEnum.set,
-        message: requestParams
+        message: {
+          points,
+          num: num || len,
+          mode: mode || new Array(len).fill(-1)
+        }
       });
       ty.device.sendMqttMessage(params);
       return normalResolve(VirtualWallEnum.query, params.message.taskId);

package/lib/mqtt/useVoice.d.ts

@@ -1,10 +1,19 @@
-import { PromiseWithRejection } from './promise';
+interface VoiceLanguageResponse {
+    reqType: string;
+    version: string;
+    id: number;
+    schedule: number;
+    status: number;
+    success: boolean;
+    errCode: number;
+    taskId: string;
+}
 type TSetVoice = (message: {
     id: number;
     url: string;
     md5: string;
-}) => PromiseWithRejection;
-type TRequestVoiceInUse = () => PromiseWithRejection;
+}) => Promise<VoiceLanguageResponse>;
+type TRequestVoiceInUse = () => Promise<VoiceLanguageResponse>;
 /**
  * 自定义 Hook，用于语音语言设置
  * @param devId 设备ID

package/lib/mqtt/useZoneClean.d.ts

@@ -1,14 +1,27 @@
 import { RoomPreference } from './type';
+type Response = {
+    reqType: string;
+    version: string;
+    success: boolean;
+    errCode: number;
+    taskId: string;
+    polygons: string[];
+    suctions?: string[];
+    cisterns?: string[];
+    cleanCounts?: number[];
+    yMops?: number[];
+    sweepMopModes?: string[];
+};
 type TSetZoneClean = (message: Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
     polygons: string[];
     names?: string[];
-}) => Promise<void>;
+}) => Promise<Response>;
 /**
  * 划区清扫
  * @returns
  */
 export declare const useZoneClean: (devId: string) => {
-    requestZoneClean: () => Promise<void>;
+    requestZoneClean: () => Promise<Response>;
     setZoneClean: TSetZoneClean;
 };
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/robot-data-stream",
-  "version": "0.0.10-beta-12",
+  "version": "0.0.10-beta-13",
   "description": "扫地机P2P数据流标准化组件",
   "main": "lib/index",
   "files": [