Skip to main content

Async Python library for Mitsubishi minisplit control via Kumo Cloud and local API

Project description

mitsubishi-comfort

Async Python library for controlling Mitsubishi minisplit systems via the Kumo Cloud V3 API and local HTTP API.

Features

  • Cloud discovery -- authenticate with Kumo Cloud to discover devices, retrieve credentials, and fetch device status
  • Local control -- communicate directly with minisplit units over your LAN for low-latency operation
  • Indoor units -- full control of mode, temperature setpoints, fan speed, and vane direction
  • Kumo stations -- read outdoor temperature and signal strength from headless outdoor units
  • Async native -- built on aiohttp for use in asyncio applications

Installation

pip install mitsubishi-comfort

Quick start

import asyncio
from mitsubishi_comfort import MitsubishiCloudAccount, IndoorUnit, Mode

async def main():
    # Discover devices via cloud API
    account = MitsubishiCloudAccount("user@example.com", "password")
    await account.login()
    devices = await account.discover_devices()

    # Control a device locally
    info = list(devices.values())[0]
    unit = IndoorUnit(
        name=info.label,
        address=info.address,
        password_b64=info.password,
        crypto_serial_hex=info.crypto_serial,
        serial=info.serial,
    )
    await unit.update_status()
    print(f"Room temp: {unit.status.room_temperature}")

    await unit.set_mode(Mode.COOL)
    await unit.set_cool_setpoint(22.0)

asyncio.run(main())

API overview

Cloud account

MitsubishiCloudAccount(username, password) authenticates with the Kumo Cloud V3 API.

Method Description
login() Authenticate and obtain JWT tokens
refresh() Refresh an expired access token
discover_devices() Return dict[serial, DeviceInfo] with full credentials
get_sites() List installation sites
get_zones(site_id) List zones within a site

Indoor unit

IndoorUnit controls a minisplit indoor unit over the local HTTP API.

Method Returns Description
update_status() bool Poll device for current state
set_mode(Mode) CommandResult Set operating mode
set_cool_setpoint(temp) CommandResult Set cooling target temperature
set_heat_setpoint(temp) CommandResult Set heating target temperature
set_fan_speed(FanSpeed) CommandResult Set fan speed
set_vane_direction(VaneDirection) CommandResult Set vane direction

Kumo station

KumoStation reads data from headless outdoor units (no control commands).

Method Returns Description
update_status() bool Poll device for current state

Enums

  • Mode -- OFF, COOL, HEAT, DRY, FAN, AUTO
  • FanSpeed -- SUPER_QUIET, QUIET, LOW, POWERFUL, SUPER_POWERFUL, AUTO
  • VaneDirection -- HORIZONTAL, MID_HORIZONTAL, MIDPOINT, MID_VERTICAL, VERTICAL, AUTO, SWING

Network discovery

probe_candidate_ips(devices, candidate_ips) matches device serials to LAN IP addresses by probing with device credentials.

Acknowledgments

This library builds on the protocol work of pykumo by Doug Larrick and contributors, which reverse-engineered the Kumo Cloud service and the local HTTP API used by Mitsubishi WiFi adapters. In particular:

  • The local API auth token computation (auth.py) is derived from pykumo's PyKumoBase._token.
  • The V3 cloud client (cloud.py), including the Socket.IO credential retrieval flow, is an async adaptation of pykumo's V3 support contributed by Ethan Kiczek.
  • The credential-probe approach to matching device serials to LAN addresses (discovery.py) follows pykumo's local discovery design.

mitsubishi-comfort exists as a separate library because it targets asyncio applications (notably Home Assistant), which requires a different architecture than pykumo's synchronous design. If you need a synchronous client, use pykumo.

License

MIT. Portions derived from pykumo, Copyright (c) 2019 dlarrick, also under the MIT license — see the third-party notices in LICENSE.

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

mitsubishi_comfort-0.4.0.tar.gz (28.8 kB view details)

Uploaded Source

Built Distribution

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

mitsubishi_comfort-0.4.0-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

Details for the file mitsubishi_comfort-0.4.0.tar.gz.

File metadata

  • Download URL: mitsubishi_comfort-0.4.0.tar.gz
  • Upload date:
  • Size: 28.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for mitsubishi_comfort-0.4.0.tar.gz
Algorithm Hash digest
SHA256 65c938e08e8738925f69695f03f3c4030c0d8e9661f26ef4471e928b2cbc18c2
MD5 d687ff9f2f19aaa7e6acdfab2099a589
BLAKE2b-256 6b08c1f9c20846e890d28e00906d3b15e46180ffdffd9c24069227e713838055

See more details on using hashes here.

Provenance

The following attestation bundles were made for mitsubishi_comfort-0.4.0.tar.gz:

Publisher: publish.yml on nikolairahimi/mitsubishi-comfort

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

File details

Details for the file mitsubishi_comfort-0.4.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mitsubishi_comfort-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6ad28c1015c7a08ec7f3066c614828608969fadb2116ccb340edf743f837748a
MD5 8e9e272f51fe67ffb496af1b0db5ba06
BLAKE2b-256 ef4b8f46e2dc9e9bfa466f065dcf568887d3d5b2311ab5d8d9a6135ca8bd73f2

See more details on using hashes here.

Provenance

The following attestation bundles were made for mitsubishi_comfort-0.4.0-py3-none-any.whl:

Publisher: publish.yml on nikolairahimi/mitsubishi-comfort

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