This integration was created by manipulating API requests that were captured through Charles Proxy and the iPhone Shark iOS App.
Please send feedback and/or issues to the Hubitat Forum Thread: https://community.hubitat.com/t/shark-iq-robot/34286, or issues to the Issues Section of this Repository.
| Preference | Description |
|---|---|
| Shark Account Email Address. | |
| Password | Shark Account Password. |
| Device Name | Name you've given your Shark Device within the App. |
| Mobile Device | Type of Mobile Device your Shark is setup on (Not super important, but will spoof the api calls as if you're using a particular device) |
| Scheduled State Refresh | If enabled, after you click 'Save Preferences', click the 'Refresh' button to start the schedule. |
| Refresh Interval | Number of minutes between State Refreshes. |
| Smart State Refresh | If enabled, will only refresh when vacuum is running (per interval), then every 5 minutes until Fully Charged. Takes precedence over Scheduled State Refresh. |
| Scheduled Run Time from Shark App | Enter the time Shark is scheduled to run through the Shark App to control dormant smart scheduling, blank to disable and default to 15 minute pings when dormant |
| Google Home Compatibility | Toggle to add a 'status' state |
| Enable Debug Logging | Adds more logging information. |
This section outlines what the States on the right-side of Hubitat mean.
| State | Description |
|---|---|
| Battery_Level | This displays the Shark's current battery level. |
| Charging_Status | This displays the Shark's current charging status. More information can be found under Charging Status section. |
| Error_Code | This displays the meaning to the error code number. More information can be found under Error Codes section. |
| Firmware_Version | What firmware your Shark vacuum is currently running. |
| Last_Refreshed | Displays the date/time when the current state information was retrieved. |
| Operating_Mode | This displays the Shark's current battery level. More information can be found under Operating Modes section. |
| Power_Mode | This displays the Shark's current battery level. More information can be found under Power Modes section. |
| RSSI | This is the Shark vacuums current wireless (WiFi) signal strength. |
| Recharging_To_Resume | This displays whether the Shark is recharging to continue cleaning. |
| Robot_Volume | This displays the Shark's volume level. |
| switch | This is the current switch state (on/off). |
| status | This displays one of four values: docked, undocked, running, or paused. Must have 'Google Home Compatibility' preference enabled. |
| Charging Status | Description |
|---|---|
| Charging | The Shark is currently charging. |
| Fully Charged | The Shark is not charging, as it's battery is at 100%. |
| Not Charging | The Shark is currently not charging (As it may be off the dock or running). |
By default, this driver will display the meaning under the Current States section of Hubitat. This state was never fully tested.
| Error Code | Means |
|---|---|
| 0 | No error |
| 1 | Side wheel is stuck |
| 2 | Side brush is stuck |
| 3 | Suction motor failed |
| 4 | Brushroll stuck |
| 5 | Side wheel is stuck (2) |
| 6 | Bumper is stuck |
| 7 | Cliff sensor is blocked |
| 8 | Battery power is low |
| 9 | No Dustbin |
| 10 | Fall sensor is blocked |
| 11 | Front wheel is stuck |
| 12 | Switched off |
| 13 | Magnetic strip error |
| 14 | Top bumper is stuck |
| 15 | Wheel encoder error |
| Operating Mode | Description |
|---|---|
| Recharging to Continue | The Shark is not done cleaning, but is recharging because the battery is too low to continue. |
| Stopped | The Shark is currently stopped. |
| Paused | The Shark is currently paused. |
| Running | The Shark is currently running. |
| Returning to Dock | The Shark is currently returning to the dock. |
| Resting on Dock | The Shark is on the dock, but not charging. |
| Charging on Dock | The Shark is on the dock and is charging. |
By default, this driver will display the meaning under the Current States section of Hubitat.
| Power Mode | Means |
|---|---|
| 0 | Normal |
| 1 | Eco |
| 2 | Max |
| Schedule Type | Description |
|---|---|
| Smart Refresh - Active | The Shark is actively cleaning, paused, or docking. Refreshes will occur every minute by default or as set in Refresh Interval parameter. |
| Smart Refresh - Charging | The Shark is charging on the dock. Refreshes will occur every 5 minutes until fully charged. |
| Smart Scheduled Refresh - Dormant | The Shark is fully charged resting on the dock. Refreshes have been scheduled according to the time supplied in Scheduled Run Time from Shark App parameter. |
| Smart Interval Refresh - Dormant | The Shark is fully charged resting on the dock. Refreshes have been scheduled every 15 minutes. |
| Unscheduled | No schedule has been set for refreshing the status of your Shark. Modify your preferences to enable scheduled refreshes. |
| Scheduled Refresh | The Shark's status will be refreshed on a recurring interval as set in the Refresh Interval parameter. |
This driver does support starting and stopping via a dashboard tile. To do so:
- Click "+" to add a new tile.
- Select your Shark device.
- Choose the template "Button".
You can also pull current states to a dashboard tile as well. To do so:
- Click "+" to add a new tile.
- Select your Shark device.
- Choose the template "Attribute".
- Select the attribute from the dropdown.
There's a few methods of scheduling (and refreshing) within this driver. Explanations for the state itself can be found under Schedule_Types.
- Smart State Refresh - If enabled, the driver will only refresh when vacuum is running (at the
Refresh Inverval). After cleaning is complete, it will then refresh every 5 minutes until the Shark Vacuum is Fully Charged. - Scheduled State Refresh - If enabled, the driver will constantly refresh using the
Refresh Intervalvalue. An initial click on the 'Refresh' button is needed to start this schedule. Use this method - Smart State Refresh + Scheduled Run through the Shark App - If you want to schedule your Shark Vacuum runs through the Sharp App, you must have both
Smart State Refreshenabled and haveScheduled Run Time from Shark Apppopulated.
To support this project, you can make a donation to its current maintainer:
