Skip to main content

Python client for Aira Home, initially developed for Homeassistant

Project description

pyairahome

Python client for Aira Home, initially developed for Homeassistant

Getting started

Logging in

from pyairahome import AiraHome
aira = AiraHome()
# login with username and password
aira.login_with_credentials("email_here", "password_here")
# login with tokens
aira.login_with_tokens("id_token_here", "access_token_here", "refresh_token_here")

Retrieving informations:

Get devices

Lists heatpumps owned by the user

devices = aira.get_devices()
# {'devices': [{'id': {'value': 'BASE64_ENCODED_ID'}, 'online': {'online': True, 'time': '2025-08-06T15:40:07.549Z'}}]}

Get device details

Gives details on a specified heatpump

# Ottieni avvenimenti di una giornata
device_id = 'BASE64_ENCODED_ID'
aira.get_device_details(device_id)
# {'heat_pump': {'certificate': {'certificate_pem': '-----BEGIN CERTIFICATE-----\n[...]\n-----END CERTIFICATE-----\n'}, 'id': {'value': 'BASE64_ENCODED_ID'}, 'tank_size': 'WATER_TANK_SIZE_300_LITERS', 'deprecated_tank_size': 'TANK_SIZE_UNSPECIFIED', 'night_mode_enabled': False}}

Get states

Dumps states of a specified heatpump

# Ottieni avvenimenti di una giornata
device_id = 'BASE64_ENCODED_ID'
aira.get_states(device_id)
# {'heat_pump_states': [{'time': '2025-08-08T21:55:30.541376144Z', 'deprecated_target_indoor_heat': {'temperature': 20.0}, 'target_hot_water_temperature': 50.0, 'current_hot_water_temperature': 65.5, 'heat_pump_id': {'value': 'BASE64_ENCODED_ID'}, 'current_outdoor_temperature': 27.1, [...], 'pump_active_state': 'PUMP_ACTIVE_STATE_IDLE', 'inline_heater_active': False, 'force_heating': {'enabled': False}, 'deprecated_pump_mode_state': 'PUMP_MODE_STATE_UNSPECIFIED', 'away_mode_enabled': False, 'power_preference': 'POWER_PREFERENCE_UNSPECIFIED'}]}

Send command & stream command

Sends a command to the heatpump and streams the progress/response

command = aira.send_command(device_id, "ping") # {'command_id': {'value': 'SLNXNxTHT8SdNrPvEzvEdw=='}}
for update in aira.stream_command_progress(command['command_id']['value']):
    pass # {'command_progress': {'command_id': {'value': 'SLNXNxTHT8SdNrPvEzvEdw=='}, 'time': '2025-08-08T22:01:19.806295242Z', 'succeeded': {}, 'aws_iot_received_time': '2025-08-08T22:01:19.911289444Z'}}

Help

This project is still a early beta but it should contain everything needed to make it complete, feel free to contribute.

Disclaimer

This project is an independent, open-source software library developed for interacting with AiraHome heat pumps via their app gRPC APIs. It is not affiliated with, endorsed by, sponsored by, or associated with AiraHome or any of its subsidiaries, affiliates, or partners. The project is not an official product of AiraHome, and the use of this library does not imply any compatibility, support, or approval from AiraHome. All trademarks, service marks, and company names mentioned herein are the property of their respective owners. Use of this library is at your own risk, and the developers are not responsible for any damages, malfunctions, or issues arising from its use with AiraHome or other heat pump systems.

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

pyairahome-0.1.2.tar.gz (92.0 kB view details)

Uploaded Source

Built Distribution

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

pyairahome-0.1.2-py3-none-any.whl (281.5 kB view details)

Uploaded Python 3

File details

Details for the file pyairahome-0.1.2.tar.gz.

File metadata

  • Download URL: pyairahome-0.1.2.tar.gz
  • Upload date:
  • Size: 92.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for pyairahome-0.1.2.tar.gz
Algorithm Hash digest
SHA256 b35c106ce3d72b5f33a22c3be79817060263954b581f28385a374ecbdef0ff24
MD5 548eb63ac8ca067f8abd108e6a5e5a14
BLAKE2b-256 b5b99f47f344a11e3b8fb2e6c48171b0cfde479330c3cf982dd2f50a92b41bf6

See more details on using hashes here.

File details

Details for the file pyairahome-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: pyairahome-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 281.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.2

File hashes

Hashes for pyairahome-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 26664de0388568018e45f4db74424d522d1a5d00b37d37f4deedd905f5a0f955
MD5 bf4a1455a6b8af339e10659dbe9e124b
BLAKE2b-256 35e34d329df9823f89f225185efa16472a034fea0adb14db82b8739bc15eb79e

See more details on using hashes here.

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