A Python client for the HannaCloud API
Project description
HannaCloud Python Client
NOT OFFICIALLY SUPPORTED BY HANNA --
A Python client library for interacting with the HannaCloud API. This client provides methods for authentication and device data retrieval. Developped solely for the HannaCloud HomeAssistant integration. At least for now.
Installation
You can install the package using pip:
pip install hanna-cloud
Usage
Here's a basic example of how to use the client:
from hanna_cloud import HannaCloudClient
# Initialize the client
client = HannaCloudClient()
# Authenticate with your email and password
access_token = client.authenticate(email="your-email", password="your-password")
print(f"Access token: {access_token}")
# Get devices
devices = client.get_devices()
print(f"Devices: {devices}")
# Get user info
user_info = client.get_user()
print(f"User info: {user_info}")
# Get last device reading
last_reading = client.get_last_device_reading(device_id)
print(f"Last device reading: {last_reading}")
# Get device log history (example)
log_history = client.get_device_log_history(device_id=device_id)
print(f"Device log history: {log_history}")
# Disable Cl and pH pumps
client.set_remote_hold(device_id=device_id, setting: True)
# Enable Cl and pH pumps
client.set_remote_hold(device_id=device_id, setting: False)
Authentication
The client uses email and password authentication. Use the authenticate method to obtain and set the access token for subsequent requests.
API Methods
authenticate(email: str, password: str, key_base64) -> access_tokenget_devices()get_user()get_last_device_reading(device_id: str)set_remote_hold(device_id: str, setting: bool)
License
This project is licensed under the MIT License - see the LICENSE file for details.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file hanna_cloud-0.0.3.tar.gz.
File metadata
- Download URL: hanna_cloud-0.0.3.tar.gz
- Upload date:
- Size: 5.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9ced6804395b7776a2bec7db39ceffbac2e321ac8957247f4de25af13e5bb3f1
|
|
| MD5 |
2060def8d0eb88d50d4e53e0570ec5ed
|
|
| BLAKE2b-256 |
4714be85bada23cb043021ca4603ef5d364dc3fdf9e691ec36b38fe2fe907475
|
Provenance
The following attestation bundles were made for hanna_cloud-0.0.3.tar.gz:
Publisher:
pypi.yml on bestycame/hanna_cloud
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hanna_cloud-0.0.3.tar.gz -
Subject digest:
9ced6804395b7776a2bec7db39ceffbac2e321ac8957247f4de25af13e5bb3f1 - Sigstore transparency entry: 232468480
- Sigstore integration time:
-
Permalink:
bestycame/hanna_cloud@e9b1b58d85c696352d9f254fee3c4a4ad42ff0ab -
Branch / Tag:
refs/tags/0.0.3 - Owner: https://github.com/bestycame
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@e9b1b58d85c696352d9f254fee3c4a4ad42ff0ab -
Trigger Event:
release
-
Statement type:
File details
Details for the file hanna_cloud-0.0.3-py3-none-any.whl.
File metadata
- Download URL: hanna_cloud-0.0.3-py3-none-any.whl
- Upload date:
- Size: 6.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
995f8f06bc12a4b35112b7070cc505f662b272c84fe303a526d5b11b6f0607e7
|
|
| MD5 |
d96ebb9a7238c3be2628a597d57f67a1
|
|
| BLAKE2b-256 |
799850234bb6e28080254c7d87e8e9df0f30ed8150080cabe0275cc987c55260
|
Provenance
The following attestation bundles were made for hanna_cloud-0.0.3-py3-none-any.whl:
Publisher:
pypi.yml on bestycame/hanna_cloud
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
hanna_cloud-0.0.3-py3-none-any.whl -
Subject digest:
995f8f06bc12a4b35112b7070cc505f662b272c84fe303a526d5b11b6f0607e7 - Sigstore transparency entry: 232468500
- Sigstore integration time:
-
Permalink:
bestycame/hanna_cloud@e9b1b58d85c696352d9f254fee3c4a4ad42ff0ab -
Branch / Tag:
refs/tags/0.0.3 - Owner: https://github.com/bestycame
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
pypi.yml@e9b1b58d85c696352d9f254fee3c4a4ad42ff0ab -
Trigger Event:
release
-
Statement type: