pyvesync 3.0.0__py3-none-any.whl

pyvesync/models/home_models.py

@@ -0,0 +1,169 @@
+"""Home and Rooms request and response models.
+
+WORK IN PROGRESS - NOT IMPLEMENTED YET
+
+Dataclasses should follow the naming convention of Request/Response + <API Name> + Model.
+Internal models should be named starting with IntResp/IntReq<API Name>Model.
+
+Attributes:
+    ResponseLoginResultModel: Model for the 'result' field in login response.
+    ResponseLoginModel: Model for the login response.
+    RequestLoginModel: Model for the login request.
+
+Notes:
+    All models should inherit `ResponseBaseModel` or `RequestBaseModel`. Use
+    `pyvesync.models.base_models.DefaultValues` to set default values.
+
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from pyvesync.models.base_models import (
+    DefaultValues,
+    RequestBaseModel,
+    ResponseCodeModel,
+)
+
+
+@dataclass
+class RequestHomeModel(RequestBaseModel):
+    """Request model for home data.
+
+    Inherits from `RequestVeSyncInstanceMixin` to populate fields from the
+    VeSync instance. The `VeSync` instance is passed as a
+    keyword argument `RequestHomeModel(manager=instance)`.
+    """
+
+    # Arguments set by Manager Instance by passing kw_argument manager
+    # these fields should be set to init=False
+    accountID: str
+    token: str
+    userCountryCode: str
+    # Non-default constants
+    method: str = 'getHomeList'
+    # default values
+    acceptLanguage: str = DefaultValues.acceptLanguage
+    appVersion: str = DefaultValues.appVersion
+    timeZone: str = DefaultValues.timeZone
+    phoneBrand: str = DefaultValues.phoneBrand
+    phoneOS: str = DefaultValues.phoneOS
+    traceId: str = field(default_factory=DefaultValues.traceId)
+    debugMode: bool = DefaultValues.debugMode
+
+
+@dataclass
+class ResponseHomeModel(ResponseCodeModel):
+    """Model for the home data response.
+
+    Inherits from `ResponseCodeModel`. The `ResponseCodeModel` class provides the
+    `code` and `msg` fields. The `ResponseHomeModel` class provides the `result`
+    field containing the home data.
+
+    Attributes:
+        result: dict: The home data.
+    """
+
+    result: IntResponseHomeResultModel | IntResponseHomeInfoResultModel | None
+
+
+@dataclass
+class RequestHomeInfoModel(RequestBaseModel):
+    """Request model for home room information.
+
+    Inherits from `RequestVeSyncInstanceMixin` to populate fields from the
+    VeSync instance. The `VeSync` instance is passed as a
+    keyword argument `RequestHomeModel(manager=instance)`.
+    """
+
+    # argument to pass in as positional or keyword argument homeId
+    homeId: str
+    # Arguments set by Manager Instance by passing kw_argument manager
+    # these fields should be set to init=False
+    accountID: str = field(init=False)
+    token: str = field(init=False)
+    userCountryCode: str = field(init=False)
+    # Non-default constants
+    method: str = 'getHomeDetail'
+    # default values
+    acceptLanguage: str = DefaultValues.acceptLanguage
+    appVersion: str = DefaultValues.appVersion
+    timeZone: str = DefaultValues.timeZone
+    phoneBrand: str = DefaultValues.phoneBrand
+    phoneOS: str = DefaultValues.phoneOS
+    traceId: str = field(default_factory=DefaultValues.traceId)
+    debugMode: bool = DefaultValues.debugMode
+
+
+@dataclass
+class ResponseHomeInfoModel(ResponseCodeModel):
+    """Model for the home room information response.
+
+    Inherits from `ResponseCodeModel`. The `ResponseCodeModel` class provides the
+    `traceId`, `code`, and `msg` fields. The `ResponseHomeInfoModel` class provides
+    the `result` field containing the home room data.
+
+    Attributes:
+        result: dict: The home room data.
+    """
+
+    result: IntResponseHomeInfoResultModel
+
+
+@dataclass
+class IntResponseHomeInfoResultModel:
+    """Internal model for the 'result' field in home room response."""
+
+    roomInfoList: list[IntResponseHomeListModel]
+
+
+@dataclass
+class IntResponseRoomListModel:
+    """Internal model for the 'roomList' field in home response."""
+
+    roomID: str
+    roomName: str
+    deviceList: list[IntResponseRoomDeviceListModel]
+    plantComformHumidityRangeLower: int | None = None
+    plantComformHumidityRangeHigher: int | None = None
+    # group_list = []  # TODO: Create group model  # noqa: ERA001
+
+
+@dataclass
+class IntResponseRoomDeviceListModel:
+    """Internal model for the device list in room response."""
+
+    logicalDeviceType: int
+    virDeviceType: int
+    cid: str
+    uuid: str
+    subDeviceNo: int
+    deviceName: str
+    configModule: str
+    deviceRegion: str
+    deviceType: str
+    type: str
+    connectionType: str
+    currentFirmwareVersion: str
+    deviceStatus: str
+    connectionStatus: str
+    mode: str | None = None
+    subDeviceType: str | None = None
+    macid: str | None = None
+
+
+@dataclass
+class IntResponseHomeResultModel:
+    """Internal model for the 'result' field in home response."""
+
+    homeList: list[IntResponseHomeListModel]
+
+
+@dataclass
+class IntResponseHomeListModel:
+    """Internal model for the 'homeList' field in home response result."""
+
+    homeId: int
+    homeName: str
+    nickname: str | None = None

pyvesync/models/humidifier_models.py

@@ -0,0 +1,202 @@
+"""Data models for VeSync Humidifier devices.
+
+These models inherit from `ResponseBaseModel` and `RequestBaseModel` from the
+`base_models` module.
+
+The `InnerHumidifierBaseResult` class is used as a base class for the inner humidifier
+result models. The correct subclass is determined by the mashumaro discriminator.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Annotated
+
+from mashumaro.config import BaseConfig
+from mashumaro.types import Alias
+
+from pyvesync.models.base_models import (
+    ResponseBaseModel,
+    ResponseCodeModel,
+)
+
+
+@dataclass
+class ResponseHumidifierBase(ResponseCodeModel):
+    """Humidifier Base Response Dict."""
+
+    result: OuterHumidifierResult
+
+
+@dataclass
+class OuterHumidifierResult(ResponseBaseModel):
+    """Humidifier Result Dict."""
+
+    code: int
+    result: InnerHumidifierBaseResult
+
+
+@dataclass
+class InnerHumidifierBaseResult(ResponseBaseModel):
+    """Base class for inner humidifier results model.
+
+    All inner results models inherit from this class and are
+    correctly subclassed by the mashumaro discriminator.
+    """
+
+    class Config(BaseConfig):  # type: ignore[override]
+        """Configure the results model to use subclass discriminator."""
+
+        allow_deserialization_not_by_alias = True
+
+
+class BypassV2InnerErrorResult(InnerHumidifierBaseResult):
+    """Inner Error Result Model."""
+
+    msg: str
+
+
+# Inner Result models for individual devices inherit from InnerHumidifierBaseResult
+# and are used to parse the response from the API.
+# The correct subclass is determined by the mashumaro discriminator
+
+
+@dataclass
+class ClassicLVHumidResult(InnerHumidifierBaseResult):
+    """Classic 200S Humidifier Result Model.
+
+    Inherits from InnerHumidifierBaseResult.
+    """
+
+    enabled: bool
+    mist_virtual_level: int
+    mist_level: int
+    mode: str
+    display: Annotated[bool, Alias('indicator_light_status')]
+    water_lacks: bool
+    humidity: int | None = None
+    humidity_high: bool = False
+    automatic_stop_reach_target: bool = False
+    water_tank_lifted: bool = False
+    warm_enabled: bool = False
+    warm_level: int | None = None
+    night_light_brightness: int | None = None
+    configuration: ClassicConfig | None = None
+
+
+@dataclass
+class ClassicConfig(ResponseBaseModel):
+    """Classic 200S Humidifier Configuration Model."""
+
+    auto_target_humidity: int = 0
+    display: Annotated[bool, Alias('indicator_light_status')] = False
+    automatic_stop: bool = False
+
+    class Config(BaseConfig):  # type: ignore[override]
+        """Configure the results model to use subclass discriminator."""
+
+        allow_deserialization_not_by_alias = True
+        forbid_extra_keys = False
+
+
+@dataclass
+class LV600SConfig(ResponseBaseModel):
+    """LV 600S Humidifier Configuration Model."""
+
+    auto_target_humidity: int = 0
+    display: bool = False
+
+
+@dataclass
+class LV600SExtension(ResponseBaseModel):
+    """LV 600S Humidifier Configuration Model."""
+
+    timer_remain: int = 0
+    schedule_count: int = 0
+
+
+@dataclass
+class LV600SHumidResult(InnerHumidifierBaseResult):
+    """LV600S Humidifier Result Model.
+
+    Inherits from InnerHumidifierBaseResult.
+    """
+
+    automatic_stop_reach_target: bool
+    display: bool
+    enabled: bool
+    humidity: int
+    humidity_high: bool
+    mist_level: int
+    mist_virtual_level: int
+    mode: str
+    water_lacks: bool
+    water_tank_lifted: bool
+    extension: LV600SExtension | None = None
+    configuration: LV600SConfig | None = None
+
+
+# Models for the VeSync Superior 6000S Humidifier
+
+
+@dataclass
+class Superior6000SResult(InnerHumidifierBaseResult):
+    """Superior 6000S Humidifier Result Model.
+
+    Inherits from InnerHumidifierBaseResult.
+    """
+
+    powerSwitch: int
+    humidity: int
+    targetHumidity: int
+    virtualLevel: int
+    mistLevel: int
+    workMode: str
+    waterLacksState: int
+    waterTankLifted: int
+    autoStopSwitch: int
+    autoStopState: int
+    screenSwitch: int
+    screenState: int
+    scheduleCount: int
+    timerRemain: int
+    errorCode: int
+    autoPreference: int
+    childLockSwitch: int
+    filterLifePercent: int
+    temperature: int
+    dryingMode: Superior6000SDryingMode | None = None
+
+
+@dataclass
+class Superior6000SDryingMode(ResponseBaseModel):
+    """Drying Mode Model for Superior 6000S Humidifier."""
+
+    dryingLevel: int
+    autoDryingSwitch: int
+    dryingState: int
+    dryingRemain: int
+
+
+# Models for the Levoit 1000S Humidifier
+
+
+@dataclass
+class Levoit1000SResult(InnerHumidifierBaseResult):
+    """Levoit 1000S Humidifier Result Model."""
+
+    powerSwitch: int
+    humidity: int
+    targetHumidity: int
+    virtualLevel: int
+    mistLevel: int
+    workMode: str
+    waterLacksState: int
+    waterTankLifted: int
+    autoStopSwitch: int
+    autoStopState: int
+    screenSwitch: int
+    screenState: int
+    scheduleCount: int
+    timerRemain: int
+    errorCode: int

pyvesync/models/outlet_models.py

@@ -0,0 +1,220 @@
+"""Data models for VeSync outlets."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.models.base_models import (
+    RequestBaseModel,
+    ResponseBaseModel,
+    ResponseCodeModel,
+)
+from pyvesync.models.bypass_models import (
+    RequestBypassV1,
+)
+
+
+@dataclass
+class Response7AOutlet(ResponseBaseModel):
+    """Response model for 7A outlet."""
+
+    activeTime: int
+    energy: float
+    deviceStatus: str
+    power: float | str
+    voltage: float | str
+
+
+@dataclass
+class ResponseEnergyHistory(ResponseCodeModel):
+    """Response model for energy history."""
+
+    result: ResponseEnergyResult
+
+
+@dataclass
+class ResponseEnergyResult(ResponseBaseModel):
+    """Response model for energy result."""
+
+    energyConsumptionOfToday: float
+    costPerKWH: float
+    maxEnergy: float
+    totalEnergy: float
+    energyInfos: list[EnergyInfo]
+
+
+@dataclass
+class EnergyInfo:
+    """Energy Info list items."""
+
+    timestamp: int
+    energyKWH: float
+    money: float
+
+
+@dataclass
+class Response10ADetails(DataClassORJSONMixin):
+    """Response model for Etekcity outlet details."""
+
+    code: int
+    msg: str | None
+    deviceStatus: str
+    connectionStatus: str
+    activeTime: int
+    power: float
+    voltage: float
+    energy: float | None = None
+    nightLightStatus: str | None = None
+    nightLightAutoMode: str | None = None
+    nightLightBrightness: int | None = None
+
+
+@dataclass
+class ResponseOldEnergy(ResponseCodeModel):
+    """Response model for old energy history."""
+
+    energyConsumptionOfToday: float
+    costPerKWH: float
+    maxEnergy: float
+    totalEnergy: float
+    data: list[float]
+
+
+@dataclass
+class Response15ADetails(ResponseCodeModel):
+    """Response for 15A Outlets."""
+
+    result: Response15AOutletResult
+
+
+@dataclass
+class Response15AOutletResult(ResponseBaseModel):
+    """Response model for 15A outlet."""
+
+    deviceStatus: str
+    connectionStatus: str
+    activeTime: int
+    power: float
+    voltage: float
+    energy: float | None = None
+    nightLightStatus: str | None = None
+    nightLightAutoMode: str | None = None
+    nightLightBrightness: int | None = None
+
+
+@dataclass
+class Request15ADetails(RequestBypassV1):
+    """Request data model for 15A outlet Details."""
+
+
+@dataclass
+class RequestOutdoorStatus(RequestBypassV1):
+    """Request model for outlet status."""
+
+    status: str
+    switchNo: str
+
+
+@dataclass
+class RequestEnergyHistory(RequestBaseModel):
+    """Request model for energy history."""
+
+    acceptLanguage: str
+    appVersion: str
+    accountID: str
+    method: str
+    phoneBrand: str
+    phoneOS: str
+    timeZone: str
+    token: str
+    traceId: str
+    userCountryCode: str
+    debugMode: bool
+    homeTimeZone: str
+    uuid: str
+
+
+@dataclass
+class Request15AStatus(RequestBypassV1):
+    """Request data model for 15A outlet.
+
+    Inherits from RequestBypassV1.
+    """
+
+    status: str
+
+
+@dataclass
+class Request15ANightlight(RequestBypassV1):
+    """Nightlight request data model for 15A Outlets.
+
+    Inherits from RequestBypassV1.
+    """
+
+    mode: str
+
+
+@dataclass
+class ResponseOutdoorDetails(ResponseCodeModel):
+    """Response model for outdoor outlet."""
+
+    result: ResponseOutdoorOutletResult
+
+
+@dataclass
+class ResponseOutdoorOutletResult(ResponseBaseModel):
+    """Response model for outdoor outlet."""
+
+    deviceStatus: str
+    connectionStatus: str
+    activeTime: int
+    power: float
+    voltage: float
+    energy: float
+    subDevices: list[ResponseOutdoorSubDevices]
+
+
+@dataclass
+class ResponseOutdoorSubDevices(ResponseBaseModel):
+    """Response model for outdoor energy."""
+
+    subDeviceNo: int
+    defaultName: str
+    subDeviceName: str
+    subDeviceStatus: str
+
+
+@dataclass
+class ResponseBSDGO1Details(ResponseCodeModel):
+    """Response model for BSDGO1 outlet."""
+
+    result: ResponseBSDGO1OutletResult
+
+
+@dataclass
+class ResponseBSDGO1OutletResult(ResponseBaseModel):
+    """Response model for BSDGO1 outlet."""
+
+    powerSwitch_1: int
+    active_time: int
+    connectionStatus: str
+    code: int
+
+
+@dataclass
+class Timer7AItem(ResponseBaseModel):
+    """Timer item for 7A outlet."""
+
+    timerID: str
+    counterTimer: int
+    action: str
+    timerStatus: str
+
+
+@dataclass
+class ResultESW10Details(ResponseBaseModel):
+    """Response model for ESW10 outlet."""
+
+    enabled: bool