Skip to main content

aioaquarea-ng

PyPI

Asynchronous Python library for Panasonic Aquarea heat pumps, through the Panasonic Aquarea Smart Cloud API. It powers the home-assistant-aquarea integration.

This is the maintained fork of cjaliaga/aioaquarea, originally written by Carlos J. Aliaga. Upstream has had no merges or releases since May 2026, and Panasonic has started enforcing multi-factor authentication on logins (cjaliaga/aioaquarea#92), so development continues here. The package name changed; the import name did not.

Installation

pip install aioaquarea-ng
import aioaquarea  # same import name as the original package

Don't install it next to the original aioaquarea package: both provide the aioaquarea module.

Status

  • Multi-factor authentication: accounts with Panasonic's MFA (SMS or authenticator app code) are supported. Client.login() raises MfaRequiredError (an AuthenticationError with code MFA_REQUIRED) carrying an MfaChallenge; pass the code to Client.complete_mfa(). See Multi-factor authentication.
  • Water pressure: Device.water_pressure (bar), when the unit reports it.

Bug reports and pull requests are welcome in this repository.

Requirements

This library requires:

  • Python >= 3.9
  • asyncio
  • aiohttp

Usage

The library supports the production environment of the Panasonic Aquarea Smart Cloud API and also the Demo environment. One of the main usages of this library is to integrate the Panasonic Aquarea Smart Cloud API with Home Assistant via home-assistant-aquarea

Here is a simple example of how to use the library via getting a device object to interact with it:

from aioaquarea import (
    Client,
    AquareaEnvironment,
    UpdateOperationMode
)

import aiohttp
import asyncio
import logging
from datetime import timedelta

async def main():
    async with aiohttp.ClientSession() as session:
        client = Client(
            username="USERNAME",
            password="PASSWORD",
            session=session,
            device_direct=True,
            refresh_login=True,
            environment=AquareaEnvironment.PRODUCTION,
        )

        # The library is designed to retrieve a device object and interact with it:
        devices = await client.get_devices(include_long_id=True)

        # Picking the first device associated with the account:
        device_info = devices[0]

        device = await client.get_device(
            device_info=device_info, consumption_refresh_interval=timedelta(minutes=1)
        )

        # Or the device can also be retrieved by its long id if we know it:
        device = await client.get_device(
            device_id="LONG ID", consumption_refresh_interval=timedelta(minutes=1)
        )

        # Then we can interact with the device:
        await device.set_mode(UpdateOperationMode.HEAT)

        # The device can automatically refresh its data:
        await device.refresh_data()

Multi-factor authentication

from aioaquarea import Client, MfaRequiredError

client = Client(session, username, password)
try:
    await client.login()
except MfaRequiredError as err:
    challenge = err.challenge  # factor "sms" or "otp", masked destination, code_sent
    # For SMS the code has been texted already; ask the user for the code, then:
    await client.complete_mfa(code)  # logged in now, like after a normal login
    # await client.resend_mfa_code()  # SMS only

complete_mfa raises AuthenticationError with code MFA_INVALID_CODE for a wrong code (retry with another one), MFA_EXPIRED when the MFA transaction timed out (call login() again) and API_ERROR (naming the step) for anything unexpected. Pages or factors that are not supported (for example push notifications) raise a plain MFA_REQUIRED error without a challenge. Pass mfa_send_code=False to the client for background logins that must not text a code.

Avoiding MFA on every login: the login asks for the offline_access scope, so the token response normally carries a refresh token. Store client.refresh_token (a secret) and pass it as Client(session, username, password, refresh_token=...); login() then refreshes the token without the password or an MFA code, and only falls back to the password (and MFA) when Panasonic rejects the refresh token. The refresh token can rotate: pass refresh_token_callback= (a plain function taking the new token) to be told whenever a login or refresh returned a different one.

Acknowledgements

The original library is by Carlos J. Aliaga (cjaliaga/aioaquarea), MIT licensed.

Big thanks to ronhks for his awesome work on the Panasonic Aquarea Smart Cloud integration with MQTT.

Metadata

Release files for aioaquarea-ng 1.3.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aioaquarea-ng 1.3.1
File Size Uploaded
aioaquarea_ng-1.3.1.tar.gz 56.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for aioaquarea-ng 1.3.1
File Interpreter ABI Platform
aioaquarea_ng-1.3.1-py3-none-any.whl Python 3 none any Details

Total release size: 102.3 kB

Release files / aioaquarea_ng-1.3.1.tar.gz

Download URL aioaquarea_ng-1.3.1.tar.gz
Size 56.7 kB
Tags Source
SHA-256 checksum
How to use checksums
f086e9aecaa1a669cab62e30dba5ea406804c573730fef62b31c69aafd6b97a6
BLAKE2b-256 checksum
How to use checksums
de4c0d86e3a901d6b2acaf19db4e252b786fadebcdf4394b9ef04f394027edca
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release files / aioaquarea_ng-1.3.1-py3-none-any.whl

Download URL aioaquarea_ng-1.3.1-py3-none-any.whl
Size 45.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
0acd04c9c062de6853d6bfd6dc83c420efbe6d2ea7fcbecd142c163db352cf21
BLAKE2b-256 checksum
How to use checksums
e86d822097510494b991cdf50f897a9b13f82e9c79f08f74b6ced222d94f5a0a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 10, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.3.1 This release

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page