midea-dishwasher-api 1.0.0__tar.gz

midea_dishwasher_api-1.0.0/.gitignore

@@ -0,0 +1,9 @@
+/resources/
+.env
+.venv/
+__pycache__/
+*.pyc
+.pytest_cache/
+*.egg-info/
+build/
+dist/

midea_dishwasher_api-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+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.

midea_dishwasher_api-1.0.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: midea-dishwasher-api
+Version: 1.0.0
+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
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Provides-Extra: lan
+Requires-Dist: cryptography>=42; extra == 'lan'
+Description-Content-Type: text/markdown
+
+# midea-dishwasher-api
+
+Cliente Python para lava-louças Midea (`device_type 0xE1`, plugin v5).
+
+Implementa o protocolo de aplicação `AA … E1` e a camada de transporte LAN V3
+(handshake 8370 + AES-128-CBC + SHA-256, com framing V2 5A5A interno).
+
+## Instalação
+
+```bash
+pip install midea-dishwasher-api[lan]
+```
+
+O extra `lan` instala `cryptography`, necessário para falar diretamente com a
+máquina via LAN. Sem o extra, o pacote ainda expõe o codec do frame e o
+parser de status para uso com transporte próprio (cloud, mock, etc.).
+
+## Uso rápido
+
+```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)       # minutos restantes (apenas em WORK)
+    print(status.door_closed)
+    print(status.bright_lack)     # secante acabou?
+
+    client.power_on()
+    client.start_to_work(mode=Mode.ECO, extra_drying=True)
+    client.set_bright(BrightLevel.L3)
+    client.cancel_work()
+    client.power_off()
+```
+
+Os métodos de controle não retornam estado (a máquina demora alguns segundos
+para refletir a mudança). Chame `query_status()` quando quiser estado fresco.
+
+## API
+
+### Client
+
+| Método | Efeito |
+|---|---|
+| `query_status() -> DishwasherStatus` | Lê o estado atual |
+| `power_on()` | Liga a máquina |
+| `power_off()` | Desliga |
+| `cancel_work()` | Cancela ciclo / volta ao idle |
+| `start_to_work(mode, extra_drying=False)` | Inicia ciclo |
+| `set_bright(level: BrightLevel)` | Ajusta o nível do abrilhantador (1–5) |
+
+### DishwasherStatus
+
+Campos decodificados da resposta:
+
+- `machine_state: MachineState | None` — `POWER_ON` / `POWER_OFF`
+- `cycle_state: CycleState | None` — `idle`, `order`, `work`, `error`, ...
+- `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` — minutos restantes (preenchido apenas quando `cycle_state == WORK`)
+- `door_closed: bool`
+- `bright_lack: bool` — secante (rinse aid) acabou
+
+### Modos disponíveis (`Mode`)
+
+`AUTO`, `INTENSIVE`, `NORMAL`, `ECO`, `GLASS`, `NINETY_MIN`, `ONE_HOUR`,
+`RAPID`, `SOAK`, `THREE_IN_ONE`, `HYGIENE`, `QUIET`, `PARTY`, `FRUIT`.
+
+## Transporte customizado
+
+`Client` aceita qualquer `Callable[[bytes], bytes]` como `send`. Útil para
+testes com transporte mock, integração com cloud, ou pipeline próprio:
+
+```python
+def fake_send(frame: bytes) -> bytes:
+    return assemble_frame(b"...", 0x02)
+
+client = Client(send=fake_send)
+```
+
+## Como obter `token` e `key`
+
+São credenciais por dispositivo emitidas pela cloud da Midea. Use ferramentas
+existentes (`midea-msmart`, `midea-beautiful-air`, `midea-discover`) para
+extrair a partir da sua conta no app.
+
+## Licença
+
+MIT — ver `LICENSE`.

midea_dishwasher_api-1.0.0/README.md

@@ -0,0 +1,98 @@
+# midea-dishwasher-api
+
+Cliente Python para lava-louças Midea (`device_type 0xE1`, plugin v5).
+
+Implementa o protocolo de aplicação `AA … E1` e a camada de transporte LAN V3
+(handshake 8370 + AES-128-CBC + SHA-256, com framing V2 5A5A interno).
+
+## Instalação
+
+```bash
+pip install midea-dishwasher-api[lan]
+```
+
+O extra `lan` instala `cryptography`, necessário para falar diretamente com a
+máquina via LAN. Sem o extra, o pacote ainda expõe o codec do frame e o
+parser de status para uso com transporte próprio (cloud, mock, etc.).
+
+## Uso rápido
+
+```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)       # minutos restantes (apenas em WORK)
+    print(status.door_closed)
+    print(status.bright_lack)     # secante acabou?
+
+    client.power_on()
+    client.start_to_work(mode=Mode.ECO, extra_drying=True)
+    client.set_bright(BrightLevel.L3)
+    client.cancel_work()
+    client.power_off()
+```
+
+Os métodos de controle não retornam estado (a máquina demora alguns segundos
+para refletir a mudança). Chame `query_status()` quando quiser estado fresco.
+
+## API
+
+### Client
+
+| Método | Efeito |
+|---|---|
+| `query_status() -> DishwasherStatus` | Lê o estado atual |
+| `power_on()` | Liga a máquina |
+| `power_off()` | Desliga |
+| `cancel_work()` | Cancela ciclo / volta ao idle |
+| `start_to_work(mode, extra_drying=False)` | Inicia ciclo |
+| `set_bright(level: BrightLevel)` | Ajusta o nível do abrilhantador (1–5) |
+
+### DishwasherStatus
+
+Campos decodificados da resposta:
+
+- `machine_state: MachineState | None` — `POWER_ON` / `POWER_OFF`
+- `cycle_state: CycleState | None` — `idle`, `order`, `work`, `error`, ...
+- `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` — minutos restantes (preenchido apenas quando `cycle_state == WORK`)
+- `door_closed: bool`
+- `bright_lack: bool` — secante (rinse aid) acabou
+
+### Modos disponíveis (`Mode`)
+
+`AUTO`, `INTENSIVE`, `NORMAL`, `ECO`, `GLASS`, `NINETY_MIN`, `ONE_HOUR`,
+`RAPID`, `SOAK`, `THREE_IN_ONE`, `HYGIENE`, `QUIET`, `PARTY`, `FRUIT`.
+
+## Transporte customizado
+
+`Client` aceita qualquer `Callable[[bytes], bytes]` como `send`. Útil para
+testes com transporte mock, integração com cloud, ou pipeline próprio:
+
+```python
+def fake_send(frame: bytes) -> bytes:
+    return assemble_frame(b"...", 0x02)
+
+client = Client(send=fake_send)
+```
+
+## Como obter `token` e `key`
+
+São credenciais por dispositivo emitidas pela cloud da Midea. Use ferramentas
+existentes (`midea-msmart`, `midea-beautiful-air`, `midea-discover`) para
+extrair a partir da sua conta no app.
+
+## Licença
+
+MIT — ver `LICENSE`.

midea_dishwasher_api-1.0.0/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "midea-dishwasher-api"
+version = "1.0.0"
+description = "Cliente Python para lava-louças Midea (device_type 0xE1, plugin v5) — codec do frame AA + transporte LAN V3."
+readme = "README.md"
+license = { file = "LICENSE" }
+requires-python = ">=3.14"
+authors = [
+    { name = "Rodrigo Roque", email = "rodrigogoncalvesroque@gmail.com" },
+]
+keywords = ["midea", "dishwasher", "iot", "smart-home", "lan"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Home Automation",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+]
+dependencies = []
+
+[project.optional-dependencies]
+lan = ["cryptography>=42"]
+dev = ["pytest>=8"]
+
+[project.urls]
+Homepage = "https://github.com/roquerodrigo/midea-dishwasher-api"
+Repository = "https://github.com/roquerodrigo/midea-dishwasher-api"
+Issues = "https://github.com/roquerodrigo/midea-dishwasher-api/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/midea_dishwasher_api"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "src/midea_dishwasher_api",
+    "tests",
+    "README.md",
+    "LICENSE",
+    "pyproject.toml",
+]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/__init__.py

@@ -0,0 +1,63 @@
+"""Cliente Python para a lava-louças Midea (device type `0xE1`)."""
+
+from importlib.metadata import PackageNotFoundError, version
+from typing import TYPE_CHECKING, Any
+
+from .client import Client
+from .enums import (
+    BrightLevel,
+    CycleState,
+    ErrorCode,
+    MachineState,
+    Mode,
+    MsgType,
+    WashStage,
+)
+from .protocol import (
+    ControlPayload,
+    FrameError,
+    assemble_frame,
+    build_control,
+    build_query,
+    parse_frame,
+)
+from .state import DishwasherStatus, decode_response
+
+if TYPE_CHECKING:
+    from .transport import OnWireCallback, V3Transport
+
+try:
+    __version__ = version("midea-dishwasher-api")
+except PackageNotFoundError:
+    __version__ = "0.0.0+local"
+
+__all__ = [
+    "BrightLevel",
+    "Client",
+    "ControlPayload",
+    "CycleState",
+    "DishwasherStatus",
+    "ErrorCode",
+    "FrameError",
+    "MachineState",
+    "Mode",
+    "MsgType",
+    "OnWireCallback",
+    "V3Transport",
+    "WashStage",
+    "__version__",
+    "assemble_frame",
+    "build_control",
+    "build_query",
+    "decode_response",
+    "parse_frame",
+]
+
+_LAZY_TRANSPORT_EXPORTS = {"V3Transport", "OnWireCallback"}
+
+
+def __getattr__(name: str) -> Any:
+    if name in _LAZY_TRANSPORT_EXPORTS:
+        from . import transport
+        return getattr(transport, name)
+    raise AttributeError(f"module 'midea_dishwasher_api' has no attribute {name!r}")

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/client.py

@@ -0,0 +1,41 @@
+"""Cliente de alto nível: cada método replica uma operação `$api(...)` do app."""
+
+from __future__ import annotations
+
+from typing import Callable
+
+from .enums import BrightLevel, Mode
+from .protocol import ControlPayload, build_control, build_query
+from .state import DishwasherStatus, decode_response
+
+Send = Callable[[bytes], bytes]
+
+
+class Client:
+    def __init__(self, send: Send) -> None:
+        self._send: Send = send
+
+    def query_status(self) -> DishwasherStatus:
+        return decode_response(self._send(build_query()))
+
+    def power_on(self) -> None:
+        self._control({"machine_state": "power_on"})
+
+    def power_off(self) -> None:
+        self._control({"machine_state": "power_off"})
+
+    def cancel_work(self) -> None:
+        self._control({"machine_state": "cancel"})
+
+    def start_to_work(self, mode: Mode, extra_drying: bool = False) -> None:
+        self._control({
+            "mode": str(mode),
+            "machine_state": "work",
+            "additional": 1 if extra_drying else 0,
+        })
+
+    def set_bright(self, level: BrightLevel) -> None:
+        self._control({"bright": int(BrightLevel(level))})
+
+    def _control(self, payload: ControlPayload) -> None:
+        self._send(build_control(payload))

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/__init__.py

@@ -0,0 +1,17 @@
+from .bright_level import BrightLevel
+from .cycle_state import CycleState
+from .error_code import ErrorCode
+from .machine_state import MachineState
+from .mode import Mode
+from .msg_type import MsgType
+from .wash_stage import WashStage
+
+__all__ = [
+    "BrightLevel",
+    "CycleState",
+    "ErrorCode",
+    "MachineState",
+    "Mode",
+    "MsgType",
+    "WashStage",
+]

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/bright_level.py

@@ -0,0 +1,13 @@
+"""Nível do abrilhantador (rinse aid), 1 a 5."""
+
+from __future__ import annotations
+
+from enum import IntEnum
+
+
+class BrightLevel(IntEnum):
+    L1 = 1
+    L2 = 2
+    L3 = 3
+    L4 = 4
+    L5 = 5

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/cycle_state.py

@@ -0,0 +1,28 @@
+"""Estado atual do ciclo (byte 1 da resposta de status)."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+class CycleState(StrEnum):
+    POWER_OFF = "power_off"
+    IDLE = "idle"
+    ORDER = "order"
+    WORK = "work"
+    ERROR = "error"
+    SOFT_GEAR = "soft_gear"
+
+    @classmethod
+    def from_byte(cls, byte: int) -> "CycleState | None":
+        return _BYTE_TO_CYCLE_STATE.get(byte)
+
+
+_BYTE_TO_CYCLE_STATE: dict[int, CycleState] = {
+    0x00: CycleState.POWER_OFF,
+    0x01: CycleState.IDLE,
+    0x02: CycleState.ORDER,
+    0x03: CycleState.WORK,
+    0x04: CycleState.ERROR,
+    0x05: CycleState.SOFT_GEAR,
+}

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/error_code.py

@@ -0,0 +1,20 @@
+"""Código de falha reportado pela máquina (byte 10 da resposta)."""
+
+from __future__ import annotations
+
+from enum import IntEnum
+
+
+class ErrorCode(IntEnum):
+    NONE = 0
+    WATER_SUPPLY = 1
+    HEATING = 2
+    OVERFLOW = 3
+    WATER_VALVE = 4
+
+    @classmethod
+    def from_byte(cls, byte: int) -> "ErrorCode | int":
+        try:
+            return cls(byte)
+        except ValueError:
+            return byte

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/machine_state.py

@@ -0,0 +1,12 @@
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+class MachineState(StrEnum):
+    POWER_ON = "power_on"
+    POWER_OFF = "power_off"
+
+    @classmethod
+    def from_byte(cls, byte: int) -> "MachineState":
+        return cls.POWER_OFF if byte == 0x00 else cls.POWER_ON

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/mode.py

@@ -0,0 +1,52 @@
+"""Modos de lavagem suportados pela máquina (byte 2 do controle 0x08)."""
+
+from __future__ import annotations
+
+from enum import StrEnum
+
+
+class Mode(StrEnum):
+    AUTO = "auto"
+    INTENSIVE = "intensive"
+    NORMAL = "normal"
+    ECO = "eco"
+    GLASS = "glass"
+    NINETY_MIN = "90min"
+    ONE_HOUR = "1hour"
+    RAPID = "rapid"
+    SOAK = "soak"
+    THREE_IN_ONE = "3in1"
+    HYGIENE = "hygiene"
+    QUIET = "quiet"
+    PARTY = "party"
+    FRUIT = "fruit"
+
+    def to_byte(self) -> int:
+        return _MODE_TO_BYTE[self]
+
+    @classmethod
+    def byte_for(cls, mode: str | None) -> int:
+        if mode is None:
+            return 0x00
+        try:
+            return _MODE_TO_BYTE[cls(mode)]
+        except ValueError:
+            return 0x00
+
+
+_MODE_TO_BYTE: dict[Mode, int] = {
+    Mode.AUTO: 0x01,
+    Mode.INTENSIVE: 0x02,
+    Mode.NORMAL: 0x03,
+    Mode.ECO: 0x04,
+    Mode.GLASS: 0x05,
+    Mode.NINETY_MIN: 0x06,
+    Mode.RAPID: 0x07,
+    Mode.SOAK: 0x08,
+    Mode.ONE_HOUR: 0x09,
+    Mode.THREE_IN_ONE: 0x0A,
+    Mode.PARTY: 0x0C,
+    Mode.QUIET: 0x0D,
+    Mode.HYGIENE: 0x0F,
+    Mode.FRUIT: 0x13,
+}

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/msg_type.py

@@ -0,0 +1,11 @@
+"""Tipo de mensagem do frame (byte 9)."""
+
+from __future__ import annotations
+
+from enum import IntEnum
+
+
+class MsgType(IntEnum):
+    CONTROL = 0x02
+    QUERY = 0x03
+    PUSH = 0x04

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/enums/wash_stage.py

@@ -0,0 +1,21 @@
+"""Etapa atual do ciclo de lavagem (byte 9 da resposta)."""
+
+from __future__ import annotations
+
+from enum import IntEnum
+
+
+class WashStage(IntEnum):
+    IDLE = 0
+    PRE_WASH = 1
+    MAIN_WASH = 2
+    RINSE = 3
+    DRY = 4
+    FINISH = 5
+
+    @classmethod
+    def from_byte(cls, byte: int) -> "WashStage | int":
+        try:
+            return cls(byte)
+        except ValueError:
+            return byte

midea_dishwasher_api-1.0.0/src/midea_dishwasher_api/protocol/__init__.py

@@ -0,0 +1,29 @@
+from .codec import (
+    CONTROL_BODY_LEN,
+    DEVICE_TYPE,
+    HEADER_LEN,
+    QUERY_BODY,
+    SYNC,
+    ControlPayload,
+    assemble_frame,
+    build_control,
+    build_query,
+    make_sum,
+    parse_frame,
+)
+from .frame_error import FrameError
+
+__all__ = [
+    "CONTROL_BODY_LEN",
+    "ControlPayload",
+    "DEVICE_TYPE",
+    "FrameError",
+    "HEADER_LEN",
+    "QUERY_BODY",
+    "SYNC",
+    "assemble_frame",
+    "build_control",
+    "build_query",
+    "make_sum",
+    "parse_frame",
+]