Configuration

⚠️ It is recommended (and easier) to use the Homebridge UI plugin settings screen to configure the plugin. The settings screen is generated from the same source as this page, and always reflects the full, current set of options.

This page is for reference and for users who edit their configuration JSON manually.

Required Settings

Add the following to your configuration file inside the platforms array.

{
   "name": "SharkIQ",
   "platform": "SharkIQ"
}

• ⚠️ The "platform": "SharkIQ" line must not be changed
• Shark IQ uses SharkNinja's hosted sign-in - use the plugin settings screen to generate a login URL, sign in, then paste the code back (this fills in oAuthCode). Leave vacuums empty to add every robot on the account, or list specific robot identifiers (DSNs). Set europe to true if your account is registered in the EU region.

Optional Settings

Setting	Type	Default	Explanation
oAuthCode	string	-	SharkClean OAuth Code
vacuums	array	-	The DSNs of the vacuums to add. Leave this empty to add every vacuum on your account (recommended unless you want to add only some of them).
europe	boolean	false	Set to true if you are located in Europe or the UK. SharkClean uses different servers for US and European regions.
invertDockedStatus	boolean	false	Invert Vacuum Docked Status
dockedUpdateInterval	number	30000	Docked Update Interval
externalAccessory	boolean	false	When enabled, each vacuum is published as a standalone external accessory with its own HomeKit pairing code, instead of being bridged through Homebridge. Applies to both HAP and Matter registration modes.
preferMatter	boolean	true	When enabled, the plugin will use the Homebridge Matter API (requires Homebridge v2.0+ with Matter enabled). Falls back to HAP if Matter is unavailable.
enableMatter	boolean	true	Allow the plugin to use Homebridge Matter support when available. Set to false to always use HAP accessories.
matrixClean	boolean	false	When cleaning specific rooms from HomeKit, use the SharkClean app's "Matrix Clean" (a two-pass cross-hatch) instead of a plain single-pass clean. Only affects room cleans, not whole-house ones.
errorSensor	boolean	false	Adds a sensor that opens whenever the vacuum reports an error, such as a stuck brushroll or a missing dust bin, so you can be notified. Errors are always written to the Homebridge log whether or not this is switched on.
waterTankSensor	boolean	false	Adds a sensor that opens when a fitted water tank has run dry, so you can be notified. A vacuum with no tank fitted stays closed. Only for models that mop.
mopPlateSensor	boolean	false	Adds a sensor that opens when the mop plate is not attached. Only for models that mop.