-
Notifications
You must be signed in to change notification settings - Fork 16
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
4 additions
and
4 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,18 @@ | ||
# sharkiqpy | ||
# sharkiq | ||
Unofficial SDK for Shark IQ robot vacuums, designed primarily to support an integration for [Home Assistant](https://www.home-assistant.io/). | ||
|
||
This library is heavily based off of [sharkiq](https://github.com/ajmarks/sharkiq) by [@ajmarks](https://github.com/ajmarks), with a few minor changes to allow it to work on newer versions of the Shark API. | ||
|
||
## Installation | ||
|
||
```bash | ||
pip install sharkiqpy-ng | ||
pip install sharkiq | ||
``` | ||
|
||
## Usage | ||
### Simple Operation | ||
```python | ||
from sharkiqpy import get_ayla_api, OperatingModes, Properties, PowerModes | ||
from sharkiq import get_ayla_api, OperatingModes, Properties, PowerModes | ||
|
||
USERNAME = '[email protected]' | ||
PASSWORD = '$7r0nkP@s$w0rD' | ||
|
@@ -31,7 +31,7 @@ shark.return_to_base() | |
### Async operation | ||
```python | ||
import asyncio | ||
from sharkiqpy import get_ayla_api, OperatingModes, SharkIqVacuum | ||
from sharkiq import get_ayla_api, OperatingModes, SharkIqVacuum | ||
|
||
USERNAME = '[email protected]' | ||
PASSWORD = '$7r0nkP@s$w0rD' | ||
|