python-library-xiaomi-miot 0.1.0__tar.gz

python_library_xiaomi_miot-0.1.0/.gitignore

@@ -0,0 +1,11 @@
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.venv/
+.env
+.pytest_cache/
+config.yaml
+logs/

python_library_xiaomi_miot-0.1.0/PKG-INFO

@@ -0,0 +1,6 @@
+Metadata-Version: 2.4
+Name: python-library-xiaomi-miot
+Version: 0.1.0
+Requires-Python: >=3.10
+Requires-Dist: pydantic
+Requires-Dist: python-miio

python_library_xiaomi_miot-0.1.0/example_switch.bat

@@ -0,0 +1,11 @@
+@echo off
+cd /d %~dp0
+
+if not exist .venv (
+    call update.bat
+)
+
+call .venv\Scripts\activate.bat
+
+pip install python-dotenv
+python examples/switch

python_library_xiaomi_miot-0.1.0/examples/switch/__main__.py

@@ -0,0 +1,59 @@
+import os
+import time
+from pathlib import Path
+from dotenv import load_dotenv
+from xiaomi_miot import execute
+
+load_dotenv(Path(__file__).resolve().parents[2] / ".env")
+
+IP = os.environ["SWITCH_IP"]
+TOKEN = os.environ["SWITCH_TOKEN"]
+EXPECTED = os.environ["SWITCH_VALUE"].lower() == "true"
+
+base = {"type": "switch", "ip": IP, "token": TOKEN}
+tests: list[tuple[str, dict, bool]] = []  # (name, result, passed)
+
+
+def check(name: str, result: dict, expect_on: bool | None = None):
+    if expect_on is not None:
+        passed = result.get("ok") and result.get("value") == expect_on
+    else:
+        passed = result.get("ok", False)
+    tests.append((name, result, passed))
+
+
+# Step 1: 获取初始状态
+r = execute(base)
+check("获取初始状态", r)
+
+# Step 2: 设置为期望值的【相反值】
+r = execute({**base, "on": not EXPECTED})
+check(f"设置为 {not EXPECTED}", r)
+
+time.sleep(3)
+
+# Step 3: 验证反向值生效
+r = execute(base)
+check(f"验证状态 == {not EXPECTED}", r, expect_on=not EXPECTED)
+
+# Step 4: 设置为最终期望值
+r = execute({**base, "on": EXPECTED})
+check(f"设置为 {EXPECTED}", r)
+
+# Step 5: 验证最终期望值生效
+r = execute(base)
+check(f"验证状态 == {EXPECTED}", r, expect_on=EXPECTED)
+
+# 打印测试结果
+print("\n" + "=" * 50)
+print("测试结果")
+print("=" * 50)
+all_passed = True
+for name, result, passed in tests:
+    icon = "PASS" if passed else "FAIL"
+    print(f"  [{icon}] {name}")
+    if not passed:
+        all_passed = False
+        print(f"         {result}")
+print("=" * 50)
+print(f"{'全部通过' if all_passed else '存在失败'} ({sum(p for *_, p in tests)}/{len(tests)})")

python_library_xiaomi_miot-0.1.0/pyproject.toml

@@ -0,0 +1,18 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "python-library-xiaomi-miot"
+version = "0.1.0"
+requires-python = ">=3.10"
+dependencies = [
+  "python-miio",
+  "pydantic",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["xiaomi_miot"]
+
+[tool.hatch.metadata]
+allow-direct-references = true

python_library_xiaomi_miot-0.1.0/update.bat

@@ -0,0 +1,9 @@
+@echo off
+cd /d %~dp0
+
+if not exist .venv (
+    python -m venv .venv
+)
+
+call .venv\Scripts\activate.bat
+python -m pip install -e .

python_library_xiaomi_miot-0.1.0/xiaomi_miot/__init__.py

@@ -0,0 +1,17 @@
+import warnings
+warnings.filterwarnings("ignore", category=FutureWarning, module=r"miio\.miot_device")
+
+from .device import MiotDevice
+from .models import DeviceParams, GetParams, SetParams
+from .extensions import get_extension, list_extensions
+from ._api import execute
+
+__all__ = [
+    "MiotDevice",
+    "DeviceParams",
+    "GetParams",
+    "SetParams",
+    "get_extension",
+    "list_extensions",
+    "execute",
+]

python_library_xiaomi_miot-0.1.0/xiaomi_miot/_api.py

@@ -0,0 +1,54 @@
+from .device import MiotDevice
+from .models import DeviceParams, GetParams, SetParams
+from .extensions import get_extension, list_extensions
+
+
+def execute(params: dict) -> dict:
+    """统一入口，用户输入永远是 dict
+
+    通用模式（无 type）:
+        {"ip": "...", "token": "...", "siid": 2, "piid": 1}              → 读属性
+        {"ip": "...", "token": "...", "siid": 2, "piid": 1, "value": 1}  → 写属性
+        {"ip": "...", "token": "...", "action": "info"}                   → 设备信息
+
+    扩展模式（有 type）:
+        {"type": "switch", "ip": "...", "token": "...", "on": True}       → 走开关扩展
+    """
+    device_type = params.get("type")
+
+    if device_type:
+        return _execute_extension(device_type, params)
+    return _execute_generic(params)
+
+
+def _execute_extension(device_type: str, params: dict) -> dict:
+    ext_cls = get_extension(device_type)
+    if ext_cls is None:
+        return {
+            "ok": False,
+            "error": f"未知设备类型: {device_type}",
+            "available": list_extensions(),
+        }
+
+    ext = ext_cls()
+    validated = ext.Params(**params)
+    device = MiotDevice(validated.ip, validated.token)
+    return ext.execute(device, validated)
+
+
+def _execute_generic(params: dict) -> dict:
+    action = params.get("action", "prop")
+
+    if action == "info":
+        dp = DeviceParams(**params)
+        device = MiotDevice(dp.ip, dp.token)
+        return {"ok": True, **device.info()}
+
+    if "value" in params:
+        sp = SetParams(**params)
+        device = MiotDevice(sp.ip, sp.token)
+        return device.set_prop(sp.did, sp.siid, sp.piid, sp.value)
+
+    gp = GetParams(**params)
+    device = MiotDevice(gp.ip, gp.token)
+    return device.get_prop(gp.did, gp.siid, gp.piid)

python_library_xiaomi_miot-0.1.0/xiaomi_miot/device.py

@@ -0,0 +1,48 @@
+from miio import Device
+
+
+class MiotDevice:
+    """纯局域网 MIoT 设备操作，不依赖云端"""
+
+    def __init__(self, ip: str, token: str):
+        self._dev = Device(ip, token)
+
+    def info(self) -> dict:
+        """获取设备基本信息（model, firmware, hardware 等）"""
+        raw = self._dev.info()
+        return {
+            "model": raw.model,
+            "mac": raw.mac_address,
+            "firmware": raw.firmware_version,
+            "hardware": raw.hardware_version,
+            "raw": str(raw),
+        }
+
+    def get_prop(self, did: str, siid: int, piid: int) -> dict:
+        results = self._dev.send("get_properties", [
+            {"did": did, "siid": siid, "piid": piid}
+        ])
+        r = results[0]
+        if r.get("code") == 0:
+            return {"ok": True, "value": r["value"]}
+        return {"ok": False, "error": r}
+
+    def get_props(self, props: list[dict]) -> list[dict]:
+        return self._dev.send("get_properties", props)
+
+    def set_prop(self, did: str, siid: int, piid: int, value) -> dict:
+        results = self._dev.send("set_properties", [
+            {"did": did, "siid": siid, "piid": piid, "value": value}
+        ])
+        r = results[0]
+        if r.get("code") == 0:
+            return {"ok": True}
+        return {"ok": False, "error": r}
+
+    def set_props(self, props: list[dict]) -> list[dict]:
+        return self._dev.send("set_properties", props)
+
+    def call_action(self, did: str, siid: int, aiid: int, params: list | None = None) -> dict:
+        return self._dev.send("action", {
+            "did": did, "siid": siid, "aiid": aiid, "in": params or []
+        })

python_library_xiaomi_miot-0.1.0/xiaomi_miot/extensions/__init__.py

@@ -0,0 +1,7 @@
+from ._registry import extension, get_extension, list_extensions
+
+__all__ = [
+    "extension",
+    "get_extension",
+    "list_extensions",
+]

python_library_xiaomi_miot-0.1.0/xiaomi_miot/extensions/_registry.py

@@ -0,0 +1,44 @@
+import importlib
+import pkgutil
+from pathlib import Path
+
+_extensions: dict[str, type] = {}
+_discovered = False
+
+
+def extension(name: str):
+    """装饰器：注册设备扩展
+
+    @extension("switch")
+    class SwitchExtension:
+        class Params(DeviceParams): ...
+        def execute(self, device, params): ...
+    """
+    def decorator(cls):
+        _extensions[name] = cls
+        return cls
+    return decorator
+
+
+def get_extension(name: str):
+    discover()
+    return _extensions.get(name)
+
+
+def list_extensions() -> list[str]:
+    discover()
+    return list(_extensions.keys())
+
+
+def discover():
+    """动态扫描 extensions/ 目录下所有模块，导入以触发 @extension 注册"""
+    global _discovered
+    if _discovered:
+        return
+    _discovered = True
+
+    ext_dir = Path(__file__).parent
+    for finder, module_name, is_pkg in pkgutil.iter_modules([str(ext_dir)]):
+        if module_name.startswith("_"):
+            continue
+        importlib.import_module(f"{__package__}.{module_name}")

python_library_xiaomi_miot-0.1.0/xiaomi_miot/extensions/switch.py

@@ -0,0 +1,31 @@
+from pydantic import BaseModel, Field
+from xiaomi_miot.device import MiotDevice
+from xiaomi_miot.extensions import extension
+from xiaomi_miot.models import DeviceParams
+
+class SwitchParams(DeviceParams):
+    type: str = "switch"
+    on: bool | None = Field(default=None,description="None=查询状态, True=开, False=关")
+    siid: int = Field(default=2,description="默认 service：Switch")
+    piid: int = Field(default=1,description="默认 property：On")
+
+@extension("switch")
+class SwitchExtension:
+    Params = SwitchParams
+
+    def execute(self, device: MiotDevice, params: SwitchParams) -> dict:
+        if params.on is None:
+            return self._get_state(device, params)
+        return self._set_state(device, params)
+
+    def _get_state(self, device: MiotDevice, params: SwitchParams) -> dict:
+        result = device.get_prop("switch", params.siid, params.piid)
+        if result["ok"]:
+            result["state"] = "开启" if result["value"] else "关闭"
+        return result
+
+    def _set_state(self, device: MiotDevice, params: SwitchParams) -> dict:
+        result = device.set_prop("switch", params.siid, params.piid, params.on)
+        if result["ok"]:
+            result["state"] = "开启" if params.on else "关闭"
+        return result

python_library_xiaomi_miot-0.1.0/xiaomi_miot/models.py

@@ -0,0 +1,22 @@
+from typing import Any
+from pydantic import BaseModel, Field, ConfigDict
+
+
+class DeviceParams(BaseModel):
+    """最基础的设备参数：局域网连接所需"""
+    model_config = ConfigDict(extra="ignore")
+
+    ip: str = Field(description="设备 IP 地址")
+    token: str = Field(description="设备 Token")
+    type: str | None = Field(default=None,description="设备类型")
+
+class GetParams(DeviceParams):
+    """通用属性读取"""
+    did: str = Field(default="prop",description="默认 did：prop")
+    siid: int = Field(description="service ID")
+    piid: int = Field(description="property ID")
+
+
+class SetParams(GetParams):
+    """通用属性设置"""
+    value: Any = Field(description="属性值")