@homebridge-plugins/homebridge-sharkiq

Homebridge Shark Clean Vacuum Plugin

A 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 plugin 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.

Install and Setup

Step 1.

Run npm install -g @homebridge-plugins/homebridge-sharkiq

Step 2.

Configure Homebridge. The config file for SharkIQ should include:

{
  "platforms": [
    {
      "name": "SharkIQ",
      "platform": "SharkIQ",
      "oAuthCode": "[Optional. Use for manually obtaining credentials]",
      "vacuums": [
        "[Shark Vacuum DSN]",
        "..."
      ],
      "europe": false,
      "invertDockedStatus": false,
      "dockedUpdateInterval": 30000
    }
  ]
}

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, you can use an OAuth code. 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.

Features

• 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

Matter and HomeKit Integration

This plugin supports both classic HomeKit Accessory Protocol (HAP) and Homebridge Matter.

Matter Implementation

• HAP mode: Uses SharkIQPlatform and SharkIQAccessory.
• Matter mode: Uses SharkIQMatterPlatform when Homebridge Matter is available and enabled.

If Matter is unavailable or disabled, the plugin automatically falls back to HAP mode.

Device Mapping

Mode	Homebridge Class	HAP Service(s)	Matter DeviceType	Matter Clusters
HAP	SharkIQPlatform / SharkIQAccessory	Fanv2, ContactSensor, Switch	N/A	N/A
Matter	SharkIQMatterPlatform	(HAP not registered in Matter path)	RoboticVacuumCleaner	rvcRunMode, rvcOperationalState

Matter References

• https://matter-js.github.io/docs/index.html
• https://github.com/homebridge-plugins/homebridge-matter
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Introduction
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Core-Concepts
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Getting-Started
• https://github.com/homebridge-plugins/homebridge-matter/wiki/State-Management
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Monitoring-External-Changes
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Best-Practices
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Advanced-Patterns
• https://github.com/homebridge-plugins/homebridge-matter/wiki/API-Reference
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Matter-Types
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Value-Conversions
• https://github.com/homebridge-plugins/homebridge-matter/wiki/Section-9-Appliances

OAuth Code Login Method

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

The easiest method is to use the Homebridge UI OAuth Assistant in this plugin's Settings tab:

• Open the plugin UI in Homebridge.
• Go to Settings -> OAuth Assistant.
• Click Generate Login URL.
• Open the URL, sign in, then paste the callback URL (or code) back into the assistant.
• Click Exchange Code and restart Homebridge.

Manual method (if needed):

• Run Homebridge with the latest plugin version.
• Open the Homebridge logs
• 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
• Before you login, open up developer tools in your browser (inspect element), and navigate to the network tab
• Enter your login info, and press continue
• Open the request with the uri of /authorize/resume that shows up and view the headers
• Search com.sharkninja.shark in the headers
• 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
• Open your Homebridge configuration, and paste the code value in the OAuth Code config option
• Restart Homebridge

Notes

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.

Useful Links

• SharkIQ Python
• Home Assistant SharkIQ Integration