aioaquarea-ng

aioaquarea-ng

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 (live reads only; Device.status_data_mode is CACHED when the library had to fall back to the cloud's cached status, which has no water pressure).
• Eco / comfort presets: Device.special_status reads the preset (SpecialStatus.ECO, SpecialStatus.COMFORT, or None); Device.set_special_status() switches it, moving the zone setpoints by the preset offsets like the app does.
• On/off state: Device.operation_status is ON while any zone or the tank is on.
• Zones: built from the device status, with the names set in the app (DeviceZone.name), the raw zone type/sensor values and cooling support from coolMode. Unconfigured placeholder zones are no longer reported.
• More device fields (read only): bivalent, bivalent_actual, external_heater, electric_anode, control_box, uncontrollable, service_type, multi_od_connection, model_series_selection, stand_alone, connection_status, dhw_flag (raw values; None when the unit does not report them).
• Consumption: Client.get_device_consumption() (day / month / year buckets) and Client.get_device_consumption_report() with the tariff and currency, last year's months (year view) and Consumption.is_future for buckets that are still in the future.
• Weekly timer (read only): Client.get_weekly_timer() / Device.get_weekly_timer() return the schedule (7 days x 6 slots) and the setpoint limits.
• Agreements: when Panasonic publishes new terms (error 4103) requests raise AgreementNotAcceptedError; accept them in the Panasonic Comfort Cloud app. Client.get_agreement_status() lists the accepted versions.

What the cloud API offers, and what has been verified, is described in docs/api-map.md.

Bug reports and pull requests are welcome in this repository.

Requirements

This library requires:

• Python >= 3.11
• 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.