pyvesync 3.0.0__py3-none-any.whl

pyvesync/models/base_models.py

@@ -0,0 +1,129 @@
+"""Base data models for API requests and response.
+
+These models are used to define the structure of the requests and
+responses from the API. They use Mashumaro for serialization and
+deserialization. The `DataClassConfigMixin` class sets default options
+for `orjson` and `Mashumaro`.
+
+Note:
+    Dataclasses should follow the naming convention of
+    Request/Response + API Name. Internal models can have any descriptive
+    name.
+
+
+All models should inherit `ResponseBaseModel` or `RequestBaseModel`. Use
+[pyvesync.const][pyvesync.const] to set default values and import here.
+
+Attributes are inherited from the [const][pyvesync.const] module for
+default values.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from time import time
+from typing import ClassVar
+
+import orjson
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.const import (
+    APP_ID,
+    APP_VERSION,
+    BYPASS_HEADER_UA,
+    CLIENT_TYPE,
+    DEFAULT_LANGUAGE,
+    DEFAULT_REGION,
+    DEFAULT_TZ,
+    MOBILE_ID,
+    PHONE_BRAND,
+    PHONE_OS,
+    TERMINAL_ID,
+    USER_TYPE,
+)
+
+RequestHeaders = {
+    'User-Agent': BYPASS_HEADER_UA,
+    'Content-Type': 'application/json; charset=UTF-8',
+}
+
+
+class BaseModelConfig(BaseConfig):
+    """Base config for dataclasses."""
+
+    orjson_options = orjson.OPT_NON_STR_KEYS
+
+
+@dataclass
+class RequestBaseModel(DataClassORJSONMixin):
+    """Base request model for API requests.
+
+    Forbids extra keys in the request JSON.
+    """
+
+    class Config(BaseModelConfig):
+        """orjson config for dataclasses."""
+
+        forbid_extra_keys = True
+        orjson_options = orjson.OPT_NON_STR_KEYS
+
+
+@dataclass
+class ResponseBaseModel(DataClassORJSONMixin):
+    """Base response model for API responses.
+
+    Allows extra keys in the response model and
+    non-string keys in the JSON.
+    """
+
+    class Config(BaseConfig):
+        """Config for dataclasses."""
+
+        orjson_options = orjson.OPT_NON_STR_KEYS
+        forbid_extra_keys = False
+
+
+@dataclass
+class DefaultValues:
+    """Default request fields.
+
+    Attributes for the default values of the request fields
+    and static methods for preparing calculated fields.
+    """
+
+    _call_number: ClassVar[int] = 0
+    userType: str = USER_TYPE
+    appVersion: str = APP_VERSION
+    clientType: str = CLIENT_TYPE
+    appId: str = APP_ID
+    phoneBrand: str = PHONE_BRAND
+    phoneOS: str = PHONE_OS
+    mobileId: str = MOBILE_ID
+    deviceRegion: str = DEFAULT_REGION
+    countryCode: str = DEFAULT_REGION
+    userCountryCode: str = DEFAULT_REGION
+    acceptLanguage: str = DEFAULT_LANGUAGE
+    timeZone: str = DEFAULT_TZ
+    terminalId: str = TERMINAL_ID
+    debugMode: bool = False
+
+    @staticmethod
+    def traceId() -> str:
+        """Trace ID CSRF token."""
+        return str(int(time()))
+
+    @staticmethod
+    def newTraceId() -> str:
+        """Generate a new trace ID."""
+        DefaultValues._call_number += 1
+        return f'APP{TERMINAL_ID[-5:-1]}{int(time())}-{DefaultValues._call_number:0>5}'
+
+
+@dataclass
+class ResponseCodeModel(ResponseBaseModel):
+    """Model for the 'result' field in response."""
+
+    traceId: str
+    code: int
+    msg: str | None

pyvesync/models/bulb_models.py

@@ -0,0 +1,197 @@
+"""Models for VeSync Bulb API responses and requests.
+
+These models are used to serialize and deserialize the JSON responses from the
+VeSync API. The models are used in the VeSync API class methods to provide
+type hints and data validation.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+from typing import Self, TypedDict
+
+from mashumaro import field_options
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.models.base_models import ResponseBaseModel, ResponseCodeModel
+from pyvesync.models.bypass_models import BypassV2InnerResult, RequestBypassV1
+
+
+@dataclass
+class JSONCMD(DataClassORJSONMixin):
+    """Tunable Bulb JSON CMD dict."""
+
+    light: None | JSONCMDLight = None
+    getLightStatus: None | str = None
+
+    class Config(BaseConfig):
+        """Configure the JSONCMD model."""
+
+        omit_none = True
+
+
+@dataclass
+class JSONCMDLight(DataClassORJSONMixin):
+    """Light JSON CMD dict."""
+
+    action: str
+    brightness: int | None = None
+    colorTempe: int | None = None
+
+    class Config(BaseConfig):
+        """Configure the JSONCMDLight model."""
+
+        omit_none = True
+
+
+@dataclass
+class RequestESL100Detail(RequestBypassV1):
+    """Request model for Etekcity bulb details."""
+
+
+@dataclass
+class RequestESL100Status(RequestBypassV1):
+    """Request model for Etekcity bulb details."""
+
+    status: str
+
+
+@dataclass
+class RequestESL100Brightness(RequestBypassV1):
+    """Request model for Etekcity bulb details."""
+
+    status: str
+    brightNess: int
+
+
+@dataclass
+class RequestESL100CWBase(RequestBypassV1):
+    """Request model for ESL100CW bulb."""
+
+    jsonCmd: JSONCMD
+
+
+@dataclass
+class ResponseESL100Detail(ResponseCodeModel):
+    """Response model for Etekcity bulb details."""
+
+    traceId: str
+    code: int
+    msg: str | None
+    result: ResponseESL100DetailResult
+
+
+@dataclass
+class ResponseESL100DetailResult(ResponseBaseModel):
+    """ESL100 Dimmable Bulb Device Detail Response."""
+
+    deviceName: str | None
+    name: str | None
+    brightness: int | None = field(metadata=field_options(alias='brightNess'))
+    activeTime: int | None
+    deviceStatus: str = 'off'
+    connectionStatus: str = 'offline'
+
+    @classmethod
+    def __post_deserialize__(  # type: ignore[override]
+        cls, obj: Self
+    ) -> Self:
+        """Set values depending on color or white mode."""
+        if obj.brightness is None:
+            obj.brightness = 0
+        if obj.activeTime is None:
+            obj.activeTime = 0
+        return obj
+
+
+@dataclass
+class ResponseESL100CWDetail(ResponseCodeModel):
+    """Response model for Etekcity bulb details."""
+
+    result: ResponseESL100CWDetailResult
+
+
+@dataclass
+class ResponseESL100CWLight(ResponseBaseModel):
+    """ESL100CW Tunable Bulb Device Detail Response."""
+
+    brightness: int | None
+    action: str = 'on'
+    colorTempe: int = 0
+
+
+@dataclass
+class ResponseESL100CWDetailResult(ResponseBaseModel):
+    """Result model for ESL100CW Tunable bulb details."""
+
+    light: ResponseESL100CWLight
+
+
+@dataclass
+class ResponseESL100MCStatus(ResponseCodeModel):
+    """Response model for Etekcity bulb status."""
+
+    result: ResponseESL100MCOuterResult
+
+
+@dataclass
+class ResponseESL100MCOuterResult:
+    """ESL100MC Multi-Color Bulb Status Response."""
+
+    traceId: str
+    code: int
+    result: ResponseESL100MCResult
+
+
+@dataclass
+class ResponseESL100MCResult(BypassV2InnerResult):
+    """ESL100MC Multi-Color Bulb Status Response."""
+
+    colorMode: str
+    action: str
+    brightness: int = 0
+    red: int = 0
+    green: int = 0
+    blue: int = 0
+
+
+@dataclass
+class ResponseValcenoStatus(ResponseCodeModel):
+    """Response model for Valceno bulb status."""
+
+    result: ResponseValcenoOuterResult
+
+
+@dataclass
+class ResponseValcenoOuterResult(ResponseBaseModel):
+    """Valceno Bulb Status Response."""
+
+    result: ResponseValcenoStatusResult
+    traceId: str = ''
+    code: int = 0
+
+
+@dataclass
+class ResponseValcenoStatusResult(ResponseBaseModel):
+    """Valceno Bulb Status Result."""
+
+    colorMode: str = ''
+    colorTemp: int = 0
+    brightness: int = 0
+    hue: int = 0
+    saturation: int = 0
+    value: int = 0
+    enabled: str = 'off'
+
+
+class ValcenoStatusPayload(TypedDict):
+    """Typed Dict for setting Valceno bulb status."""
+
+    colorMode: str
+    colorTemp: int | str
+    brightness: int | str
+    hue: int | str
+    saturation: int | str
+    value: int | str
+    force: int

pyvesync/models/bypass_models.py

@@ -0,0 +1,289 @@
+"""Request Models for Bypass V2 Endpoints.
+
+API calls to bypassV2 endpoints have similar request structures. These models are used
+to serialize and deserialize the JSON requests for the bypassV2 endpoints.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+import orjson
+from mashumaro import pass_through
+from mashumaro.config import BaseConfig
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.models.base_models import (
+    BaseModelConfig,
+    RequestBaseModel,
+    ResponseBaseModel,
+    ResponseCodeModel,
+)
+
+
+@dataclass
+class RequestBypassV2(RequestBaseModel):
+    """Bypass V2 Status Request Dict.
+
+    This is the bypassV2 request model for API calls
+    that use the `configModel` and `deviceId` fields.
+    """
+
+    acceptLanguage: str
+    accountID: str
+    appVersion: str
+    cid: str
+    configModule: str
+    debugMode: bool
+    method: str
+    phoneBrand: str
+    phoneOS: str
+    traceId: str
+    timeZone: str
+    token: str
+    userCountryCode: str
+    deviceId: str
+    configModel: str
+    payload: BypassV2RequestPayload
+
+
+@dataclass
+class BypassV2RequestPayload(RequestBaseModel):
+    """Generic Bypass V2 Payload Request model."""
+
+    data: dict
+    method: str
+    source: str = 'APP'
+
+
+@dataclass
+class RequestBypassV1(RequestBaseModel):
+    """Bypass V1 Status Request Dict.
+
+    This is the bypassV1 request model for API calls
+    that use the `configModel` and `deviceId` fields.
+    """
+
+    acceptLanguage: str
+    accountID: str
+    appVersion: str
+    cid: str
+    configModule: str
+    debugMode: bool
+    method: str
+    phoneBrand: str
+    phoneOS: str
+    traceId: str
+    timeZone: str
+    token: str
+    userCountryCode: str
+    uuid: str
+    deviceId: str
+    configModel: str
+
+    class Config(BaseConfig):  # type: ignore[override]
+        """Configure omit None value keys."""
+
+        omit_none = True
+        orjson_options = orjson.OPT_NON_STR_KEYS
+        forbid_extra_keys = True
+
+
+@dataclass
+class ResponseBypassV1(ResponseCodeModel):
+    """Bypass V1 Response Dict."""
+
+    result: BypassV1Result | None = field(
+        default=None,
+        metadata={
+            'serialize': pass_through,
+            'deserialize': pass_through,
+        },
+    )
+
+
+@dataclass
+class BypassV1Result(DataClassORJSONMixin):
+    """Bypass V1 Response Dict."""
+
+
+@dataclass
+class ResponseBypassV2(ResponseCodeModel):
+    """Bypass V2 Response Dict.
+
+    This is the bypassV2 response model for API calls
+    that use the `configModel` and `deviceId` fields.
+    """
+
+    result: BypassV2OuterResult | None = None
+
+
+@dataclass
+class BypassV2InnerResult(DataClassORJSONMixin):
+    """Inner Bypass V2 Result Data Model."""
+
+    class Config(BaseModelConfig):
+        """Configure the Outer Result model."""
+
+        allow_deserialization_not_by_alias = True
+
+
+@dataclass
+class BypassV2OuterResult(DataClassORJSONMixin):
+    """Bypass V2 Outer Result Data Model."""
+
+    code: int
+    result: BypassV2InnerResult | None = field(
+        default=None,
+        metadata={
+            'serialize': pass_through,
+            'deserialize': pass_through,
+        },
+    )
+
+    class Config(BaseModelConfig):
+        """Configure the Outer Result model."""
+
+        allow_deserialization_not_by_alias = True
+
+
+@dataclass
+class BypassV2ResultError(DataClassORJSONMixin):
+    """Bypass V2 Result Error Data Model."""
+
+    msg: str
+
+
+@dataclass
+class ResultV2GetTimer(BypassV2InnerResult):
+    """Inner result for Bypass V2 GetTimer method."""
+
+    timers: list[TimerItemV2] | None = None
+
+
+@dataclass
+class ResultV2SetTimer(BypassV2InnerResult):
+    """Result for Bypass V2 SetTimer method."""
+
+    id: int
+
+
+# Bypass V1 Timer Models
+
+
+@dataclass
+class TimeItemV1(ResponseBaseModel):
+    """Data model for Bypass V1 Timers."""
+
+    timerID: str
+    counterTime: str
+    action: str
+    status: str
+    resetTime: str
+    uuid: str
+
+
+@dataclass
+class TimerItemV1(ResponseBaseModel):
+    """Data model for Bypass V1 Timers."""
+
+    timerID: str
+    counterTimer: str
+    action: str
+    status: str
+    resetTime: str
+
+
+@dataclass
+class TimerItemV2(ResponseBaseModel):
+    """Data model for Bypass V2 Timers."""
+
+    id: int
+    remain: int
+    action: str
+    total: int
+
+
+@dataclass
+class ResultV1SetTimer(BypassV1Result):
+    """Result model for setting Bypass V1 API timer."""
+
+    timerID: str
+    conflictTimerIds: list[str] | None = None
+
+
+@dataclass
+class RequestV1ClearTimer(RequestBypassV1):
+    """Request model for clearing Bypass V1 API outlet timer."""
+
+    timerId: str
+    status: str | None = None
+
+
+@dataclass
+class ResultV1GetTimerList(BypassV1Result):
+    """Get timers result for v1 API."""
+
+    timers: list[TimeItemV1] | list[TimerItemV1] | TimerItemV1 | None = None
+
+
+@dataclass
+class RequestV1SetTime(RequestBypassV1):
+    """Request model for setting timer with counterTime."""
+
+    counterTime: str
+    action: str
+    status: str | None = None
+    switchNo: int | None = None
+
+
+@dataclass
+class RequestV1GetTimer(RequestBypassV1):
+    """Request model for getting timers from v1 API."""
+
+    switchNo: str | None = None
+
+
+@dataclass
+class RequestV1SetTimer(RequestBypassV1):
+    """Request model for timer with counterTimer key.
+
+    Attributes:
+        counterTimer (str): The timer value in seconds.
+        action (str): The action to perform (e.g., "on", "off").
+        switchNo (int | None): The switch number for the timer.
+    """
+
+    counterTimer: str
+    action: str
+    switchNo: int | None = None
+
+
+class TimerModels:
+    """Class holding all common timer models.
+
+    Attributes:
+        ResultV2GetTimer (ResultV2GetTimer): Result model for Bypass V2 GetTimer method.
+        ResultV2SetTimer (ResultV2SetTimer): Result model for Bypass V2 SetTimer method.
+        ResultV1SetTimer (ResultV1SetTimer): Result model V1 API for setting timer.
+        ResultV1GetTimer (ResultV1GetTimerList): Get timers result for v1 API.
+        TimeItemV1 (TimeItemV1): Data model for Bypass V1 Timers.
+        TimerItemV1 (TimerItemV1): Data model for Bypass V1 Timers.
+        TimerItemV2 (TimerItemV2): Data model for Bypass V2 Timers.
+        RequestV1ClearTimer (RequestV1ClearTimer): Model for deleting timer.
+        RequestV1SetTimer (RequestV1SetTimer): Model for timer with counterTimer key.
+        RequestV1GetTimer (RequestV1GetTimer): Model for getting timers from v1 API.
+        RequestV1SetTime (RequestV1SetTime): Model for setting timer with counterTime key.
+    """
+
+    ResultV2GetTimer = ResultV2GetTimer
+    ResultV2SetTimer = ResultV2SetTimer
+    ResultV1SetTimer = ResultV1SetTimer
+    ResultV1GetTimer = ResultV1GetTimerList
+    TimeItemV1 = TimeItemV1
+    TimerItemV1 = TimerItemV1
+    TimerItemV2 = TimerItemV2
+    RequestV1ClearTimer = RequestV1ClearTimer
+    RequestV1SetTimer = RequestV1SetTimer
+    RequestV1GetTimer = RequestV1GetTimer
+    RequestV1SetTime = RequestV1SetTime

pyvesync/models/fan_models.py

@@ -0,0 +1,47 @@
+"""Data models for VeSync Fans.
+
+These models inherit from `ResponseBaseModel` and `RequestBaseModel` from the
+`base_models` module.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from mashumaro.mixins.orjson import DataClassORJSONMixin
+
+from pyvesync.models.bypass_models import (
+    BypassV2InnerResult,
+)
+
+
+@dataclass
+class TowerFanResult(BypassV2InnerResult):
+    """Tower Fan Result Model."""
+
+    powerSwitch: int
+    workMode: str
+    manualSpeedLevel: int
+    fanSpeedLevel: int
+    screenState: int
+    screenSwitch: int
+    oscillationSwitch: int
+    oscillationState: int
+    muteSwitch: int
+    muteState: int
+    timerRemain: int
+    temperature: int
+    errorCode: int
+    scheduleCount: int
+    displayingType: int | None = None
+    sleepPreference: FanSleepPreferences | None = None
+
+
+@dataclass
+class FanSleepPreferences(DataClassORJSONMixin):
+    """Fan Sleep Preferences."""
+
+    sleepPreferenceType: str
+    oscillationSwitch: int
+    fallAsleepRemain: int
+    autoChangeFanLevelSwitch: int

pyvesync/models/fryer_models.py

@@ -0,0 +1,34 @@
+"""Data models for VeSync air fryers."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from pyvesync.models.base_models import ResponseBaseModel
+
+
+@dataclass
+class ResultFryerDetails(ResponseBaseModel):
+    """Result model for air fryer details."""
+
+    returnStatus: FryerCookingReturnStatus | FryerBaseReturnStatus | None = None
+
+
+@dataclass
+class FryerCookingReturnStatus(ResponseBaseModel):
+    """Result returnStatus model for air fryer status."""
+
+    currentTemp: int
+    cookSetTemp: int
+    mode: str
+    cookSetTime: int
+    cookLastTime: int
+    cookStatus: str
+    tempUnit: str
+
+
+@dataclass
+class FryerBaseReturnStatus(ResponseBaseModel):
+    """Result returnStatus model for air fryer status."""
+
+    cookStatus: str