@switchbot/homebridge-switchbot 5.0.0-beta.52 → 5.0.0-beta.54

package/dist/devices-matter/RoboticVacuumAccessory.d.ts

@@ -1,29 +1,38 @@
 /**
- * Robotic Vacuum Cleaner Accessory Class
+ * Robotic Vacuum Cleaner Accessory (SwitchBot-aligned)
  *
- * This is a comprehensive example demonstrating all available features
- * of the RoboticVacuumCleaner device type including:
- * - Multiple run modes (Idle, Cleaning, Mapping)
- * - Multiple clean modes (Vacuum, Mop, Vacuum & Mop, Deep Clean)
- * - Operational state management with realistic transitions
- * - Service area (room) support
+ * This implementation is intentionally limited to SwitchBot OpenAPI-supported
+ * behaviors for Robot Vacuum families. We expose only commands and modes that
+ * exist in the public API docs:
+ * https://github.com/OpenWonderLabs/SwitchBotAPI
  *
- * IMPORTANT: Platform Matter accessories
- * =======================================
- * This vacuum is registered as a platform accessory using
- * api.matter.registerPlatformAccessories(), which works the same as HAP.
- * Platform accessories are registered synchronously and are immediately ready for use.
+ * Capability matrix (derived from OpenAPI v1.1):
+ * - S1 / S1 Plus / K10+ / K10+ Pro
+ *   • Commands: start, stop, dock, PowLevel {0-3}
+ *   • No pause/resume, no mop, no area selection
+ * - K10+ Pro Combo
+ *   • Commands: startClean {action: sweep|mop, param: {fanLevel 1-4}}, pause, dock
+ *   • changeParam {fanLevel}, setVolume
+ * - S10 / S20 / K11+ / K20+ Pro
+ *   • Commands: startClean {action: sweep|sweep_mop|mop (model-dependent), param: {fanLevel 1-4, waterLevel 1-2?}},
+ *               pause, dock, changeParam, setVolume, (S10/S20) selfClean/addWaterForHumi
+ *   • Some models support waterLevel, some do not (e.g. K10+ Pro Combo)
  *
- * Demo behavior:
- * - Start/Resume: Sets run mode to "Cleaning", runs for 15/10 seconds, then returns to dock
- * - Return to dock: Immediately sets "Idle" mode, then Seeking (5s) → Charging (3s) → Docked
- * - Stop: Immediately stops and resets to "Idle" mode
- * - Pause: Cancels automatic completion timer, keeps "Cleaning" mode
+ * Matter clusters exposed:
+ * - rvcRunMode: Idle/Cleaning only (no Mapping mode via OpenAPI)
+ * - rvcCleanMode: Interpreted per model:
+ *   • Basic vac (S1/K10 family): suction levels → Quiet/Standard/Strong/MAX
+ *   • Mop-capable (K10+ Pro Combo/K11+/K20+ Pro): action → Vacuum or Mop
+ *   • Mop+Vac-capable (S10/S20): action → Vacuum or Vacuum & Mop
+ * - rvcOperationalState: start/stop/pause/goHome handlers are attached only when supported
+ * - serviceArea: NOT exposed (area/room selection isn’t in public OpenAPI)
  */
 import type { API, Logger } from 'homebridge';
 import { BaseMatterAccessory } from './BaseMatterAccessory.js';
 export declare class RoboticVacuumAccessory extends BaseMatterAccessory {
-    private activeTimers;
+    private currentCleanAction;
+    private currentFanLevel;
+    private capabilities;
     constructor(api: API, log: Logger, opts?: Partial<import('./BaseMatterAccessory').BaseMatterAccessoryConfig & {
         deviceId?: string;
     }>);
@@ -34,43 +43,11 @@ export declare class RoboticVacuumAccessory extends BaseMatterAccessory {
     private handleStart;
     private handleResume;
     private handleGoHome;
-    private handleSelectAreas;
-    private handleSkipArea;
-    /**
-     * Helper method to clear all active timers
-     */
-    private clearTimers;
-    /**
-     * Helper method to initiate return to dock sequence
-     * Can be called synchronously from other handlers
-     */
-    private returnToDock;
-    /**
-     * Update Methods - Use these to update the vacuum state from your API/device
-     *
-     * Since this is a platform accessory, state updates work immediately after registration.
-     */
     updateOperationalState(state: number): void;
     updateRunMode(mode: number): void;
     updateCleanMode(mode: number): void;
-    updateSelectedAreas(areaIds: number[]): void;
-    updateCurrentArea(areaId: number | null): void;
-    updateProgress(progress: Array<{
-        areaId: number;
-        status: number;
-    }>): void;
     /**
-     * Update battery percentage
-     *
-     * Note: The Matter specification for RoboticVacuumCleaner does not include
-     * the PowerSource cluster. Battery information for robotic vacuums should be
-     * communicated through device-specific status reporting or via the RVC
-     * operational state cluster.
-     *
-     * This method is retained for API compatibility but does not update any
-     * Matter cluster state.
-     *
-     * @param percentageOrBatPercentRemaining - Battery percentage (0-100) or batPercentRemaining (0-200)
+     * Update battery percentage (no PowerSource cluster for this device type)
      */
     updateBatteryPercentage(percentageOrBatPercentRemaining: number): Promise<void>;
 }

package/dist/devices-matter/RoboticVacuumAccessory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"RoboticVacuumAccessory.d.ts","sourceRoot":"","sources":["../../src/devices-matter/RoboticVacuumAccessory.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAkB,MAAM,YAAY,CAAA;AAE7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D,OAAO,CAAC,YAAY,CAAuB;gBAE/B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,uBAAuB,EAAE,yBAAyB,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;YA+EtH,mBAAmB;YAuCnB,qBAAqB;YAyBrB,WAAW;YAOX,UAAU;YAQV,WAAW;YAoBX,YAAY;YAoBZ,YAAY;YAiBZ,iBAAiB;YAUjB,cAAc;IAQ5B;;OAEG;IACH,OAAO,CAAC,WAAW;IAKnB;;;OAGG;IACH,OAAO,CAAC,YAAY;IA0BpB;;;;OAIG;IAEI,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAmB3C,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMjC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAsBnC,mBAAmB,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAQ5C,iBAAiB,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAU9C,cAAc,CAAC,QAAQ,EAAE,KAAK,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAA;KAAE,CAAC,GAAG,IAAI;IAKhF;;;;;;;;;;;;OAYG;IACU,uBAAuB,CAAC,+BAA+B,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAwB7F"}
+{"version":3,"file":"RoboticVacuumAccessory.d.ts","sourceRoot":"","sources":["../../src/devices-matter/RoboticVacuumAccessory.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAkB,MAAM,YAAY,CAAA;AAE7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAwH9D,qBAAa,sBAAuB,SAAQ,mBAAmB;IAE7D,OAAO,CAAC,kBAAkB,CAA4C;IACtE,OAAO,CAAC,eAAe,CAAmB;IAC1C,OAAO,CAAC,YAAY,CAAoB;gBAE5B,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,OAAO,uBAAuB,EAAE,yBAAyB,GAAG;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;YAuFtH,mBAAmB;YAYnB,qBAAqB;YA6CrB,WAAW;YAYX,UAAU;YAmBV,WAAW;YAwBX,YAAY;YAKZ,YAAY;IAanB,sBAAsB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAc3C,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAMjC,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI;IAa1C;;OAEG;IACU,uBAAuB,CAAC,+BAA+B,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAoB7F"}