Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lafriks/python-karcher
Kärcher Home Robots python client
https://github.com/lafriks/python-karcher
home-assistant home-automation iot karcher python smart-home
Last synced: about 3 hours ago
JSON representation
Kärcher Home Robots python client
- Host: GitHub
- URL: https://github.com/lafriks/python-karcher
- Owner: lafriks
- License: mit
- Created: 2023-04-26T11:08:46.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-11T19:04:06.000Z (9 months ago)
- Last Synced: 2024-09-17T20:50:27.059Z (about 2 months ago)
- Topics: home-assistant, home-automation, iot, karcher, python, smart-home
- Language: Python
- Homepage:
- Size: 67.4 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kärcher Home Robots client
Python library and cli to authorize into Karcher Home Robots account and fetch device information.
## Usage
To download `karcher-home` cli run:
```sh
pip3 install karcher-home
```
### From console
```console
Usage: karcher-home [OPTIONS] COMMAND [ARGS]...
Tool for connectiong and getting information from Kärcher Home Robots.
Options:
-d, --debug Enable debug mode.
-o, --output [json|json_pretty]
Output format. Default: "json"
-r, --region [eu|us|cn] Region of the server to query. Default: "eu"
--help Show this message and exit.
Commands:
device-properties Get device properties.
devices List all devices.
login Get user session tokens.
urls Get region information.
```
### From code
```python
from karcher.karcher import KarcherHome
kh = await KarcherHome.create()
await kh.login("user@email", "password")
devices = await hk.get_devices()
```
## License
Distributed under the MIT License. See `LICENSE` for more information.