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
Metadata
Release files for sharkiq 1.5.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sharkiq-1.5.1.tar.gz | 22.5 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sharkiq-1.5.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 41.8 kB
Release files / sharkiq-1.5.1.tar.gz
| Download URL | sharkiq-1.5.1.tar.gz |
|---|---|
| Size | 22.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3c1c40a688fa6e87c9c099238f52da6178722b4d019431d9698660f1f1c6cbfd
|
|
BLAKE2b-256 checksum How to use checksums |
3b3b0143815df5acba75ba23507cbb59862b697e8dffd837f5a326dbcc658153
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 16, 2026.
Transparency logRelease files / sharkiq-1.5.1-py3-none-any.whl
| Download URL | sharkiq-1.5.1-py3-none-any.whl |
|---|---|
| Size | 19.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
3047b104d06eeca4fd12e64f733ac147d36c1ac8d2da1bb97c3407aed69f4b47
|
|
BLAKE2b-256 checksum How to use checksums |
9853c64b03566a21761bda6c88d49d955ae18a8b5bb1cd91e2661266405da344
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 16, 2026.
Transparency log
