Skip to main content

Python API for Shark IQ robots

Project description

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

Project details


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.0.tar.gz (21.2 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.0-py3-none-any.whl (17.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for sharkiq-1.5.0.tar.gz
Algorithm Hash digest
SHA256 b49ac9d5d61c83f9ab6a4fbb03e941e47471130f6ef29838b68e66687eea71ee
MD5 d45302a7ff64686ca04139b1dd51a783
BLAKE2b-256 80ad02b720b4d6ca9d0a25c83e13620125d790b56a8f9703efccd3b8dc284167

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharkiq-1.5.0.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.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for sharkiq-1.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a08b1fd0038f6e10b5207a72ef37bb8842ec28b859bc782e765fb152c8c10f86
MD5 36d854e1ea0af3419cfb041d92b27ed0
BLAKE2b-256 72ffc31b821dfb1857292a9657fb2544026570ebf4ce77f0be035646adecd666

See more details on using hashes here.

Provenance

The following attestation bundles were made for sharkiq-1.5.0-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.

Supported by

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