Skip to main content

Asynchronous Python client for the Melcloud Home API

Project description

aiomelcloudhome

GitHub Release Python Versions Project Stage Project Maintenance License

GitHub Activity PyPI Downloads GitHub Last Commit Open in Dev Containers

Build Status Typing Status Code Coverage

Asynchronous Python client for MELCloud Home.

About

aiomelcloudhome is an async client for the MELCloud Home API, focused on:

  • Fetching account context (buildings and devices)
  • Controlling Air-to-Air units
  • Controlling Air-to-Water units
  • Reading telemetry (energy and actual measurements)

The library is under active development and endpoint coverage will keep expanding.

Installation

pip install aiomelcloudhome

Usage

Authenticate with username and password

import asyncio

from aiohttp import ClientSession

from aiomelcloudhome import MELCloudHome


async def main() -> None:
    async with ClientSession() as session:
        async with MELCloudHome(
            username="your@email.com",
            password="your_password",
            session=session,
        ) as client:
            context = await client.get_context()

            for building in context.buildings:
                print(f"Building: {building.name}")

                for unit in building.air_to_air_units:
                    print(f"ATA: {unit.name} (room: {unit.room_temperature} C)")

                for unit in building.air_to_water_units:
                    print(f"ATW: {unit.name} (tank: {unit.tank_water_temperature} C)")


if __name__ == "__main__":
    asyncio.run(main())

Authenticate with an existing access token

from aiomelcloudhome import MELCloudHome


client = MELCloudHome(access_token="YOUR_ACCESS_TOKEN")

Control an Air-to-Air unit

from aiomelcloudhome import ATAFanSpeed, ATAOperationMode, MELCloudHome


await client.control_ata_unit(
    "ata-unit-id",
    power=True,
    operation_mode=ATAOperationMode.HEAT,
    set_temperature=21.0,
    set_fan_speed=ATAFanSpeed.AUTO,
)

Control an Air-to-Water unit

from aiomelcloudhome import ATWZoneMode


await client.control_atw_unit(
    "atw-unit-id",
    power=True,
    operation_mode_zone1=ATWZoneMode.HEAT_ROOM_TEMPERATURE,
    set_temperature_zone1=21.0,
    set_tank_water_temperature=50.0,
)

Fetch telemetry

from datetime import UTC, datetime, timedelta


energy = await client.get_energy_telemetry(
    "unit-id",
    from_dt=datetime.now(UTC) - timedelta(days=1),
    to_dt=datetime.now(UTC),
)

outdoor = await client.get_outdoor_temperature("ata-unit-id")

More examples can be found in the examples directory.

Documentation

Project documentation and API reference: https://github.com/erwindouna/aiomelcloudhome

Contributing

Contributions are welcome. Please open an issue or pull request.

For local development:

uv sync --all-groups && uv run pre-commit install

Run checks:

uv run pre-commit run --all-files

Run tests:

uv run pytest

Update snapshot tests:

uv run pytest --snapshot-update

License

MIT License

Copyright (c) 2026 Erwin Douna

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

aiomelcloudhome-0.1.1.tar.gz (12.7 kB view details)

Uploaded Source

Built Distribution

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

aiomelcloudhome-0.1.1-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file aiomelcloudhome-0.1.1.tar.gz.

File metadata

  • Download URL: aiomelcloudhome-0.1.1.tar.gz
  • Upload date:
  • Size: 12.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for aiomelcloudhome-0.1.1.tar.gz
Algorithm Hash digest
SHA256 339b0c707615501cf007260333ac0ab35c7703b563c2a896dcc1ce7211093e9a
MD5 a55f8b9ea6b95ff00eb65ba1b25032cb
BLAKE2b-256 3dba08470ad3519538cba12f7b9558be45d9f15764b67869863e16726ae641cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiomelcloudhome-0.1.1.tar.gz:

Publisher: release.yaml on erwindouna/aiomelcloudhome

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

File details

Details for the file aiomelcloudhome-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for aiomelcloudhome-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d12d5c52d5cba1647d5d5b31280458474d008ee94ab0b77183eebe0407fef3ce
MD5 ca181d4f31de1ca7a8b164559e20ee97
BLAKE2b-256 3690b42d174dd5e9189ed2aa93cffe284696adfd4098e57fd0228aa3b2eda49f

See more details on using hashes here.

Provenance

The following attestation bundles were made for aiomelcloudhome-0.1.1-py3-none-any.whl:

Publisher: release.yaml on erwindouna/aiomelcloudhome

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