Metadata-Version: 2.4
Name: midea-dishwasher-api
Version: 1.3.5
Summary: Cliente Python para lava-louças Midea (device_type 0xE1, plugin v5) — codec do frame AA + transporte LAN V3.
Project-URL: Homepage, https://github.com/roquerodrigo/midea-dishwasher-api
Project-URL: Repository, https://github.com/roquerodrigo/midea-dishwasher-api
Project-URL: Issues, https://github.com/roquerodrigo/midea-dishwasher-api/issues
Author-email: Rodrigo Roque <rodrigogoncalvesroque@gmail.com>
License: MIT License
        
        Copyright (c) 2026 Rodrigo Roque
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Keywords: dishwasher,iot,lan,midea,smart-home
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Python: >=3.14
Requires-Dist: cryptography>=43.0.0
Description-Content-Type: text/markdown

# midea-dishwasher-api

[![CI](https://github.com/roquerodrigo/midea-dishwasher-api/actions/workflows/ci.yml/badge.svg)](https://github.com/roquerodrigo/midea-dishwasher-api/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/midea-dishwasher-api)](https://pypi.org/project/midea-dishwasher-api/)

Python client for Midea dishwashers (`device_type 0xE1`, plugin v5).

Implements the `AA … E1` application protocol and the LAN V3 transport (8370
handshake + AES-128-CBC + SHA-256, with the inner V2 `5A5A` framing).

## Installation

```bash
pip install midea-dishwasher-api
```

## Quick start

```python
from midea_dishwasher_api import BrightLevel, Client, Mode, V3Transport

with V3Transport(
    host="192.168.5.100",
    device_id=151732606394621,
    token=bytes.fromhex("..."),  # 64 bytes
    key=bytes.fromhex("..."),    # 32 bytes
) as transport:
    client = Client(send=transport)

    status = client.query_status()
    print(status.machine_state)   # MachineState.POWER_ON / POWER_OFF
    print(status.cycle_state)     # CycleState.IDLE / WORK / ORDER / ...
    print(status.left_time)       # minutes remaining (only while WORK)
    print(status.door_closed)
    print(status.bright_lack)     # is the rinse aid empty?

    client.power_on()
    client.start_to_work(mode=Mode.ECO, extra_drying=True)
    client.set_bright(BrightLevel.L3)
    client.cancel_work()
    client.power_off()
```

Control methods return nothing: the machine takes a few seconds to reflect a
change. Call `query_status()` whenever fresh state is needed.

## API

### Client

| Method | Effect |
|---|---|
| `query_status() -> DishwasherStatus` | Read the current state |
| `power_on()` | Power the machine on |
| `power_off()` | Power it off |
| `cancel_work()` | Cancel the cycle / return to idle |
| `start_to_work(mode, extra_drying=False)` | Start a cycle |
| `set_bright(level: BrightLevel)` | Set the rinse-aid level (1–5) |

`extra_drying` is keyword-only.

### DishwasherStatus

Fields decoded from a response:

- `machine_state: MachineState | None` — `POWER_ON` / `POWER_OFF`
- `cycle_state: CycleState | None` — `idle`, `order`, `work`, `error`, ...
- `mode: Mode | int | None` — the running program; `None` when there is none
  (`0x00`), `int` for program bytes not yet catalogued in the enum
- `extra_drying: bool` — "extra drying" flag of the current program
- `wash_stage: WashStage | int | None` — `IDLE`, `PRE_WASH`, `MAIN_WASH`, `RINSE`, `DRY`, `FINISH`
- `error_code: ErrorCode | int` — `NONE`, `WATER_SUPPLY`, `HEATING`, `OVERFLOW`, `WATER_VALVE`
- `left_time: int | None` — minutes remaining (only set when `cycle_state == WORK`)
- `door_closed: bool`
- `bright_lack: bool` — the rinse aid ran out
- `bright: BrightLevel | int | None` — current rinse-aid level (1–5)

### Available programs (`Mode`)

`AUTO`, `INTENSIVE`, `NORMAL`, `ECO`, `GLASS`, `NINETY_MIN`, `ONE_HOUR`,
`RAPID`, `SOAK`, `THREE_IN_ONE`, `HYGIENE`, `QUIET`, `PARTY`, `FRUIT`.

## Custom transport

`Client` accepts any `Callable[[bytes], bytes]` as `send`. Useful for tests
with a mock transport, for a cloud integration, or for a pipeline of your own:

```python
from midea_dishwasher_api.protocol import assemble_frame

def fake_send(frame: bytes) -> bytes:
    return assemble_frame(b"...", 0x02)

client = Client(send=fake_send)
```

The low-level codec (`assemble_frame`, `parse_frame`, `build_query`,
`build_control`, `make_sum`) and the status decoder (`decode_response`) live in
`midea_dishwasher_api.protocol` and `midea_dishwasher_api.state` respectively —
outside the public `__init__.py`.

## Obtaining `token` and `key`

They are per-device credentials issued by the Midea cloud. Use one of the
existing tools (`midea-msmart`, `midea-beautiful-air`, `midea-discover`) to
extract them from your app account.

## License

MIT — see `LICENSE`.
