A new homebridge plugin for SharkIQ Vacuums.

Contributions are always welcome. I used the sharkiq python module as a reference for creating the javascript wrapper to control SharkIQ Vacuums.

This plguin has only been tested on the UR250BEXUS model.

The fastest way to get community support (not for bugs) is to join the Homebridge Discord server and chat in the #sharkiq channel.

Run npm install -g homebridge-sharkiq

Configure Homebridge. The config file for SharkIQ should include:

{
  "platforms": [
    {
      "name": "SharkIQ",
      "platform": "SharkIQ",
      "email": "[Shark Clean Account Email]",
      "password": "[Shark Clean Account Password]",
      "oAuthCode": "[Optional. Use for manually obtaining credentials]",
      "vacuums": [
        "[Shark Vacuum DSN]",
        "..."
      ],
      "europe": false
    }
  ]
}

You may be prompted to use the manual OAuth login method. In order to use the manual OAuth login method, you must remove the email and password values in your configuration first.

The email and password is your Shark Clean account you used to setup the vacuum. The Vacuums array is a list of your vacuum's device serial numbers (DSN). If you only have one vacuum, just include the one's DSN. The DSN(s) can be found in the SharkClean mobile app.

If you would like to manually obtain your Shark Clean credentials without using your email and password, you can obtain a OAuth code instead. Refer to the OAuth Code Login Method section.

The Vacuums array is a list of your vacuum's device serial numbers (DSN). If you only have one vacuum, just include the one's DSN. The DSN(s) can be found in the SharkClean mobile app.

If you are in Europe or the UK, set the europe config value to true. SharkClean has separate servers for the U.S. and Europe. The default value is false, which connects to the U.S. server.

The default interval between updating the docked status is 30 seconds (30000 ms). To change the docked status interval, add dockedUpdateInterval to your config. Value is in milliseconds. If the interval is too low, you have the risk of your account being rate limited.

The enhancedVacuumMode option (enabled by default) provides improved vacuum behavior with more intuitive power level mappings that prepare for future native HomeKit robot vacuum support. When enabled, power levels are: 25%=Eco, 50%=Normal, 100%=Max. When disabled, it uses legacy mappings: 30%=Eco, 60%=Normal, 90%=Max.

• Be able to turn on and off the vacuum
• Set the power mode of the vacuum and change it while running
• Sensor for if the vacuum is docked or not
  • The sensor will display as "opened" when the vacuum is docked and "closed" when the vacuum is not docked
  • Set invertDockedStatus to true to display as "closed" when the vacuum is docked and "opened" when the vacuum is not docked
• Pause switch for pausing the vacuum while it's running
• Enhanced Vacuum Mode (new): Improved power level mappings and vacuum-optimized behavior that prepares for future native HomeKit robot vacuum support

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
• Enhanced Mode: Provides intuitive power levels (25%=Eco, 50%=Normal, 100%=Max) instead of arbitrary percentages
• Future Ready: Framework in place to detect native robot vacuum services when they become available in HomeKit/HAP-NodeJS
• Backward Compatible: Supports legacy mode for users who prefer the original 30%/60%/90% mappings

Note: As of Homebridge 2.0.0-alpha.28, the HomeKit AccessoryProtocol (HAP) specification does not yet include native robot vacuum services. Apple's iOS 18 robot vacuum support in the Home app uses private/undocumented services that are not available in the open-source HAP-NodeJS framework. This plugin will automatically adapt when public robot vacuum services become available.

The OAuth Code value is for creating and storing the login for the plugin. Here is how to sign in with this method.

1. Run Homebridge with the latest plugin version.
2. Open the Homebridge logs
3. Open the URL in the console printed by homebridge-sharkiq. Safari will not work due to the way Safari handles the results of the login
4. Before you login, open up developer tools in your browser (inspect element), and navigate to the network tab
5. Enter your login info, and press continue
6. Open the request with the uri of /authorize/resume that shows up and view the headers
7. Search com.sharkninja.shark in the headers
8. Copy the code in between code= and &. for example in com.sharkninja.shark://login.sharkninja.com/ios/com.sharkninja.shark/callback?code=abcdefghijkl&state=, abcdefghijkl is the code that needs to be copied
9. Open your Homebridge configuration, and paste the code value in the OAuth Code config option
10. Restart Homebridge

Contributions would be very helpful to help this Homebridge plugin stay maintained and up to date. If you have any problems, please create an issue.

• SharkIQ Python

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:

# 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).