pyvesync 3.0.0__py3-none-any.whl

pyvesync/models/purifier_models.py

@@ -0,0 +1,261 @@
+"""Data models for VeSync Purifiers.
+
+These models inherit from `ResponseBaseModel` and `RequestBaseModel` from the
+`base_models` module.
+
+The `InnerPurifierBaseResult` class is used as a base class for the inner purifier
+result models for all models and the mashumaro discriminator determines the correct
+subclass when deserializing.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from mashumaro.config import BaseConfig
+from mashumaro.types import Discriminator
+
+from pyvesync.models.base_models import (
+    RequestBaseModel,
+    ResponseBaseModel,
+)
+from pyvesync.models.bypass_models import (
+    BypassV1Result,
+    BypassV2InnerResult,
+    RequestBypassV1,
+)
+
+
+@dataclass
+class InnerPurifierBaseResult(BypassV2InnerResult):
+    """Base class for inner purifier results model."""
+
+    class Config(BaseConfig):  # type: ignore[override]
+        """Configure the results model to use subclass discriminator."""
+
+        discriminator = Discriminator(include_subtypes=True)
+
+
+@dataclass
+class PurifierVitalDetailsResult(InnerPurifierBaseResult):
+    """Vital 100S/200S and Everest Purifier Result Model."""
+
+    powerSwitch: int
+    filterLifePercent: int
+    workMode: str
+    manualSpeedLevel: int
+    fanSpeedLevel: int
+    AQLevel: int
+    PM25: int
+    screenState: int
+    childLockSwitch: int
+    screenSwitch: int
+    lightDetectionSwitch: int
+    environmentLightState: int
+    scheduleCount: int
+    timerRemain: int
+    efficientModeTimeRemain: int
+    errorCode: int
+    autoPreference: V2AutoPreferences | None = None
+    fanRotateAngle: int | None = None
+    filterOpenState: int | None = None
+    PM1: int | None = None
+    PM10: int | None = None
+    AQPercent: int | None = None
+
+
+@dataclass
+class V2AutoPreferences:
+    """Vital 100S/200S Auto Preferences."""
+
+    autoPreferenceType: str
+    roomSize: int
+
+
+@dataclass
+class PurifierSproutResult(InnerPurifierBaseResult):
+    """Sprout Purifier Result Model."""
+
+    powerSwitch: int
+    workMode: str
+    manualSpeedLevel: int | None
+    fanSpeedLevel: int | None
+    PM1: int | None
+    PM25: int | None
+    PM10: int | None
+    screenState: int
+    childLockSwitch: int
+    screenSwitch: int
+    scheduleCount: int
+    timerRemain: int
+    humidity: int | None
+    AQI: int | None
+    AQLevel: int | None
+    temperature: int | None
+    VOC: int | None
+    CO2: int | None
+    errorCode: int
+    nightlight: PurifierNightlight | None = None
+    autoPreference: V2AutoPreferences | None = None
+
+
+@dataclass
+class PurifierNightlight(ResponseBaseModel):
+    """Purifier Nightlight Response Dict."""
+
+    nightLightSwitch: bool
+    brightness: int
+    colorTemperature: int
+
+
+@dataclass
+class PurifierCoreDetailsResult(InnerPurifierBaseResult):
+    """Purifier inner Result Dict."""
+
+    enabled: bool
+    filter_life: int
+    mode: str
+    level: int
+    device_error_code: int
+    levelNew: int | None = None
+    air_quality: int | None = None
+    display: bool | None = None
+    child_lock: bool | None = None
+    configuration: PurifierCoreDetailsConfig | None = None
+    extension: dict | None = None
+    air_quality_value: int | None = None
+    night_light: str | None = None
+    fan_rotate: str | None = None
+
+
+# Purifier Timer Models
+
+
+@dataclass
+class PurifierModifyTimerResult(InnerPurifierBaseResult):
+    """Purifier inner Add Timer Result Dict."""
+
+    id: int
+
+
+@dataclass
+class PurifierGetTimerResult(InnerPurifierBaseResult):
+    """Purifier inner Timer Result Dict."""
+
+    timers: list[ResponsePurifierTimerItems] | None
+
+
+@dataclass
+class ResponsePurifierTimerItems(ResponseBaseModel):
+    """Purifier Timer Items Response Dict."""
+
+    id: int
+    remain: int
+    total: int
+    action: str
+
+
+@dataclass
+class PurifierV2TimerPayloadData(RequestBaseModel):
+    """Purifier Timer Payload Data Request Dict."""
+
+    enabled: bool
+    startAct: list[PurifierV2TimerActionItems]
+    tmgEvt: PurifierV2EventTiming | None = None
+    type: int = 0
+    subDeviceNo: int = 0
+    repeat: int = 0
+
+
+@dataclass
+class PurifierV2TimerActionItems(RequestBaseModel):
+    """Purifier Timer Action Items Request Dict."""
+
+    type: str
+    act: int
+    num: int = 0
+
+
+@dataclass
+class PurifierV2EventTiming(RequestBaseModel):
+    """Purifier Event Timing Request Dict."""
+
+    clkSec: int
+
+
+# Internal Purifier Details Models
+
+
+@dataclass
+class PurifierCoreDetailsConfig(ResponseBaseModel):
+    """Config dict in Core purifier details response."""
+
+    display: bool
+    display_forever: bool
+    auto_preference: None | PurifierCoreAutoConfig
+
+
+@dataclass
+class PurifierCoreAutoConfig(ResponseBaseModel):
+    """Auto configuration Core dict in purifier details response."""
+
+    type: str
+    room_size: int
+
+
+@dataclass
+class PurifierDetailsExtension(ResponseBaseModel):
+    """Extension dict in purifier details response for Core 200/300/400."""
+
+    schedule_count: int
+    timer_remain: int
+
+
+# LV - PUR131S Purifier Models
+
+
+@dataclass
+class RequestPurifier131(RequestBypassV1):
+    """Purifier 131 Request Dict."""
+
+    status: str | None = None
+
+
+@dataclass
+class RequestPurifier131Mode(RequestBypassV1):
+    """Purifier 131 Request Dict."""
+
+    mode: str
+
+
+@dataclass
+class RequestPurifier131Level(RequestBypassV1):
+    """Purifier 131 Request Dict."""
+
+    level: int
+
+
+@dataclass
+class Purifier131Result(BypassV1Result):
+    """Purifier 131 Details Response Dict."""
+
+    screenStatus: str
+    filterLife: Purifier131Filter
+    activeTime: int
+    levelNew: int
+    level: int | None
+    mode: str
+    airQuality: str
+    deviceName: str
+    childLock: str
+    deviceStatus: str
+    connectionStatus: str
+
+
+@dataclass
+class Purifier131Filter(ResponseBaseModel):
+    """Filter details model for LV PUR131."""
+
+    change: bool
+    useHour: int
+    percent: int

pyvesync/models/switch_models.py

@@ -0,0 +1,101 @@
+"""Data models for VeSync switches.
+
+These models inherit from `ResponseBaseModel` and `RequestBaseModel` from the
+`base_models` module.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+import orjson
+from mashumaro.config import BaseConfig
+
+from pyvesync.models.base_models import ResponseBaseModel, ResponseCodeModel
+from pyvesync.models.bypass_models import RequestBypassV1
+
+
+@dataclass
+class ResponseSwitchDetails(ResponseCodeModel):
+    """Dimmer and Wall Switch Details Response Dict."""
+
+    result: InternalDimmerDetailsResult | InternalSwitchResult | None = None
+
+
+@dataclass
+class InternalSwitchResult(ResponseBaseModel):
+    """Dimmer Status Response Dict."""
+
+    deviceStatus: str
+    connectionStatus: str
+    activeTime: int
+
+
+@dataclass
+class InternalDimmerDetailsResult(ResponseBaseModel):
+    """Dimmer Details Result Dict."""
+
+    devicename: str
+    brightness: int
+    indicatorlightStatus: str
+    rgbStatus: str
+    rgbValue: DimmerRGB
+    deviceStatus: str
+    connectionStatus: str
+    activeTime: int = 0
+    timer: Any | None = None
+    schedule: Any | None = None
+    deviceImg: str | None = None
+
+
+@dataclass
+class DimmerRGB:
+    """Dimmer RGB Color Dict."""
+
+    red: int
+    green: int
+    blue: int
+
+
+@dataclass
+class RequestSwitchBase(RequestBypassV1):
+    """Base Dimmer Request Dict.
+
+    Inherits from RequestBypassV1 to include the common fields for all requests.
+    """
+
+
+@dataclass
+class RequestDimmerBrightness(RequestBypassV1):
+    """Dimmer Status Request Dict."""
+
+    brightness: str
+
+
+@dataclass
+class RequestDimmerDetails(RequestBypassV1):
+    """Dimmer Details Request Dict."""
+
+
+@dataclass
+class RequestSwitchStatus(RequestBypassV1):
+    """Dimmer Details Request Dict."""
+
+    status: str
+    switchNo: int
+
+
+@dataclass
+class RequestDimmerStatus(RequestBypassV1):
+    """Dimmer Status Request Dict."""
+
+    status: str
+    rgbValue: dict | None = None
+
+    class Config(BaseConfig):  # type: ignore[override]
+        """Dimmer Indicator Control Config Dict."""
+
+        omit_none = True
+        omit_default = True
+        orjson_options = orjson.OPT_NON_STR_KEYS

pyvesync/models/thermostat_models.py

@@ -0,0 +1,134 @@
+"""Data models for VeSync thermostats."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from mashumaro import field_options
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.const import ThermostatConst
+from pyvesync.models.bypass_models import BypassV2InnerResult
+
+
+@dataclass
+class ResultThermostatDetails(BypassV2InnerResult):
+    """Result model for thermostat details."""
+
+    supportMode: list[int]
+    workMode: int
+    workStatus: int
+    fanMode: int
+    fanStatus: int
+    tempUnit: str
+    temperature: float
+    humidity: int
+    heatToTemp: int
+    coolToTemp: int
+    lockStatus: bool
+    scheduleOrHold: int
+    holdEndTime: int
+    holdOption: int
+    deadband: int
+    ecoType: int
+    alertStatus: int
+    routines: list[ThermostatSimpleRoutine]
+    routineRunningId: int | None = None
+
+
+@dataclass
+class ThermostatSimpleRoutine(DataClassORJSONMixin):
+    """Thermostat routine model."""
+
+    name: str
+    routineId: int
+
+
+@dataclass
+class ThermostatRoutine(DataClassORJSONMixin):
+    """Model for full thermostat routine."""
+
+    name: str
+    routineId: int
+    type: int
+    heatToTemp: int
+    coolToTemp: int
+    heatFanMode: int
+    coolFanMode: int
+    usuallyMask: int
+    sensorIds: list[str]
+
+
+@dataclass
+class ThermostatMinorDetails(DataClassORJSONMixin):
+    """Model for thermostat minor details."""
+
+    mcu_version: str = field(metadata=field_options(alias='mcuVersion'))
+    hvac_capacity: int = field(metadata=field_options(alias='hvacCapcity'))
+    timestamp: int = field(metadata=field_options(alias='timeStamp'))
+    time_zone: int = field(metadata=field_options(alias='timeZone'))
+    offset_in_sec: int = field(metadata=field_options(alias='offsetInSec'))
+    time_fmt: int = field(metadata=field_options(alias='timeFmt'))
+    date_fmt: int = field(metadata=field_options(alias='dateFmt'))
+    fan_delay_time: int = field(metadata=field_options(alias='fanDelayTime'))
+    fan_circulation_time: int = field(metadata=field_options(alias='fanCirTime'))
+    hvac_protect_time: int = field(metadata=field_options(alias='hvacProtecTime'))
+    hvac_min_on_time: int = field(metadata=field_options(alias='hvacMinOnTime'))
+    aux_min_on_time: int = field(metadata=field_options(alias='auxMinOnTime'))
+    screen_brightness: int = field(metadata=field_options(alias='screenBrightness'))
+    standby_timeout: int = field(metadata=field_options(alias='standbyTimeOut'))
+    aux_low_temperature: int = field(metadata=field_options(alias='auxLowBalanceTemp'))
+    aux_high_temperature: int = field(metadata=field_options(alias='auxHighBalanceTemp'))
+    keytone: bool = field(metadata=field_options(alias='keyTone'))
+    smart_schedule_enabled: bool = field(
+        metadata=field_options(alias='smartScheduleEnabled')
+    )
+    time_to_temp_enabled: bool = field(metadata=field_options(alias='timeToTempEnabled'))
+    early_on_enabled: bool = field(metadata=field_options(alias='earlyOnEnabled'))
+    reminder_list: list[ThermostatReminder] = field(
+        metadata=field_options(alias='reminderList')
+    )
+    alarm_list: list[ThermostatAlarm] = field(metadata=field_options(alias='alarmList'))
+
+
+@dataclass
+class ThermostatReminder(DataClassORJSONMixin):
+    """Model for thermostat reminder."""
+
+    code: int
+    enabled: bool
+    frequency: int
+    code_name: str | None = None
+    last_maintenance_time: int | None = field(
+        default=None, metadata=field_options(alias='lastMaintenTime')
+    )
+
+    @classmethod
+    def __post_deserialize__(  # type: ignore[override]
+        cls, obj: ThermostatReminder
+    ) -> ThermostatReminder:
+        """Post-deserialization processing."""
+        if isinstance(obj.code, int):
+            obj.code_name = ThermostatConst.ReminderCode(obj.code).name
+        return obj
+
+
+@dataclass
+class ThermostatAlarm(DataClassORJSONMixin):
+    """Model for thermostat alarm."""
+
+    code: int
+    enabled: bool
+    code_name: str | None = None
+    aux_runtime_limit: int | None = field(
+        default=None, metadata=field_options(alias='auxRunTimeLimit')
+    )
+
+    @classmethod
+    def __post_deserialize__(  # type: ignore[override]
+        cls, obj: ThermostatAlarm
+    ) -> ThermostatAlarm:
+        """Post-deserialization processing."""
+        if obj.code is not None:
+            obj.code_name = ThermostatConst.AlarmCode(obj.code).name
+        return obj