# pyairahome
Python client for Aira Home, initially developed for Homeassistant
## Getting started
### Logging in
```python
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
```python
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
```python
# 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
```python
# 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
```python
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._
Raw data
{
"_id": null,
"home_page": "https://github.com/Invy55/pyairahome",
"name": "pyairahome",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, aira, airahome, aira home, api, wrapper",
"author": "Invy55 (Marco)",
"author_email": "<marco@invy55.win>",
"download_url": "https://files.pythonhosted.org/packages/55/a4/eed596ef69068848915e167a3f2aef95a157e9d514ce1f58b95d2d74b6af/pyairahome-0.1.5.tar.gz",
"platform": null,
"description": "\r\n# pyairahome\r\r\nPython client for Aira Home, initially developed for Homeassistant\r\r\n\r\r\n## Getting started\r\r\n\r\r\n### Logging in\r\r\n\r\r\n```python\r\r\nfrom pyairahome import AiraHome\r\r\naira = AiraHome()\r\r\n# login with username and password\r\r\naira.login_with_credentials(\"email_here\", \"password_here\")\r\r\n# login with tokens\r\r\naira.login_with_tokens(\"id_token_here\", \"access_token_here\", \"refresh_token_here\")\r\r\n```\r\r\n\r\r\n### Retrieving informations:\r\r\n\r\r\n#### Get devices\r\r\nLists heatpumps owned by the user\r\r\n```python\r\r\ndevices = aira.get_devices()\r\r\n# {'devices': [{'id': {'value': 'BASE64_ENCODED_ID'}, 'online': {'online': True, 'time': '2025-08-06T15:40:07.549Z'}}]}\r\r\n```\r\r\n\r\r\n#### Get device details\r\r\nGives details on a specified heatpump\r\r\n```python\r\r\n# Ottieni avvenimenti di una giornata\r\r\ndevice_id = 'BASE64_ENCODED_ID'\r\r\naira.get_device_details(device_id)\r\r\n# {'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}}\r\r\n```\r\r\n#### Get states\r\r\nDumps states of a specified heatpump\r\r\n```python\r\r\n# Ottieni avvenimenti di una giornata\r\r\ndevice_id = 'BASE64_ENCODED_ID'\r\r\naira.get_states(device_id)\r\r\n# {'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'}]}\r\r\n```\r\r\n#### Send command & stream command\r\r\nSends a command to the heatpump and streams the progress/response\r\r\n```python\r\r\ncommand = aira.send_command(device_id, \"ping\") # {'command_id': {'value': 'SLNXNxTHT8SdNrPvEzvEdw=='}}\r\r\nfor update in aira.stream_command_progress(command['command_id']['value']):\r\r\n 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'}}\r\r\n```\r\r\n\r\r\n## Help\r\r\nThis project is still a early beta but it should contain everything needed to make it complete, feel free to contribute.\r\r\n\r\r\n##\r\r\n#### Disclaimer\r\r\n_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._\r\r\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client for Aira Home, initially developed for Homeassistant",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/Invy55/pyairahome"
},
"split_keywords": [
"python",
" aira",
" airahome",
" aira home",
" api",
" wrapper"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0cf5a7790be10f1e63fb7627ca675ada1abdffefc653a7c683d51d8fb5edc653",
"md5": "9c18ba92d795648a7de6c719d9eb79a9",
"sha256": "7a37a8af56699eb20f29b196d8204676a717bfd8a63c356346fbba900215835b"
},
"downloads": -1,
"filename": "pyairahome-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9c18ba92d795648a7de6c719d9eb79a9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 281623,
"upload_time": "2025-08-10T12:43:10",
"upload_time_iso_8601": "2025-08-10T12:43:10.872800Z",
"url": "https://files.pythonhosted.org/packages/0c/f5/a7790be10f1e63fb7627ca675ada1abdffefc653a7c683d51d8fb5edc653/pyairahome-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "55a4eed596ef69068848915e167a3f2aef95a157e9d514ce1f58b95d2d74b6af",
"md5": "0459c613432eb7817ba081c35961c0ae",
"sha256": "6d47565c6108efda6a86d8e3f5afdc25e4b14730cfca21fe2e6f372a21cec81a"
},
"downloads": -1,
"filename": "pyairahome-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "0459c613432eb7817ba081c35961c0ae",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 92035,
"upload_time": "2025-08-10T12:43:13",
"upload_time_iso_8601": "2025-08-10T12:43:13.041525Z",
"url": "https://files.pythonhosted.org/packages/55/a4/eed596ef69068848915e167a3f2aef95a157e9d514ce1f58b95d2d74b6af/pyairahome-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-10 12:43:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Invy55",
"github_project": "pyairahome",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [
{
"name": "pycognito",
"specs": [
[
">=",
"2024.5.1"
]
]
},
{
"name": "grpcio",
"specs": [
[
">=",
"1.72.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
">=",
"6.31.1"
]
]
}
],
"lcname": "pyairahome"
}
JSON
