Skip to main content

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_token
  • get_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

hanna_cloud-0.0.3.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

hanna_cloud-0.0.3-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

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

Hashes for hanna_cloud-0.0.3.tar.gz
Algorithm Hash digest
SHA256 9ced6804395b7776a2bec7db39ceffbac2e321ac8957247f4de25af13e5bb3f1
MD5 2060def8d0eb88d50d4e53e0570ec5ed
BLAKE2b-256 4714be85bada23cb043021ca4603ef5d364dc3fdf9e691ec36b38fe2fe907475

See more details on using hashes here.

Provenance

The following attestation bundles were made for hanna_cloud-0.0.3.tar.gz:

Publisher: pypi.yml on bestycame/hanna_cloud

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

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

Hashes for hanna_cloud-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 995f8f06bc12a4b35112b7070cc505f662b272c84fe303a526d5b11b6f0607e7
MD5 d96ebb9a7238c3be2628a597d57f67a1
BLAKE2b-256 799850234bb6e28080254c7d87e8e9df0f30ed8150080cabe0275cc987c55260

See more details on using hashes here.

Provenance

The following attestation bundles were made for hanna_cloud-0.0.3-py3-none-any.whl:

Publisher: pypi.yml on bestycame/hanna_cloud

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