Skip to content

Unofficial SDK for Shark IQ robot vacuums, designed primarily to support an integration for Home Assistant.

License

Notifications You must be signed in to change notification settings

JeffResc/sharkiq

Repository files navigation

codecov PyPI PyPI - Downloads GitHub Documentation

sharkiq

Unofficial SDK for Shark IQ robot vacuums, designed primarily to support an integration for Home Assistant.

This library is heavily based off of sharkiq by @ajmarks, with a few minor changes to allow it to work on newer versions of the Shark API.

Installation

pip install sharkiq

Usage

Examples can be found in the examples directory.

Documentation

You can view the latest documentation here.

TODOs:

  • Add support for mapping
  • Once we have mapping, it may be possible to use the RSSI property combined with an increased update frequency to generate a wifi strength heatmap. Kind of orthogonal to the main purpose, but I really want to do this.

License

MIT

About

Unofficial SDK for Shark IQ robot vacuums, designed primarily to support an integration for Home Assistant.

Topics

Resources

License

Stars

Watchers

Forks

Languages