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.

License

MIT

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.3.0.tar.gz (20.0 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.3.0-py3-none-any.whl (17.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: mitsubishi_comfort-0.3.0.tar.gz
  • Upload date:
  • Size: 20.0 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.3.0.tar.gz
Algorithm Hash digest
SHA256 e67d7481cfee4e90cf3b04cc8739feef69f56ea6e62e22a37ec1b9598194deb6
MD5 dd70982d7027f236e33d8a0944bf427f
BLAKE2b-256 60d2fb9b29cefd991e90fbb1e371d0de348ca4d0b7a426327349dbb89ea62862

See more details on using hashes here.

Provenance

The following attestation bundles were made for mitsubishi_comfort-0.3.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mitsubishi_comfort-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 47162f1175fb5c5322c9ff26060d9139800362c09a3d798a7cb67ce4c350f4f1
MD5 9aa6c58aff9ce26ae046763d1351071c
BLAKE2b-256 2d5afb6b6e85e1cf808ebfaf94a10c0c1fa2889ec07b076f66c9972503dc08f5

See more details on using hashes here.

Provenance

The following attestation bundles were made for mitsubishi_comfort-0.3.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