Homebridge Shark Clean Vacuum Plugin

A new homebridge plugin for SharkIQ Vacuums.

Contribution would be very helpful as this plugin is still new and has some small flaws here and there. 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.

Install and Setup

Step 1.

Run npm install -g homebridge-sharkiq

Step 2.

Configure Homebridge. The config file for SharkIQ should include:

{
    "platforms": [
        {
            "name": "SharkIQ",
            "platform": "SharkIQ",
            "email": "[Shark Clean Account Email]",
            "password": "[Shark Clean Account Password]",
            "vacuums": [
                "[Shark Vacuum DSN]",
                "..."
            ],
            "europe": false,
            "invertDockedStatus": false,
            "dockedUpdateInterval": 5000
        }
    ]
}

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 are in Europe, 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 5 seconds (5000 ms). To change the docked status interval, add dockedUpdateInterval to your config. Value is in milliseconds.

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

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