Skip to main content

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sharkiq-1.5.1.tar.gz (22.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sharkiq-1.5.1-py3-none-any.whl (19.3 kB view details)

Uploaded Python 3

File details

Details for the file sharkiq-1.5.1.tar.gz.

File metadata

  • Download URL: sharkiq-1.5.1.tar.gz
  • Upload date:
  • Size: 22.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sharkiq-1.5.1.tar.gz
Algorithm Hash digest
SHA256 3c1c40a688fa6e87c9c099238f52da6178722b4d019431d9698660f1f1c6cbfd
MD5 8869aeb40f466c0bb3e363c841d81e7f
BLAKE2b-256 3b3b0143815df5acba75ba23507cbb59862b697e8dffd837f5a326dbcc658153

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharkiq-1.5.1.tar.gz:

Publisher: publish.yml on sharkiqlibs/sharkiq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sharkiq-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: sharkiq-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 19.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sharkiq-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3047b104d06eeca4fd12e64f733ac147d36c1ac8d2da1bb97c3407aed69f4b47
MD5 f9775af693d224357a0e9fa74d54906c
BLAKE2b-256 9853c64b03566a21761bda6c88d49d955ae18a8b5bb1cd91e2661266405da344

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharkiq-1.5.1-py3-none-any.whl:

Publisher: publish.yml on sharkiqlibs/sharkiq

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

1.5.1 This release

2 files

1.5.0

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.4.0

2 files

1.3.4

2 files

1.3.2

2 files

1.3.0

2 files

1.2.0

2 files

1.1.1

2 files

1.1.0

2 files

1.0.2

2 files

1.0.1

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page