pyvesync 3.3.3__tar.gz → 3.4.0__tar.gz

{pyvesync-3.3.3 → pyvesync-3.4.0}/MANIFEST.in

@@ -1,3 +1,4 @@
 include README.md LICENSE requirements.txt
 exclude test
-prune test
+prune test
+include src/pyvesync/py.typed

{pyvesync-3.3.3/src/pyvesync.egg-info → pyvesync-3.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvesync
-Version: 3.3.3
+Version: 3.4.0
 Summary: pyvesync is a library to manage Etekcity Devices, Cosori Air Fryers, and Levoit Air Purifiers run on the VeSync app.
 Author: Mark Perdue
 Author-email: Joe Trabulsy <webdjoe@gmail.com>
@@ -216,9 +216,9 @@ See [Supported Devices](#supported-devices) for a complete list of supported dev
 
 Exceptions are no longer caught by the library and must be handled by the user. Exceptions are raised by server errors and aiohttp connection errors.
 
-Errors that occur at the aiohttp level are raised automatically and propogated to the user. That means exceptions raised by aiohttp that inherit from `aiohttp.ClientError` are propogated.
+Errors that occur at the aiohttp level are raised automatically and propagated to the user. That means exceptions raised by aiohttp that inherit from `aiohttp.ClientError` are propagated.
 
-When the connection to the VeSync API succeeds but returns an error code that prevents the library from functioning a custom exception inherrited from `pyvesync.logs.VeSyncError` is raised.
+When the connection to the VeSync API succeeds but returns an error code that prevents the library from functioning a custom exception inherited from `pyvesync.logs.VeSyncError` is raised.
 
 Custom Exceptions raised by all API calls:
 

{pyvesync-3.3.3 → pyvesync-3.4.0}/README.md

@@ -168,9 +168,9 @@ See [Supported Devices](#supported-devices) for a complete list of supported dev
 
 Exceptions are no longer caught by the library and must be handled by the user. Exceptions are raised by server errors and aiohttp connection errors.
 
-Errors that occur at the aiohttp level are raised automatically and propogated to the user. That means exceptions raised by aiohttp that inherit from `aiohttp.ClientError` are propogated.
+Errors that occur at the aiohttp level are raised automatically and propagated to the user. That means exceptions raised by aiohttp that inherit from `aiohttp.ClientError` are propagated.
 
-When the connection to the VeSync API succeeds but returns an error code that prevents the library from functioning a custom exception inherrited from `pyvesync.logs.VeSyncError` is raised.
+When the connection to the VeSync API succeeds but returns an error code that prevents the library from functioning a custom exception inherited from `pyvesync.logs.VeSyncError` is raised.
 
 Custom Exceptions raised by all API calls:
 

{pyvesync-3.3.3 → pyvesync-3.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvesync"
-version = "3.3.3"
+version = "3.4.0"
 description = "pyvesync is a library to manage Etekcity Devices, Cosori Air Fryers, and Levoit Air Purifiers run on the VeSync app."
 readme = "README.md"
 requires-python = ">=3.11"
@@ -64,6 +64,9 @@ docs = [
 where = ["src"]
 exclude = ["tests", "test*"]
 
+[tool.setuptools.package-data]
+pyvesync = ["py.typed"]
+
 [tool.pytest.ini_options]
 addopts = "--tb=short --color=yes"
 testpaths = ["src/tests"]

{pyvesync-3.3.3 → pyvesync-3.4.0}/src/pyvesync/base_devices/fan_base.py

@@ -87,7 +87,7 @@ class FanState(DeviceState):
             feature_map (FanMap): Feature map.
         """
         super().__init__(device, details, feature_map)
-        self.mode: str = FanModes.UNKNOWN
+        self.mode: str | None = None
         self.fan_level: int | None = None
         self.fan_set_level: int | None = None
         self.child_lock: str | None = None
@@ -145,6 +145,7 @@ class VeSyncFanBase(VeSyncBaseToggleDevice):
     """
 
     __slots__ = (
+        '_reverse_modes',
         'fan_levels',
         'modes',
         'sleep_preferences',
@@ -169,7 +170,10 @@ class VeSyncFanBase(VeSyncBaseToggleDevice):
         super().__init__(details, manager, feature_map)
         self.features: list[str] = feature_map.features
         self.state: FanState = FanState(self, details, feature_map)
-        self.modes: list[str] = feature_map.modes
+        self.modes: dict[str, str] = feature_map.modes
+        self._reverse_modes: dict[str, str] = {}
+        for k, v in self.modes.items():
+            self._reverse_modes[v] = k
         self.fan_levels: list[int] = feature_map.fan_levels
         self.sleep_preferences: list[str] = feature_map.sleep_preferences
 
@@ -278,9 +282,9 @@ class VeSyncFanBase(VeSyncBaseToggleDevice):
             This method is not supported by all devices, will return
             false with warning debug message if not supported.
         """
-        if FanModes.ADVANCED_SLEEP in self.modes:
-            return await self.set_mode(FanModes.ADVANCED_SLEEP)
-        logger.warning('Advanced Sleep mode not supported for this device.')
+        if FanModes.SLEEP in self.modes:
+            return await self.set_mode(FanModes.SLEEP)
+        logger.warning('Sleep mode not supported for this device.')
         return False
 
     async def set_sleep_mode(self) -> bool:
@@ -295,8 +299,8 @@ class VeSyncFanBase(VeSyncBaseToggleDevice):
             This method is not supported by all devices, will return
             false with warning debug message if not supported.
         """
-        if FanModes.ADVANCED_SLEEP in self.modes:
-            return await self.set_mode(FanModes.ADVANCED_SLEEP)
+        if FanModes.SLEEP in self.modes:
+            return await self.set_mode(FanModes.SLEEP)
         logger.warning('Sleep mode not supported for this device.')
         return False
 
@@ -510,7 +514,7 @@ class VeSyncFanBase(VeSyncBaseToggleDevice):
     @deprecated('Use `set_advanced_sleep_mode` method instead')
     async def advanced_sleep_mode(self) -> bool:
         """Set advanced sleep mode."""
-        return await self.set_mode('advancedSleep')
+        return await self.set_mode(FanModes.SLEEP)
 
     @deprecated('Use `set_sleep_mode` method instead')
     async def sleep_mode(self) -> bool:

{pyvesync-3.3.3 → pyvesync-3.4.0}/src/pyvesync/base_devices/humidifier_base.py

@@ -4,14 +4,17 @@ from __future__ import annotations
 
 import logging
 from abc import abstractmethod
+from dataclasses import dataclass
 from typing import TYPE_CHECKING
 
 from pyvesync.base_devices.vesyncbasedevice import DeviceState, VeSyncBaseToggleDevice
-from pyvesync.const import DeviceStatus, HumidifierFeatures, HumidifierModes
+from pyvesync.const import DeviceStatus, DryingModes, HumidifierFeatures, HumidifierModes
+from pyvesync.models.bypass_models import ResponseBaseModel
 
 if TYPE_CHECKING:
     from pyvesync import VeSync
     from pyvesync.device_map import HumidifierMap
+    from pyvesync.models.humidifier_models import SproutBreathinglamp
     from pyvesync.models.vesync_models import ResponseDeviceDetailsModel
 
 
@@ -55,6 +58,7 @@ class HumidifierState(DeviceState):
         'auto_stop_target_reached',
         'auto_target_humidity',
         'automatic_stop_config',
+        'breathing_lamp',
         'child_lock',
         'display_set_status',
         'display_status',
@@ -63,17 +67,20 @@ class HumidifierState(DeviceState):
         'drying_mode_status',
         'drying_mode_time_remain',
         'filter_life',
+        'hepa_filter_life',
         'humidity',
         'humidity_high',
         'mist_level',
         'mist_virtual_level',
         'mode',
         'nightlight_brightness',
+        'nightlight_color_temp',
         'nightlight_status',
         'temperature',
         'warm_mist_enabled',
         'warm_mist_level',
         'water_lacks',
+        'water_lacks_drying_switch',
         'water_tank_lifted',
     )
 
@@ -105,19 +112,23 @@ class HumidifierState(DeviceState):
         self.mode: str | None = None
         self.nightlight_brightness: int | None = None
         self.nightlight_status: str | None = None
+        self.nightlight_color_temp: int | None = None
         self.warm_mist_enabled: bool | None = None
         self.warm_mist_level: int | None = None
         self.water_lacks: bool = False
         self.water_tank_lifted: bool = False
         self.child_lock: bool | None = None
         self.temperature: float | None = None  # Fahrenheit
-        # Superior 6000S States
+        # Superior 6000S States / Sprout
         self.auto_preference: int | None = None
         self.filter_life: int | None = None
         self.drying_mode_level: int | None = None
         self.drying_mode_auto_switch: str | None = None
-        self.drying_mode_status: str | None = None
+        self.drying_mode_status: DryingModes | None = None
         self.drying_mode_time_remain: int | None = None
+        self.water_lacks_drying_switch: str | None = None
+        self.hepa_filter_life: int | None = None
+        self.breathing_lamp: BreathingLampState | None = None
 
     @property
     def automatic_stop(self) -> bool:
@@ -170,13 +181,24 @@ class HumidifierState(DeviceState):
         return self.drying_mode_time_remain
 
     @property
-    def drying_mode_enabled(self) -> bool:
+    def drying_mode_running(self) -> bool:
         """Return True if drying mode is enabled.
 
         Returns:
             bool | None: True if drying mode is enabled, False otherwise.
         """
-        return self.drying_mode_status == DeviceStatus.ON
+        return self.drying_mode_status == DryingModes.RUNNING
+
+    @property
+    def breathing_lamp_status(self) -> str | None:
+        """Return the breathing lamp status.
+
+        Returns:
+            str | None: Breathing lamp status.
+        """
+        if self.breathing_lamp is not None:
+            return self.breathing_lamp.breathing_lamp_switch
+        return None
 
 
 class VeSyncHumidifier(VeSyncBaseToggleDevice):
@@ -213,6 +235,7 @@ class VeSyncHumidifier(VeSyncBaseToggleDevice):
     """
 
     __slots__ = (
+        '_reverse_mist_modes',
         'mist_levels',
         'mist_modes',
         'target_minmax',
@@ -235,6 +258,9 @@ class VeSyncHumidifier(VeSyncBaseToggleDevice):
         super().__init__(details, manager, feature_map)
         self.state: HumidifierState = HumidifierState(self, details, feature_map)
         self.mist_modes: dict[str, str] = feature_map.mist_modes
+        self._reverse_mist_modes: dict[str, str] = {}
+        for k, v in self.mist_modes.items():
+            self._reverse_mist_modes[v] = k
         self.mist_levels: list[str | int] = feature_map.mist_levels
         self.features: list[str] = feature_map.features
         self.warm_mist_levels: list[int | str] = feature_map.warm_mist_levels
@@ -278,6 +304,9 @@ class VeSyncHumidifier(VeSyncBaseToggleDevice):
             bool: Success of request.
         """
         del toggle
+        if HumidifierFeatures.AUTO_STOP in self.features:
+            logger.warning('Automatic stop has not been configured for this device.')
+            return False
         logger.warning('Automatic stop is not supported or configured for this device.')
         return False
 
@@ -480,3 +509,61 @@ class VeSyncHumidifier(VeSyncBaseToggleDevice):
     async def turn_off_drying_mode(self) -> bool:
         """Turn off drying mode."""
         return await self.toggle_drying_mode(False)
+
+    async def toggle_child_lock(self, toggle: bool | None = None) -> bool:
+        """Toggle child lock on/off.
+
+        Args:
+            toggle (bool): True to turn on child lock, False to turn off.
+
+        Returns:
+            bool: Success of request.
+        """
+        del toggle
+        logger.error('Child lock is not supported or configured for this device.')
+        return False
+
+    async def turn_on_child_lock(self) -> bool:
+        """Turn on child lock.
+
+        Returns:
+            bool: Success of request.
+        """
+        return await self.toggle_child_lock(True)
+
+    async def turn_off_child_lock(self) -> bool:
+        """Turn off child lock.
+
+        Returns:
+            bool: Success of request.
+        """
+        return await self.toggle_child_lock(False)
+
+
+@dataclass
+class BreathingLampState(ResponseBaseModel):
+    """Breathing Lamp State Object."""
+
+    breathing_lamp_switch: str
+    color_temperature: int
+    time_interval: int
+    brightness_start: int
+    brightness_end: int
+
+    @classmethod
+    def from_model(cls, model: SproutBreathinglamp) -> BreathingLampState:
+        """Create BreathingLampState from SproutBreathinglamp model.
+
+        Args:
+            model (SproutBreathinglamp): The SproutBreathinglamp model.
+
+        Returns:
+            BreathingLampState: The created BreathingLampState object.
+        """
+        return cls(
+            breathing_lamp_switch=DeviceStatus.from_int(model.breathingLampSwitch),
+            color_temperature=model.colorTemperature,
+            time_interval=model.timeInterval,
+            brightness_start=model.brightnessStart,
+            brightness_end=model.brightnessEnd,
+        )

{pyvesync-3.3.3 → pyvesync-3.4.0}/src/pyvesync/base_devices/outlet_base.py

@@ -12,7 +12,6 @@ from pyvesync.const import (
     NightlightModes,
     OutletFeatures,
 )
-from pyvesync.models.base_models import DefaultValues
 from pyvesync.models.outlet_models import RequestEnergyHistory, ResponseEnergyHistory
 from pyvesync.utils.helpers import Helpers
 
@@ -192,7 +191,7 @@ class VeSyncOutlet(VeSyncBaseToggleDevice):
 
     def _build_energy_request(self, method: str) -> RequestEnergyHistory:
         """Build energy request post."""
-        request_keys = [
+        request_keys = (
             'acceptLanguage',
             'accountID',
             'appVersion',
@@ -205,10 +204,11 @@ class VeSyncOutlet(VeSyncBaseToggleDevice):
             'debugMode',
             'homeTimeZone',
             'uuid',
-        ]
-        body = Helpers.get_class_attributes(DefaultValues, request_keys)
-        body.update(Helpers.get_class_attributes(self.manager, request_keys))
-        body.update(Helpers.get_class_attributes(self, request_keys))
+        )
+
+        body = Helpers.get_defaultvalues_attributes(request_keys)
+        body.update(Helpers.get_manager_attributes(self.manager, request_keys))
+        body.update(Helpers.get_device_attributes(self, request_keys))
         body['method'] = method
         return RequestEnergyHistory.from_dict(body)
 

{pyvesync-3.3.3 → pyvesync-3.4.0}/src/pyvesync/const.py

@@ -673,12 +673,11 @@ class FanModes(StrEnum):
     AUTO = 'auto'
     NORMAL = 'normal'
     MANUAL = 'normal'
-    SLEEP = 'advancedSleep'
+    SLEEP = 'sleep'
     TURBO = 'turbo'
     PET = 'pet'
     ECO = 'eco'
     UNKNOWN = 'unknown'
-    ADVANCED_SLEEP = 'advancedSleep'
 
 
 # Air Fryer Constants
@@ -887,6 +886,31 @@ class DryingModes(StrEnum):
     RUNNING = 'on'
     PAUSE = 'pause'
 
+    @classmethod
+    def from_int(cls, value: int) -> DryingModes | None:
+        """Convert integer value to corresponding string.
+
+        If value is 1, return ON and if 0, return OFF.
+        If value is -999, return NOT_SUPPORTED.
+        """
+        if value == 0:
+            return cls.DONE
+        if value == 1:
+            return cls.RUNNING
+        if value == 2:  # noqa: PLR2004
+            return cls.PAUSE
+        return None
+
+    def __int__(self) -> int:
+        """Return integer representation of the enum."""
+        match self:
+            case DryingModes.DONE:
+                return 0
+            case DryingModes.RUNNING:
+                return 1
+            case DryingModes.PAUSE:
+                return 2
+
 
 DRYING_MODES: dict[str, int] = {
     DryingModes.DONE: 0,

{pyvesync-3.3.3 → pyvesync-3.4.0}/src/pyvesync/device_container.py

@@ -17,22 +17,22 @@ from __future__ import annotations
 import logging
 import re
 from collections.abc import Iterator, MutableSet, Sequence
-from typing import TYPE_CHECKING, TypeVar
-
-from pyvesync.base_devices.bulb_base import VeSyncBulb
-from pyvesync.base_devices.fan_base import VeSyncFanBase
-from pyvesync.base_devices.fryer_base import VeSyncFryer
-from pyvesync.base_devices.humidifier_base import VeSyncHumidifier
-from pyvesync.base_devices.outlet_base import VeSyncOutlet
-from pyvesync.base_devices.purifier_base import VeSyncPurifier
-from pyvesync.base_devices.switch_base import VeSyncSwitch
-from pyvesync.base_devices.thermostat_base import VeSyncThermostat
+from typing import TYPE_CHECKING, TypeVar, cast
+
 from pyvesync.base_devices.vesyncbasedevice import VeSyncBaseDevice
 from pyvesync.const import ProductTypes
 from pyvesync.device_map import get_device_config
 
 if TYPE_CHECKING:
     from pyvesync import VeSync
+    from pyvesync.base_devices.bulb_base import VeSyncBulb
+    from pyvesync.base_devices.fan_base import VeSyncFanBase
+    from pyvesync.base_devices.fryer_base import VeSyncFryer
+    from pyvesync.base_devices.humidifier_base import VeSyncHumidifier
+    from pyvesync.base_devices.outlet_base import VeSyncOutlet
+    from pyvesync.base_devices.purifier_base import VeSyncPurifier
+    from pyvesync.base_devices.switch_base import VeSyncSwitch
+    from pyvesync.base_devices.thermostat_base import VeSyncThermostat
     from pyvesync.models.vesync_models import (
         ResponseDeviceDetailsModel,
         ResponseDeviceListModel,
@@ -291,82 +291,72 @@ class DeviceContainer(_DeviceContainerBase):
     def outlets(self) -> list[VeSyncOutlet]:
         """Return a list of devices that are outlets."""
         return [
-            device
+            cast('VeSyncOutlet', device)
             for device in self
-            if isinstance(device, VeSyncOutlet)
-            and device.product_type == ProductTypes.OUTLET
+            if device.product_type == ProductTypes.OUTLET
         ]
 
     @property
     def switches(self) -> list[VeSyncSwitch]:
         """Return a list of devices that are switches."""
         return [
-            device
+            cast('VeSyncSwitch', device)
             for device in self
-            if (
-                isinstance(device, VeSyncSwitch)
-                and device.product_type == ProductTypes.SWITCH
-            )
+            if device.product_type == ProductTypes.SWITCH
         ]
 
     @property
     def bulbs(self) -> list[VeSyncBulb]:
         """Return a list of devices that are lights."""
         return [
-            device
+            cast('VeSyncBulb', device)
             for device in self
-            if isinstance(device, VeSyncBulb)
-            and (device.product_type == ProductTypes.BULB)
+            if device.product_type == ProductTypes.BULB
         ]
 
     @property
     def air_purifiers(self) -> list[VeSyncPurifier]:
         """Return a list of devices that are air purifiers."""
         return [
-            device
+            cast('VeSyncPurifier', device)
             for device in self
-            if isinstance(device, VeSyncPurifier)
-            and device.product_type == ProductTypes.PURIFIER
+            if device.product_type == ProductTypes.PURIFIER
         ]
 
     @property
     def fans(self) -> list[VeSyncFanBase]:
         """Return a list of devices that are fans."""
         return [
-            device
+            cast('VeSyncFanBase', device)
             for device in self
-            if isinstance(device, VeSyncFanBase)
-            and device.product_type == ProductTypes.FAN
+            if device.product_type == ProductTypes.FAN
         ]
 
     @property
     def humidifiers(self) -> list[VeSyncHumidifier]:
         """Return a list of devices that are humidifiers."""
         return [
-            device
+            cast('VeSyncHumidifier', device)
             for device in self
-            if isinstance(device, VeSyncHumidifier)
-            and device.product_type == ProductTypes.HUMIDIFIER
+            if device.product_type == ProductTypes.HUMIDIFIER
         ]
 
     @property
     def air_fryers(self) -> list[VeSyncFryer]:
         """Return a list of devices that are air fryers."""
         return [
-            device
+            cast('VeSyncFryer', device)
             for device in self
-            if isinstance(device, VeSyncFryer)
-            and device.product_type == ProductTypes.AIR_FRYER
+            if device.product_type == ProductTypes.AIR_FRYER
         ]
 
     @property
     def thermostats(self) -> list[VeSyncThermostat]:
         """Return a list of devices that are thermostats."""
         return [
-            device
+            cast('VeSyncThermostat', device)
             for device in self
-            if isinstance(device, VeSyncThermostat)
-            and device.product_type == ProductTypes.THERMOSTAT
+            if device.product_type == ProductTypes.THERMOSTAT
         ]