@homebridge-plugins/homebridge-sharkiq 2.0.0-beta.2 → 2.0.0-beta.20

package/CHANGELOG.md

@@ -2,11 +2,27 @@
 
 All notable changes to this project will be documented in this file. This project uses [Semantic Versioning](https://semver.org/)
 
-## [1.4.1] (TBD)
+## [2.0.0] (https://github.com/homebridge-plugins/homebridge-sharkiq/releases/tag/v2.0.0) (2025-XX-XX)
+
+### Breaking Changes
+- This release is Matter-only. The plugin now publishes external Matter Robotic Vacuum Cleaner accessories and no longer publishes HAP platform accessories. If you need the legacy HAP behavior, continue using a pre-2.0 release or a branch that preserves the HAP path.
+- Minimum required Homebridge: >= 2.0.0-alpha.28 (or later) with Matter support exposed via `api.matter`.
+
+### What's Changed
+- Converted plugin to Matter-only and added Matter external accessory publishing for Robotic Vacuum Cleaner devices.
+- Added lifecycle wiring so accessories wait for READY before initial sync and polling.
+- Added retry/backoff for critical Ayla API calls.
+- Removed HAP-specific configuration options (invertDockedStatus, dockedUpdateInterval, enhancedVacuumMode).
+
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-sharkiq/compare/v1.4.1...v2.0.0
+
+## [1.4.1] (https://github.com/homebridge-plugins/homebridge-sharkiq/releases/tag/v1.4.1) (2025-XX-XX)
 
 ### What's Changed
 - Fix ARM64 OAuth code handling for users with both email/password and OAuth code [#54](https://github.com/homebridge-plugins/homebridge-sharkiq/issues/54)
 
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-sharkiq/compare/v1.4.0...v1.4.1
+
 ## [1.4.0](https://github.com/homebridge-plugins/homebridge-sharkiq/releases/tag/v1.4.0) (2025-07-17)
 
 ### What's Changes
@@ -14,4 +30,5 @@ All notable changes to this project will be documented in this file. This projec
 - Fix JSON parsing errors in SharkIQ API responses [#44](https://github.com/homebridge-plugins/homebridge-sharkiq/pull/44) [@mmenanno](https://github.com/mmenanno)
 - Housekeeping and updated dependencies.
 
-**Full Changelog**: https://github.com/homebridge-plugins/homebridge-sharkiq/compare/v1.3.2...v1.4.0
+**Full Changelog**: https://github.com/homebridge-plugins/homebridge-sharkiq/compare/v1.3.2...v1.4.0
+

package/README.md

@@ -39,10 +39,7 @@ Configure Homebridge. The config file for SharkIQ should include:
         "[Shark Vacuum DSN]",
         "..."
       ],
-      "europe": false,
-      "invertDockedStatus": false,
-      "dockedUpdateInterval": 30000,
-      "enhancedVacuumMode": true
+      "europe": false
     }
   ]
 }
@@ -78,6 +75,15 @@ The `enhancedVacuumMode` option (enabled by default) provides improved vacuum be
 
 ## Homebridge 2.0.0+ Compatibility
 
+This release of the plugin is Matter-only and requires a Homebridge runtime that exposes the Matter API.
+Minimum tested Homebridge: 2.0.0-alpha.28 or later. If your Homebridge installation does not support Matter, this plugin will log an error and will not start.
+
+This plugin uses Matter external accessories (Robotic Vacuum Cleaner) to integrate with the platform and no longer publishes HAP platform accessories.
+
+If you rely on the legacy HAP (HomeKit) path, keep using an older plugin release or run this code from a separate branch — this release intentionally removes HAP fallback.
+
+Compatibility notes and behavior:
+
 This plugin is compatible with Homebridge 2.0.0-alpha.28 and later versions, providing enhanced vacuum functionality while maintaining compatibility with current HomeKit limitations:
 
 - **Current Implementation**: Uses optimized FanV2 service with vacuum-specific behavior
@@ -109,3 +115,34 @@ Contributions would be very helpful to help this Homebridge plugin stay maintain
 ## Useful Links
 
 - [SharkIQ Python](https://github.com/JeffResc/sharkiq/)
+
+## Integration checklist — Matter
+
+Follow these steps to verify Matter integration locally on a Homebridge instance that supports Matter (Homebridge >= 2.0.0-alpha.28):
+
+1. Ensure your Homebridge runtime supports Matter and the `api.matter` external accessory API.
+2. Configure the plugin in `config.json` with your Shark credentials or `oAuthCode` and do NOT include deprecated HAP-only options (the plugin is Matter-only).
+3. Start Homebridge in a terminal and watch logs. You should see the plugin log the DSNs found on your account and then a "Publishing X robotic device(s) as external Matter accessories" message.
+4. After publishing, Homebridge should emit READY/COMMISSIONED events for each accessory. The plugin will perform an initial sync and start polling.
+5. From the Home app or a Matter controller, attempt these actions and verify the vacuum responds:
+
+- Start / Stop cleaning
+- Pause / Resume
+- Go Home (return to dock)
+- Select Areas (if your device supports area cleaning)
+
+6. Observe plugin logs for successful API calls and state updates. Look for `Matter accessory ready` and `Performing initial device sync` log lines.
+
+Quick troubleshooting:
+
+- If you see "requires Homebridge with Matter support" in logs, update Homebridge to a Matter-enabled build.
+- If actions fail, inspect network connectivity and plugin logs for Ayla API errors; the plugin now includes retries with exponential backoff for critical calls.
+
+Optional: run the prepublish checks locally (lint, build, docs) to validate everything before publishing:
+
+```bash
+# Run this in the project root (macOS / zsh)
+npm run prepublishOnly
+```
+
+If you'd like, I can add a short automated script that validates a sample run (requires a Matter-enabled Homebridge instance and credentials).

package/config.schema.json

@@ -30,7 +30,7 @@
       "vacuums": {
         "title": "SharkClean Vacuum Devicess",
         "type": "array",
-        "required": true,
+        "required": false,
         "items": {
           "title": "SharkClean DSN",
           "type": "string"
@@ -43,25 +43,14 @@
         "required": false,
         "default": false
       },
-      "invertDockedStatus": {
-        "title": "Invert Vacuum Docked Status",
-        "type": "boolean",
-        "required": false,
-        "default": false
-      },
-      "dockedUpdateInterval": {
-        "title": "Docked Update Interval",
-        "type": "integer",
+      "pollInterval": {
+        "title": "Polling interval (seconds)",
+        "description": "How often to poll Shark devices for status updates. Set to 0 to disable polling.",
+        "type": "number",
         "required": false,
-        "default": 30000
-      },
-      "enhancedVacuumMode": {
-        "title": "Enhanced Vacuum Mode",
-        "type": "boolean",
-        "required": false,
-        "default": true,
-        "description": "Use improved power level mappings and vacuum-optimized behavior. Prepares for future robot vacuum service support."
+        "default": 30
       }
+
     }
   },
   "layout": [
@@ -113,14 +102,7 @@
             }
           ]
         },
-        "europe",
-        "invertDockedStatus",
-        "dockedUpdateInterval",
-        {
-          "type": "help",
-          "helpvalue": "<h5>Enhanced Vacuum Mode</h5><em class='primary-text'>Enables improved vacuum behavior with better power level mappings (25%=Eco, 50%=Normal, 100%=Max). This prepares your setup for future native HomeKit robot vacuum support.</em>"
-        },
-        "enhancedVacuumMode"
+        "europe"
       ]
     }
   ]

package/dist/constants.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAC;AAEX,eAAO,MAAM,QAAQ;;;;;;CAMX,CAAC"}
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,eAAO,MAAM,aAAa;;;;;CAKhB,CAAA;AAEV,eAAO,MAAM,QAAQ;;;;;;CAMX,CAAA"}

package/dist/constants.js.map

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;IACV,GAAG,EAAE,EAAE;CACC,CAAC;AAEX,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,IAAI;IACnB,mBAAmB,EAAE,GAAG;IACxB,8BAA8B,EAAE,IAAI;IACpC,uBAAuB,EAAE,GAAG;CACpB,CAAC"}
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,CAAC,MAAM,aAAa,GAAG;IAC3B,GAAG,EAAE,CAAC;IACN,GAAG,EAAE,EAAE;IACP,MAAM,EAAE,EAAE;IACV,GAAG,EAAE,EAAE;CACC,CAAA;AAEV,MAAM,CAAC,MAAM,QAAQ,GAAG;IACtB,WAAW,EAAE,IAAI;IACjB,aAAa,EAAE,IAAI;IACnB,mBAAmB,EAAE,GAAG;IACxB,8BAA8B,EAAE,IAAI;IACpC,uBAAuB,EAAE,GAAG;CACpB,CAAA"}

package/dist/devices/BaseMatterAccessory.d.ts

@@ -0,0 +1,63 @@
+/**
+ * Base Matter Accessory Class
+ *
+ * This base class implements the MatterAccessory interface and provides
+ * common functionality that all Matter devices can use.
+ *
+ * Individual device types should extend this class and call super() with
+ * the required configuration.
+ */
+import type { API, EndpointType, Logger, MatterAccessory } from 'homebridge';
+export interface BaseMatterAccessoryConfig {
+    uuid: string;
+    displayName: string;
+    deviceType: EndpointType;
+    serialNumber: string;
+    manufacturer: string;
+    model: string;
+    firmwareRevision: string;
+    hardwareRevision: string;
+    context?: Record<string, unknown>;
+    clusters?: MatterAccessory['clusters'];
+    handlers?: MatterAccessory['handlers'];
+    parts?: MatterAccessory['parts'];
+}
+/**
+ * Base class for all Matter accessories
+ * Implements the MatterAccessory interface and provides common methods
+ */
+export declare abstract class BaseMatterAccessory implements MatterAccessory {
+    readonly uuid: string;
+    readonly displayName: string;
+    readonly deviceType: EndpointType;
+    readonly serialNumber: string;
+    readonly manufacturer: string;
+    readonly model: string;
+    readonly firmwareRevision: string;
+    readonly hardwareRevision: string;
+    readonly context: Record<string, unknown>;
+    readonly clusters?: MatterAccessory['clusters'];
+    readonly handlers?: MatterAccessory['handlers'];
+    readonly parts?: MatterAccessory['parts'];
+    protected readonly api: API;
+    protected readonly log: Logger;
+    constructor(api: API, log: Logger, config: BaseMatterAccessoryConfig);
+    /**
+     * Update the accessory state
+     * Helper method to update cluster attributes
+     */
+    protected updateState(cluster: string, attributes: Record<string, unknown>): Promise<void>;
+    /**
+     * Log helper methods
+     */
+    protected logInfo(message: string, ...args: unknown[]): void;
+    protected logError(message: string, ...args: unknown[]): void;
+    protected logDebug(message: string, ...args: unknown[]): void;
+    protected logWarn(message: string, ...args: unknown[]): void;
+    /**
+     * Convert this class instance to a plain MatterAccessory object
+     * This is what gets registered with Homebridge
+     */
+    toAccessory(): MatterAccessory;
+}
+//# sourceMappingURL=BaseMatterAccessory.d.ts.map

package/dist/devices/BaseMatterAccessory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMatterAccessory.d.ts","sourceRoot":"","sources":["../../src/devices/BaseMatterAccessory.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,YAAY,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,YAAY,CAAA;AAE5E,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,UAAU,EAAE,YAAY,CAAA;IACxB,YAAY,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,MAAM,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,gBAAgB,EAAE,MAAM,CAAA;IACxB,gBAAgB,EAAE,MAAM,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACjC,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtC,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtC,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;CACjC;AAED;;;GAGG;AACH,8BAAsB,mBAAoB,YAAW,eAAe;IAElE,SAAgB,IAAI,EAAE,MAAM,CAAA;IAC5B,SAAgB,WAAW,EAAE,MAAM,CAAA;IACnC,SAAgB,UAAU,EAAE,YAAY,CAAA;IACxC,SAAgB,YAAY,EAAE,MAAM,CAAA;IACpC,SAAgB,YAAY,EAAE,MAAM,CAAA;IACpC,SAAgB,KAAK,EAAE,MAAM,CAAA;IAC7B,SAAgB,gBAAgB,EAAE,MAAM,CAAA;IACxC,SAAgB,gBAAgB,EAAE,MAAM,CAAA;IACxC,SAAgB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAChD,SAAgB,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtD,SAAgB,QAAQ,CAAC,EAAE,eAAe,CAAC,UAAU,CAAC,CAAA;IACtD,SAAgB,KAAK,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,CAAA;IAGhD,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAA;IAC3B,SAAS,CAAC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;gBAG5B,GAAG,EAAE,GAAG,EACR,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,yBAAyB;IA6BnC;;;OAGG;cACa,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAKhG;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAI5D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAI7D,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAI7D,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI;IAI5D;;;OAGG;IACI,WAAW,IAAI,eAAe;CAgBtC"}

package/dist/devices/BaseMatterAccessory.js

@@ -0,0 +1,100 @@
+/**
+ * Base Matter Accessory Class
+ *
+ * This base class implements the MatterAccessory interface and provides
+ * common functionality that all Matter devices can use.
+ *
+ * Individual device types should extend this class and call super() with
+ * the required configuration.
+ */
+/**
+ * Base class for all Matter accessories
+ * Implements the MatterAccessory interface and provides common methods
+ */
+export class BaseMatterAccessory {
+    // Required MatterAccessory properties
+    uuid;
+    displayName;
+    deviceType;
+    serialNumber;
+    manufacturer;
+    model;
+    firmwareRevision;
+    hardwareRevision;
+    context;
+    clusters;
+    handlers;
+    parts;
+    // Protected properties available to child classes
+    api;
+    log;
+    constructor(api, log, config) {
+        this.api = api;
+        this.log = log;
+        // Set all required properties
+        this.uuid = config.uuid;
+        this.displayName = config.displayName;
+        this.deviceType = config.deviceType;
+        this.serialNumber = config.serialNumber;
+        this.manufacturer = config.manufacturer;
+        this.model = config.model;
+        this.firmwareRevision = config.firmwareRevision;
+        this.hardwareRevision = config.hardwareRevision;
+        this.clusters = config.clusters;
+        this.handlers = config.handlers;
+        this.parts = config.parts;
+        // Set context with all metadata
+        this.context = {
+            serialNumber: this.serialNumber,
+            manufacturer: this.manufacturer,
+            model: this.model,
+            firmwareRevision: this.firmwareRevision,
+            hardwareRevision: this.hardwareRevision,
+            ...config.context,
+        };
+    }
+    /**
+     * Update the accessory state
+     * Helper method to update cluster attributes
+     */
+    async updateState(cluster, attributes) {
+        await this.api.matter.updateAccessoryState(this.uuid, cluster, attributes);
+        this.log.debug(`[${this.displayName}] Updated ${cluster} state:`, attributes);
+    }
+    /**
+     * Log helper methods
+     */
+    logInfo(message, ...args) {
+        this.log.info(`[${this.displayName}] ${message}`, ...args);
+    }
+    logError(message, ...args) {
+        this.log.error(`[${this.displayName}] ${message}`, ...args);
+    }
+    logDebug(message, ...args) {
+        this.log.debug(`[${this.displayName}] ${message}`, ...args);
+    }
+    logWarn(message, ...args) {
+        this.log.warn(`[${this.displayName}] ${message}`, ...args);
+    }
+    /**
+     * Convert this class instance to a plain MatterAccessory object
+     * This is what gets registered with Homebridge
+     */
+    toAccessory() {
+        return {
+            uuid: this.uuid,
+            displayName: this.displayName,
+            deviceType: this.deviceType,
+            serialNumber: this.serialNumber,
+            manufacturer: this.manufacturer,
+            model: this.model,
+            firmwareRevision: this.firmwareRevision,
+            hardwareRevision: this.hardwareRevision,
+            context: this.context,
+            clusters: this.clusters,
+            handlers: this.handlers,
+            parts: this.parts,
+        };
+    }
+}
+//# sourceMappingURL=BaseMatterAccessory.js.map

package/dist/devices/BaseMatterAccessory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BaseMatterAccessory.js","sourceRoot":"","sources":["../../src/devices/BaseMatterAccessory.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAmBH;;;GAGG;AACH,MAAM,OAAgB,mBAAmB;IACvC,sCAAsC;IACtB,IAAI,CAAQ;IACZ,WAAW,CAAQ;IACnB,UAAU,CAAc;IACxB,YAAY,CAAQ;IACpB,YAAY,CAAQ;IACpB,KAAK,CAAQ;IACb,gBAAgB,CAAQ;IACxB,gBAAgB,CAAQ;IACxB,OAAO,CAAyB;IAChC,QAAQ,CAA8B;IACtC,QAAQ,CAA8B;IACtC,KAAK,CAA2B;IAEhD,kDAAkD;IAC/B,GAAG,CAAK;IACR,GAAG,CAAQ;IAE9B,YACE,GAAQ,EACR,GAAW,EACX,MAAiC;QAEjC,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QAEd,8BAA8B;QAC9B,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAA;QACvB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC,WAAW,CAAA;QACrC,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,UAAU,CAAA;QACnC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,YAAY,GAAG,MAAM,CAAC,YAAY,CAAA;QACvC,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QACzB,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAA;QAC/C,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAC/B,IAAI,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;QAC/B,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAA;QAEzB,gCAAgC;QAChC,IAAI,CAAC,OAAO,GAAG;YACb,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,GAAG,MAAM,CAAC,OAAO;SAClB,CAAA;IACH,CAAC;IAED;;;OAGG;IACO,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,UAAmC;QAC9E,MAAM,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,oBAAoB,CAAC,IAAI,CAAC,IAAI,EAAE,OAAO,EAAE,UAAU,CAAC,CAAA;QAC1E,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,aAAa,OAAO,SAAS,EAAE,UAAU,CAAC,CAAA;IAC/E,CAAC;IAED;;OAEG;IACO,OAAO,CAAC,OAAe,EAAE,GAAG,IAAe;QACnD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5D,CAAC;IAES,QAAQ,CAAC,OAAe,EAAE,GAAG,IAAe;QACpD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC7D,CAAC;IAES,QAAQ,CAAC,OAAe,EAAE,GAAG,IAAe;QACpD,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC7D,CAAC;IAES,OAAO,CAAC,OAAe,EAAE,GAAG,IAAe;QACnD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,WAAW,KAAK,OAAO,EAAE,EAAE,GAAG,IAAI,CAAC,CAAA;IAC5D,CAAC;IAED;;;OAGG;IACI,WAAW;QAChB,OAAO;YACL,IAAI,EAAE,IAAI,CAAC,IAAI;YACf,WAAW,EAAE,IAAI,CAAC,WAAW;YAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;YAC3B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;YACvC,OAAO,EAAE,IAAI,CAAC,OAAO;YACrB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,KAAK,EAAE,IAAI,CAAC,KAAK;SAClB,CAAA;IACH,CAAC;CACF"}

package/dist/devices/RoboticVacuumAccessory.d.ts

@@ -0,0 +1,67 @@
+/**
+ * Robotic Vacuum Cleaner Accessory Class
+ *
+ * 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
+ *
+ * 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.
+ *
+ * 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
+ */
+import type { API, Logger } from 'homebridge';
+import type { SharkIqVacuum } from '../sharkiq-js/sharkiq.js';
+import { BaseMatterAccessory } from './BaseMatterAccessory.js';
+export declare class RoboticVacuumAccessory extends BaseMatterAccessory {
+    private activeTimers;
+    private readonly sharkDevice?;
+    private pollInterval?;
+    constructor(api: API, log: Logger, sharkDevice?: SharkIqVacuum, pollIntervalMs?: number);
+    private startPolling;
+    private stopPolling;
+    private buildServiceAreaCluster;
+    private handleChangeRunMode;
+    private handleChangeCleanMode;
+    private handlePause;
+    private handleStop;
+    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;
+}
+//# sourceMappingURL=RoboticVacuumAccessory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RoboticVacuumAccessory.d.ts","sourceRoot":"","sources":["../../src/devices/RoboticVacuumAccessory.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;;;;;GAqBG;AAEH,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,EAAkB,MAAM,YAAY,CAAA;AAE7D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,0BAA0B,CAAA;AAG7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,qBAAa,sBAAuB,SAAQ,mBAAmB;IAC7D,OAAO,CAAC,YAAY,CAAuB;IAC3C,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAe;IAC5C,OAAO,CAAC,YAAY,CAAC,CAAgB;gBAEzB,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,aAAa,EAAE,cAAc,CAAC,EAAE,MAAM;IA2KvF,OAAO,CAAC,YAAY;IA6IpB,OAAO,CAAC,WAAW;IAQnB,OAAO,CAAC,uBAAuB;YAqCjB,mBAAmB;YAoDnB,qBAAqB;YA4BrB,WAAW;YAaX,UAAU;YAcV,WAAW;YA0BX,YAAY;YA0BZ,YAAY;YAuBZ,iBAAiB;YAsBjB,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;CAIjF"}