@ray-js/robot-data-stream 0.0.13-beta-5 → 0.0.13-beta-7

package/lib/mqtt/useSchedule.js

@@ -8,39 +8,51 @@ import { SingletonContext } from './mqttProvider';
 import { encodeDeviceTimer0x30 } from '@ray-js/robot-protocol';
 import { CISTERN_MAP, CLEAN_MODE_MAP, SUCTION_MAP } from '../constant';
 
-// 定时任务
+// 定时任务项
 
+// 定时任务数据
+
+// 定时任务响应类型
+
+// 请求定时数据函数类型定义
+
+// 设置定时数据函数类型定义
+
+/**
+ * 自定义 Hook，用于定时任务
+ * @param devId 设备ID
+ * @returns 包含 requestSchedule 和 setSchedule 函数的对象
+ */
 export const useSchedule = devId => {
   const {
     useMqtt,
     devices,
     commandVersion
   } = useContext(SingletonContext);
-  // 请求定时数据
+  /**
+   * 请求定时数据
+   * @param message 可选参数，包含版本号
+   * @returns Promise<ScheduleResponse> 响应结果
+   */
 
-  // 下发定时数据
+  /**
+   * 设置定时数据
+   * @param message 定时任务数据
+   * @returns Promise<ScheduleResponse> 响应结果
+   */
 
   return {
     requestSchedule: function () {
       let message = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {
         version: '1.0.0'
       };
-      const params = createSetCommonParams({
-        deviceId: devId,
-        reqType: ScheduleEnum.query,
-        message
-      });
-      ty.device.sendMqttMessage(params);
-      const {
-        taskId
-      } = params.message;
-      return normalResolve(ScheduleEnum.query, taskId);
-    },
-    setSchedule: message => {
-      if (useMqtt) {
+      if (!useMqtt) {
+        return Promise.reject(new Error('useMqtt is not used'));
+      }
+      try {
         const params = createSetCommonParams({
           deviceId: devId,
-          reqType: ScheduleEnum.set,
+          reqType: ScheduleEnum.query,
           message
         });
         ty.device.sendMqttMessage(params);
@@ -48,39 +60,79 @@ export const useSchedule = devId => {
           taskId
         } = params.message;
         return normalResolve(ScheduleEnum.query, taskId);
+      } catch (error) {
+        return Promise.reject(error instanceof Error ? error : new Error('Failed to request schedule'));
+      }
+    },
+    setSchedule: message => {
+      // 参数验证
+      if (!message || typeof message.num !== 'number') {
+        throw new Error('message.num is required and must be a number');
+      }
+      if (!Array.isArray(message.list)) {
+        throw new Error('message.list is required and must be an array');
+      }
+      if (message.num !== message.list.length) {
+        throw new Error('message.num must equal message.list.length');
+      }
+      try {
+        if (useMqtt) {
+          const params = createSetCommonParams({
+            deviceId: devId,
+            reqType: ScheduleEnum.set,
+            message
+          });
+          ty.device.sendMqttMessage(params);
+          const {
+            taskId
+          } = params.message;
+          return normalResolve(ScheduleEnum.query, taskId);
+        }
+
+        // 非 MQTT 模式：使用命令传输
+        const command = encodeDeviceTimer0x30({
+          version: commandVersion,
+          number: message.num,
+          list: message.list.map(_ref => {
+            let {
+              active,
+              suctions,
+              sweepMopModes,
+              ids,
+              cleanCounts,
+              cycle,
+              cisterns,
+              time
+            } = _ref;
+            return {
+              effectiveness: active,
+              cleanMode: CLEAN_MODE_MAP[sweepMopModes[0]],
+              fanLevel: SUCTION_MAP[suctions[0]],
+              waterLevel: CISTERN_MAP[cisterns[0]],
+              time: {
+                hour: time[0],
+                minute: time[1]
+              },
+              week: cycle,
+              sweepCount: cleanCounts[0],
+              roomIds: ids,
+              roomNum: ids.length
+            };
+          })
+        });
+        devices.common.model.actions.device_timer.set(command);
+        return Promise.resolve({
+          success: true,
+          errCode: 0,
+          reqType: ScheduleEnum.query,
+          version: commandVersion,
+          taskId: `${Date.now()}`,
+          list: message.list,
+          num: message.num
+        });
+      } catch (error) {
+        throw error instanceof Error ? error : new Error('Failed to set schedule');
       }
-      const command = encodeDeviceTimer0x30({
-        version: commandVersion,
-        number: message.num,
-        list: message.list.map(_ref => {
-          let {
-            active,
-            suctions,
-            sweepMopModes,
-            ids,
-            cleanCounts,
-            cycle,
-            cisterns,
-            time
-          } = _ref;
-          return {
-            effectiveness: active,
-            cleanMode: CLEAN_MODE_MAP[sweepMopModes[0]],
-            fanLevel: SUCTION_MAP[suctions[0]],
-            waterLevel: CISTERN_MAP[cisterns[0]],
-            time: {
-              hour: time[0],
-              minute: time[1]
-            },
-            week: cycle,
-            sweepCount: cleanCounts[0],
-            roomIds: ids,
-            roomNum: ids.length
-          };
-        })
-      });
-      devices.common.model.actions.device_timer.set(command);
-      return Promise.resolve();
     }
   };
 };

package/lib/mqtt/useSelectRoomClean.d.ts

@@ -1,26 +1,30 @@
-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 = (rooms: {
+import { BaseResponse, RoomCleanSetEnum } from './type';
+interface RoomInfo {
     roomId: number;
     suction?: string;
     cistern: string;
     cleanTimes?: number;
     yMop?: number;
     sweepMopMode?: string;
-}[]) => Promise<Response> | Promise<void>;
+}
+interface RoomCleanResponse extends BaseResponse {
+    reqType: RoomCleanSetEnum.query;
+    ids: number[];
+    suctions?: string[];
+    cisterns?: string[];
+    cleanCounts?: number[];
+    yMops?: number[];
+    sweepMopModes?: string[];
+}
+type TSetRoomClean = (rooms: RoomInfo[]) => Promise<RoomCleanResponse>;
+type TRequestSelectRoomClean = () => Promise<RoomCleanResponse>;
+/**
+ * 自定义 Hook，用于选区清扫
+ * @param devId 设备ID
+ * @returns 包含 requestSelectRoomClean 和 setRoomClean 函数的对象
+ */
 export declare const useSelectRoomClean: (devId: string) => {
-    requestSelectRoomClean: () => Promise<Response>;
+    requestSelectRoomClean: TRequestSelectRoomClean;
     setRoomClean: TSetRoomClean;
 };
 export {};

package/lib/mqtt/useSelectRoomClean.js

@@ -8,6 +8,20 @@ import { normalResolve } from './promise';
 import { useContext } from 'react';
 import { SingletonContext } from './mqttProvider';
 import { encodeRoomClean0x14, requestRoomClean0x15 } from '@ray-js/robot-protocol';
+
+// 房间信息
+
+// 选区清扫响应类型
+
+// 设置选区清扫函数类型定义
+
+// 请求选区清扫函数类型定义
+
+/**
+ * 自定义 Hook，用于选区清扫
+ * @param devId 设备ID
+ * @returns 包含 requestSelectRoomClean 和 setRoomClean 函数的对象
+ */
 export const useSelectRoomClean = devId => {
   const {
     useMqtt,
@@ -15,66 +29,148 @@ export const useSelectRoomClean = devId => {
     devices
   } = useContext(SingletonContext);
 
-  // 请求选区清扫信息
+  /**
+   * 请求选区清扫信息
+   * @returns Promise<RoomCleanResponse> 响应结果
+   */
 
-  // 设置选区清扫
-  // 选区清扫的清扫属性，当全局模式下使用全局的清扫属性，当自定义模式下，使用房间自定义的清扫属性
+  /**
+   * 设置选区清扫
+   * 选区清扫的清扫属性，当全局模式下使用全局的清扫属性，当自定义模式下，使用房间自定义的清扫属性
+   * @param rooms 房间信息数组
+   * @returns Promise<RoomCleanResponse> 响应结果
+   */
 
   return {
     requestSelectRoomClean: () => {
-      if (useMqtt) {
-        const params = createSetCommonParams({
-          deviceId: devId,
-          reqType: RoomCleanSetEnum.query
+      try {
+        if (useMqtt) {
+          const params = createSetCommonParams({
+            deviceId: devId,
+            reqType: RoomCleanSetEnum.query
+          });
+          ty.device.sendMqttMessage(params);
+          const {
+            taskId
+          } = params.message;
+          return normalResolve(RoomCleanSetEnum.query, taskId);
+        }
+
+        // 非 MQTT 模式：使用命令传输
+        devices.common.model.actions.command_trans.set(requestRoomClean0x15({
+          version: commandVersion
+        }));
+
+        // 非 MQTT 模式下无法立即获取响应数据，返回默认响应
+        return Promise.resolve({
+          success: true,
+          errCode: 0,
+          reqType: RoomCleanSetEnum.query,
+          version: commandVersion,
+          taskId: `${Date.now()}`,
+          ids: [],
+          suctions: [],
+          cisterns: [],
+          cleanCounts: [],
+          yMops: [],
+          sweepMopModes: []
         });
-        ty.device.sendMqttMessage(params);
-        return normalResolve(RoomCleanSetEnum.query, params.message.taskId);
+      } catch (error) {
+        return Promise.reject(error instanceof Error ? error : new Error('Failed to request select room clean'));
       }
-      return devices.common.model.actions.command_trans.set(requestRoomClean0x15({
-        version: commandVersion
-      }));
     },
     setRoomClean: rooms => {
-      var _rooms$0$cleanTimes, _rooms$;
-      if (useMqtt) {
-        const ids = [];
-        const suctions = [];
-        const cisterns = [];
-        const cleanCounts = [];
-        const yMops = [];
-        const sweepMopModes = [];
-        rooms.forEach(room => {
-          var _room$suction, _room$cleanTimes, _room$yMop, _room$sweepMopMode;
-          ids.push(room.roomId);
-          suctions.push((_room$suction = room.suction) !== null && _room$suction !== void 0 ? _room$suction : '');
-          cisterns.push(room.cistern);
-          cleanCounts.push((_room$cleanTimes = room.cleanTimes) !== null && _room$cleanTimes !== void 0 ? _room$cleanTimes : 1);
-          yMops.push((_room$yMop = room.yMop) !== null && _room$yMop !== void 0 ? _room$yMop : -1);
-          sweepMopModes.push((_room$sweepMopMode = room.sweepMopMode) !== null && _room$sweepMopMode !== void 0 ? _room$sweepMopMode : 'only_sweep');
+      // 参数验证
+      if (!Array.isArray(rooms) || rooms.length === 0) {
+        throw new Error('rooms is required and must be a non-empty array');
+      }
+      rooms.forEach((room, index) => {
+        if (typeof room.roomId !== 'number') {
+          throw new Error(`rooms[${index}].roomId is required and must be a number`);
+        }
+        if (!room.cistern || typeof room.cistern !== 'string') {
+          throw new Error(`rooms[${index}].cistern is required and must be a string`);
+        }
+      });
+      try {
+        var _rooms$0$cleanTimes, _rooms$;
+        if (useMqtt) {
+          const ids = [];
+          const suctions = [];
+          const cisterns = [];
+          const cleanCounts = [];
+          const yMops = [];
+          const sweepMopModes = [];
+          rooms.forEach(room => {
+            var _room$suction, _room$cleanTimes, _room$yMop, _room$sweepMopMode;
+            ids.push(room.roomId);
+            suctions.push((_room$suction = room.suction) !== null && _room$suction !== void 0 ? _room$suction : '');
+            cisterns.push(room.cistern);
+            cleanCounts.push((_room$cleanTimes = room.cleanTimes) !== null && _room$cleanTimes !== void 0 ? _room$cleanTimes : 1);
+            yMops.push((_room$yMop = room.yMop) !== null && _room$yMop !== void 0 ? _room$yMop : -1);
+            sweepMopModes.push((_room$sweepMopMode = room.sweepMopMode) !== null && _room$sweepMopMode !== void 0 ? _room$sweepMopMode : 'only_sweep');
+          });
+          const params = createSetCommonParams({
+            deviceId: devId,
+            reqType: RoomCleanSetEnum.set,
+            message: {
+              ids,
+              suctions,
+              cisterns,
+              cleanCounts,
+              yMops,
+              sweepMopModes,
+              num: rooms.length
+            }
+          });
+          ty.device.sendMqttMessage(params);
+          const {
+            taskId
+          } = params.message;
+          return normalResolve(RoomCleanSetEnum.query, taskId);
+        }
+
+        // 非 MQTT 模式：使用命令传输
+        const command = encodeRoomClean0x14({
+          version: commandVersion,
+          roomIds: rooms.map(room => room.roomId),
+          cleanTimes: (_rooms$0$cleanTimes = (_rooms$ = rooms[0]) === null || _rooms$ === void 0 ? void 0 : _rooms$.cleanTimes) !== null && _rooms$0$cleanTimes !== void 0 ? _rooms$0$cleanTimes : 1
+        });
+        devices.common.model.actions.command_trans.set(command);
+        const ids = rooms.map(room => room.roomId);
+        const suctions = rooms.map(room => {
+          var _room$suction2;
+          return (_room$suction2 = room.suction) !== null && _room$suction2 !== void 0 ? _room$suction2 : '';
+        });
+        const cisterns = rooms.map(room => room.cistern);
+        const cleanCounts = rooms.map(room => {
+          var _room$cleanTimes2;
+          return (_room$cleanTimes2 = room.cleanTimes) !== null && _room$cleanTimes2 !== void 0 ? _room$cleanTimes2 : 1;
         });
-        const params = createSetCommonParams({
-          deviceId: devId,
-          reqType: RoomCleanSetEnum.set,
-          message: {
-            ids,
-            suctions,
-            cisterns,
-            cleanCounts,
-            yMops,
-            sweepMopModes,
-            num: rooms.length
-          }
+        const yMops = rooms.map(room => {
+          var _room$yMop2;
+          return (_room$yMop2 = room.yMop) !== null && _room$yMop2 !== void 0 ? _room$yMop2 : -1;
         });
-        ty.device.sendMqttMessage(params);
-        return normalResolve(RoomCleanSetEnum.query, params.message.taskId);
+        const sweepMopModes = rooms.map(room => {
+          var _room$sweepMopMode2;
+          return (_room$sweepMopMode2 = room.sweepMopMode) !== null && _room$sweepMopMode2 !== void 0 ? _room$sweepMopMode2 : 'only_sweep';
+        });
+        return Promise.resolve({
+          success: true,
+          errCode: 0,
+          reqType: RoomCleanSetEnum.query,
+          version: commandVersion,
+          taskId: `${Date.now()}`,
+          ids,
+          suctions,
+          cisterns,
+          cleanCounts,
+          yMops,
+          sweepMopModes
+        });
+      } catch (error) {
+        throw error instanceof Error ? error : new Error('Failed to set room clean');
       }
-      const command = encodeRoomClean0x14({
-        version: commandVersion,
-        roomIds: rooms.map(room => room.roomId),
-        cleanTimes: (_rooms$0$cleanTimes = (_rooms$ = rooms[0]) === null || _rooms$ === void 0 ? void 0 : _rooms$.cleanTimes) !== null && _rooms$0$cleanTimes !== void 0 ? _rooms$0$cleanTimes : 1
-      });
-      devices.common.model.actions.command_trans.set(command);
-      return Promise.resolve();
     }
   };
 };

package/lib/mqtt/useSpotClean.d.ts

@@ -1,13 +1,13 @@
-import { RoomPreference } from './type';
+import { BaseResponse, RoomPreference } from './type';
 import { Point } from '@ray-js/robot-protocol';
-type Response = Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
+type Response = BaseResponse & Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
     polygons: string[];
     names?: string[];
 };
 type TSetSpotClean = (message: Partial<Pick<RoomPreference, 'suctions' | 'cisterns' | 'cleanCounts' | 'yMops' | 'sweepMopModes'>> & {
     spots: Point[];
     origin?: Point;
-}) => Promise<Response | void>;
+}) => Promise<Response>;
 /**
  * 定点清扫
  * @returns

package/lib/mqtt/useSpotClean.js

@@ -1,3 +1,4 @@
+import "core-js/modules/esnext.iterator.map.js";
 // 定点清扫
 
 import { isArray } from 'lodash-es';
@@ -38,59 +39,80 @@ export const useSpotClean = devId => {
         spots,
         origin
       } = message;
-      if (useMqtt) {
-        if (!isArray(spots) || isArray(spots) && spots.length === 0) {
-          return Promise.reject(new Error('message is required'));
-        }
-        const num = spots.length;
-        const {
-          suctions = new Array(num).fill(''),
-          cisterns = new Array(num).fill(''),
-          cleanCounts = new Array(num).fill(1),
-          yMops = new Array(num).fill(-1),
-          sweepMopModes = new Array(num).fill('only_sweep')
-        } = message;
-        if (suctions && !isArray(suctions)) {
-          return Promise.reject(new Error('suctions is illegal'));
-        }
-        if (cisterns && !isArray(cisterns)) {
-          return Promise.reject(new Error('cisterns is illegal'));
-        }
-        if (cleanCounts && !isArray(cleanCounts)) {
-          return Promise.reject(new Error('cleanCounts is illegal'));
-        }
-        if (yMops && !isArray(yMops)) {
-          return Promise.reject(new Error('yMops is illegal'));
-        }
-        if (sweepMopModes && !isArray(sweepMopModes)) {
-          return Promise.reject(new Error('sweepMopModes is illegal'));
-        }
-        if (num !== suctions.length || num !== cisterns.length || num !== cleanCounts.length || num !== yMops.length || num !== sweepMopModes.length) {
-          return Promise.reject(new Error('The length of the parameters is inconsistent'));
-        }
-        const params = createSetCommonParams({
-          deviceId: devId,
-          reqType: SpotCleanEnum.set,
-          message: {
-            num,
-            polygons: [pointsToString(spots, origin)],
-            suctions,
-            cisterns,
-            cleanCounts,
-            yMops,
-            sweepMopModes
+      if (!origin || typeof origin.x !== 'number' || typeof origin.y !== 'number') {
+        throw new Error('origin is required and must be a valid Point object with x and y properties');
+      }
+      try {
+        if (useMqtt) {
+          const num = spots.length;
+          const {
+            suctions = new Array(num).fill(''),
+            cisterns = new Array(num).fill(''),
+            cleanCounts = new Array(num).fill(1),
+            yMops = new Array(num).fill(-1),
+            sweepMopModes = new Array(num).fill('only_sweep')
+          } = message;
+          if (suctions && !isArray(suctions)) {
+            throw new Error('suctions is illegal');
+          }
+          if (cisterns && !isArray(cisterns)) {
+            throw new Error('cisterns is illegal');
           }
+          if (cleanCounts && !isArray(cleanCounts)) {
+            throw new Error('cleanCounts is illegal');
+          }
+          if (yMops && !isArray(yMops)) {
+            throw new Error('yMops is illegal');
+          }
+          if (sweepMopModes && !isArray(sweepMopModes)) {
+            throw new Error('sweepMopModes is illegal');
+          }
+          if (num !== suctions.length || num !== cisterns.length || num !== cleanCounts.length || num !== yMops.length || num !== sweepMopModes.length) {
+            throw new Error('The length of the parameters is inconsistent');
+          }
+          const params = createSetCommonParams({
+            deviceId: devId,
+            reqType: SpotCleanEnum.set,
+            message: {
+              num,
+              polygons: spots.map(spot => pointsToString([spot], origin)),
+              suctions,
+              cisterns,
+              cleanCounts,
+              yMops,
+              sweepMopModes
+            }
+          });
+          ty.device.sendMqttMessage(params);
+          const {
+            taskId
+          } = params.message;
+          return normalResolve(SpotCleanEnum.query, taskId);
+        }
+
+        // 非 MQTT 模式：使用命令传输
+        const command = encodeSpotClean0x16({
+          version: commandVersion,
+          origin,
+          point: spots[0]
         });
-        ty.device.sendMqttMessage(params);
-        return normalResolve(SpotCleanEnum.query, params.message.taskId);
+        devices.common.model.actions.command_trans.set(command);
+        return Promise.resolve({
+          success: true,
+          errCode: 0,
+          reqType: SpotCleanEnum.query,
+          version: commandVersion,
+          taskId: `${Date.now()}`,
+          polygons: spots.map(spot => pointsToString([spot], origin)),
+          suctions: message.suctions,
+          cisterns: message.cisterns,
+          cleanCounts: message.cleanCounts,
+          yMops: message.yMops,
+          sweepMopModes: message.sweepMopModes
+        });
+      } catch (error) {
+        throw error instanceof Error ? error : new Error('Failed to set spot clean');
       }
-      const command = encodeSpotClean0x16({
-        version: commandVersion,
-        origin,
-        point: spots[0]
-      });
-      devices.common.model.actions.command_trans.set(command);
-      return Promise.resolve();
     }
   };
 };

package/lib/mqtt/useVirtualArea.d.ts

@@ -1,21 +1,18 @@
+import { BaseResponse, VirtualAreaEnum } from './type';
 import { Point, VirtualArea } from '@ray-js/robot-protocol';
-type Response = {
-    reqType: 'restrictedAreaQry';
-    version: string;
+interface VirtualAreaResponse extends BaseResponse {
+    reqType: VirtualAreaEnum.query;
     num: number;
     modes: number[];
     polygons: string[];
     names: string[];
     mapId: number;
-    success: boolean;
-    errCode: number;
-    taskId: string;
-};
+}
 type TSetVirtualArea = (message: {
     data: VirtualArea[];
     origin: Point;
-}) => Promise<Response> | Promise<void>;
-type TRequestVirtualArea = () => Promise<Response>;
+}) => Promise<VirtualAreaResponse>;
+type TRequestVirtualArea = () => Promise<VirtualAreaResponse>;
 export declare const useVirtualArea: (devId: string) => {
     requestVirtualArea: TRequestVirtualArea;
     setVirtualArea: TSetVirtualArea;