pyvesync 3.0.0b4__tar.gz → 3.0.0b6__tar.gz

{pyvesync-3.0.0b4/src/pyvesync.egg-info → pyvesync-3.0.0b6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvesync
-Version: 3.0.0b4
+Version: 3.0.0b6
 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>
@@ -94,11 +94,11 @@ async def main():
         # To print logs to file
         manager.log_to_file("pyvesync.log")
 
-        await manager.login()  # Still returns true
+        await manager.login()
         if not manager.enabled:
             print("Not logged in.")
             return
-        await manager.get_devices() # Instantiates supported devices in device list
+        await manager.get_devices() # Instantiates supported devices in device list, automatically called by login, only needed if you would like updates
         await manager.update() # Updates the state of all devices
 
         # manager.devices is a DeviceContainer object
@@ -218,7 +218,7 @@ The [raise_api_errors()](https://webdjoe.github.io/pyvesync/latest/development/u
 - `VeSyncRateLimitError` - The API's rate limit has been exceeded.
 - `VeSyncAPIStatusCodeError` - The API returned a non-200 status code.
 - `VeSyncTokenError` - The API returned a token error and requires `login()` to be called again.
-- `VeSyncLoginError` - The user name or password is incorrect.
+- `VeSyncLoginError` - The username or password is incorrect.
 
 ## Installation
 
@@ -305,7 +305,7 @@ from pyvesync.logs import VeSyncLoginError
 
 async def main():
     async with VeSync("user", "password") as manager:
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         # Acts as a set of device instances
@@ -376,7 +376,7 @@ async def main():
     async with VeSync("user", "password") as manager:
         manager.debug = True
         manager.redact = True  # True by default
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         outlet = manager.outlets[0]
@@ -436,7 +436,7 @@ DEVICE_NAME = "Device" # Device to test
 async def test_device():
     # Instantiate VeSync class and login
   async with VeSync(USERNAME, PASSWORD, debug=True, redact=True) as manager:
-      login = await manager.login()
+      await manager.login()
 
       # Pull and update devices
       await manager.update()

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/README.md

@@ -63,11 +63,11 @@ async def main():
         # To print logs to file
         manager.log_to_file("pyvesync.log")
 
-        await manager.login()  # Still returns true
+        await manager.login()
         if not manager.enabled:
             print("Not logged in.")
             return
-        await manager.get_devices() # Instantiates supported devices in device list
+        await manager.get_devices() # Instantiates supported devices in device list, automatically called by login, only needed if you would like updates
         await manager.update() # Updates the state of all devices
 
         # manager.devices is a DeviceContainer object
@@ -187,7 +187,7 @@ The [raise_api_errors()](https://webdjoe.github.io/pyvesync/latest/development/u
 - `VeSyncRateLimitError` - The API's rate limit has been exceeded.
 - `VeSyncAPIStatusCodeError` - The API returned a non-200 status code.
 - `VeSyncTokenError` - The API returned a token error and requires `login()` to be called again.
-- `VeSyncLoginError` - The user name or password is incorrect.
+- `VeSyncLoginError` - The username or password is incorrect.
 
 ## Installation
 
@@ -274,7 +274,7 @@ from pyvesync.logs import VeSyncLoginError
 
 async def main():
     async with VeSync("user", "password") as manager:
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         # Acts as a set of device instances
@@ -345,7 +345,7 @@ async def main():
     async with VeSync("user", "password") as manager:
         manager.debug = True
         manager.redact = True  # True by default
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         outlet = manager.outlets[0]
@@ -405,7 +405,7 @@ DEVICE_NAME = "Device" # Device to test
 async def test_device():
     # Instantiate VeSync class and login
   async with VeSync(USERNAME, PASSWORD, debug=True, redact=True) as manager:
-      login = await manager.login()
+      await manager.login()
 
       # Pull and update devices
       await manager.update()
@@ -510,4 +510,4 @@ And to all of those that contributed to the project:
   <img src="https://contrib.rocks/image?repo=webdjoe/pyvesync" />
 </a>
 
-Made with [contrib.rocks](https://contrib.rocks).
+Made with [contrib.rocks](https://contrib.rocks).

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pyvesync"
-version = "3.0.0b4"
+version = "3.0.0b6"
 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"

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/base_devices/fan_base.py

@@ -24,16 +24,16 @@ class FanState(DeviceState):
 
 
     Attributes:
-        display_set_state (str): Display set state.
+        display_set_status (str): Display set status.
         display_status (str): Display status.
         displaying_type (str): Displaying type.
         fan_level (int): Fan level.
         fan_set_level (int): Fan set level.
         humidity (int): Humidity level.
         mode (str): Mode of device.
-        mute_set_state (str): Mute set state.
+        mute_set_status (str): Mute set status.
         mute_status (str): Mute status.
-        oscillation_set_state (str): Oscillation set state.
+        oscillation_set_status (str): Oscillation set status.
         oscillation_status (str): Oscillation status.
         sleep_change_fan_level (str): Sleep change fan level.
         sleep_fallasleep_remain (str): Sleep fall asleep remain.
@@ -45,16 +45,16 @@ class FanState(DeviceState):
     """
 
     __slots__ = (
-        "display_set_state",
+        "display_set_status",
         "display_status",
         "displaying_type",
         "fan_level",
         "fan_set_level",
         "humidity",
         "mode",
-        "mute_set_state",
+        "mute_set_status",
         "mute_status",
-        "oscillation_set_state",
+        "oscillation_set_status",
         "oscillation_status",
         "sleep_change_fan_level",
         "sleep_fallasleep_remain",
@@ -89,11 +89,11 @@ class FanState(DeviceState):
         self.sleep_oscillation_switch: str | None = None
         self.sleep_change_fan_level: str | None = None
         self.mute_status: str | None = None
-        self.mute_set_state: str | None = None
+        self.mute_set_status: str | None = None
         self.oscillation_status: str | None = None
-        self.oscillation_set_state: str | None = None
+        self.oscillation_set_status: str | None = None
         self.display_status: str | None = None
-        self.display_set_state: str | None = None
+        self.display_set_status: str | None = None
         self.displaying_type: str | None = None
 
 

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/base_devices/humidifier_base.py

@@ -32,7 +32,6 @@ class HumidifierState(DeviceState):
         auto_stop_target_reached (bool): Automatic stop target reached.
         auto_target_humidity (int): Target humidity level.
         automatic_stop_config (bool): Automatic stop configuration.
-        child_lock_status (bool): Child lock status.
         display_set_status (str): Display set status.
         display_status (str): Display status.
         drying_mode_auto_switch (str): Drying mode auto switch status.
@@ -59,7 +58,6 @@ class HumidifierState(DeviceState):
         "auto_stop_target_reached",
         "auto_target_humidity",
         "automatic_stop_config",
-        "child_lock_status",
         "display_set_status",
         "display_status",
         "drying_mode_auto_switch",

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/base_devices/purifier_base.py

@@ -43,7 +43,7 @@ class PurifierState(DeviceState):
         air_quality_level (AirQualityLevel): Air quality level of the purifier.
         child_lock (bool): Child lock status of the purifier.
         display_status (str): Display status of the purifier.
-        display_set_state (str): Display set state of the purifier.
+        display_set_status (str): Display set status of the purifier.
         display_forever (bool): Display forever status of the purifier.
         timer (Timer): Timer object for the purifier.
         pm25 (int): PM2.5 value of the purifier.
@@ -66,7 +66,7 @@ class PurifierState(DeviceState):
         "auto_room_size",
         "child_lock",
         "display_forever",
-        "display_set_state",
+        "display_set_status",
         "display_status",
         "fan_level",
         "fan_rotate_angle",
@@ -100,7 +100,7 @@ class PurifierState(DeviceState):
         self.child_lock: bool = False
         self.filter_open_state: bool = False
         self.display_status: str | None = None
-        self.display_set_state: str | None = None
+        self.display_set_status: str | None = None
         self.display_forever: bool = False
         # Attributes not supported by all purifiers
         self.pm25: int | None = None
@@ -177,10 +177,10 @@ class PurifierState(DeviceState):
         return self.display_status
 
     @property
-    @deprecated("Use display_set_state instead.")
+    @deprecated("Use display_set_status instead.")
     def display_switch(self) -> str | None:
         """Return display switch status."""
-        return self.display_set_state
+        return self.display_set_status
 
 
 class VeSyncPurifier(VeSyncBaseToggleDevice):

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/base_devices/vesyncbasedevice.py

@@ -148,9 +148,7 @@ class VeSyncBaseDevice(ABC, Generic[VS_STATE_T]):
 
     def __hash__(self) -> int:
         """Use CID and sub-device number to make device hash."""
-        if isinstance(self.sub_device_no, int) and self.sub_device_no > 0:
-            return hash(self.cid + str(self.sub_device_no))
-        return hash(self.cid)
+        return hash(self.cid + str(self.sub_device_no))
 
     def __str__(self) -> str:
         """Use device info for string representation of class."""

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/const.py

@@ -202,7 +202,7 @@ class DeviceStatus(StrEnum):
         return -1
 
     @classmethod
-    def from_int(cls, value: int) -> str:
+    def from_int(cls, value: int | None) -> str:
         """Convert integer value to corresponding string.
 
         If value is 1, return ON and if 0, return OFF.
@@ -219,7 +219,7 @@ class DeviceStatus(StrEnum):
     @classmethod
     def from_bool(cls, value: bool) -> 'DeviceStatus':
         """Convert boolean value to corresponding string."""
-        return cls.ON if value else cls.OFF
+        return cls.ON if value is True else cls.OFF
 
 
 class ConnectionStatus(StrEnum):

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/device_map.py

@@ -853,9 +853,7 @@ fan_modules: list[FanMap] = [
         class_name="VeSyncTowerFan",
         dev_types=["LTF-F422S-KEU", "LTF-F422S-WUSR", "LTF-F422_WJP", "LTF-F422S-WUS"],
         modes=[
-            FanModes.SLEEP,  # Alias for Advanced sleep mode
             FanModes.NORMAL,
-            FanModes.MANUAL,
             FanModes.TURBO,
             FanModes.AUTO,
             FanModes.ADVANCED_SLEEP,

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/devices/vesyncfan.py

@@ -43,11 +43,11 @@ class VeSyncTowerFan(BypassV2Mixin, VeSyncFanBase):
         self.state.thermal_comfort = res.thermalComfort
 
         self.state.mute_status = DeviceStatus.from_int(res.muteState)
-        self.state.mute_set_state = DeviceStatus.from_int(res.muteSwitch)
+        self.state.mute_set_status = DeviceStatus.from_int(res.muteSwitch)
         self.state.oscillation_status = DeviceStatus.from_int(res.oscillationState)
-        self.state.oscillation_set_state = DeviceStatus.from_int(res.oscillationSwitch)
+        self.state.oscillation_set_status = DeviceStatus.from_int(res.oscillationSwitch)
         self.state.display_status = DeviceStatus.from_int(res.screenState)
-        self.state.display_set_state = DeviceStatus.from_int(res.screenSwitch)
+        self.state.display_set_status = DeviceStatus.from_int(res.screenSwitch)
         self.state.displaying_type = DeviceStatus.from_int(res.displayingType)
 
         if res.timerRemain is not None and res.timerRemain > 0:
@@ -116,7 +116,7 @@ class VeSyncTowerFan(BypassV2Mixin, VeSyncFanBase):
         payload_data = {
             "workMode": mode
         }
-        r_dict = await self.call_bypassv2_api("setTowerFanStatus", payload_data)
+        r_dict = await self.call_bypassv2_api("setTowerFanMode", payload_data)
         r = Helpers.process_dev_response(logger, "set_mode", self, r_dict)
         if r is None:
             return False
@@ -126,6 +126,8 @@ class VeSyncTowerFan(BypassV2Mixin, VeSyncFanBase):
         return True
 
     async def toggle_switch(self, toggle: bool | None = None) -> bool:
+        if toggle is None:
+            toggle = self.state.device_status == DeviceStatus.OFF
         payload_data = {
             'powerSwitch': int(toggle),
             'switchIdx': 0,

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/devices/vesynchumidifier.py

@@ -221,6 +221,7 @@ class VeSyncHumid200300S(BypassV2Mixin, VeSyncHumidifier):
         if r is None:
             return False
         self.state.display_set_status = DeviceStatus.from_bool(toggle)
+        self.state.display_status = DeviceStatus.from_bool(toggle)
         self.state.connection_status = ConnectionStatus.ONLINE
         return True
 

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/devices/vesyncpurifier.py

@@ -12,7 +12,6 @@ from pyvesync.utils.device_mixins import (
     process_bypassv2_result
     )
 from pyvesync.utils.helpers import Helpers, Timer
-# from pyvesync.models.base_models import DefaultValues
 from pyvesync.const import (
     PurifierAutoPreference,
     DeviceStatus,
@@ -124,7 +123,7 @@ class VeSyncAirBypass(BypassV2Mixin, VeSyncPurifier):
         self.state.child_lock = result.child_lock or False
         config = result.configuration
         if config is not None:
-            self.state.display_set_state = DeviceStatus.ON if config.display \
+            self.state.display_set_status = DeviceStatus.ON if config.display \
                 else DeviceStatus.OFF
             self.state.display_forever = config.display_forever
             if config.auto_preference is not None:
@@ -134,8 +133,7 @@ class VeSyncAirBypass(BypassV2Mixin, VeSyncPurifier):
             self.state.pm25 = result.air_quality_value
             self.state.set_air_quality_level(result.air_quality)
         if result.night_light is not None:
-            self.state.nightlight_status = DeviceStatus.ON if result.night_light \
-                else DeviceStatus.OFF
+            self.state.nightlight_status = DeviceStatus(result.night_light)
 
     async def get_details(self) -> None:
         r_dict = await self.call_bypassv2_api('getPurifierStatus')
@@ -251,6 +249,7 @@ class VeSyncAirBypass(BypassV2Mixin, VeSyncPurifier):
             return False
 
         self.state.fan_level = new_speed
+        self.state.fan_set_level = new_speed
         self.state.mode = PurifierModes.MANUAL  # Set mode to manual to set fan speed
         self.state.device_status = DeviceStatus.ON
         self.state.connection_status = ConnectionStatus.ONLINE
@@ -351,7 +350,7 @@ class VeSyncAirBypass(BypassV2Mixin, VeSyncPurifier):
         if r is None:
             return False
         self.state.connection_status = ConnectionStatus.ONLINE
-        self.state.display_set_state = DeviceStatus.from_bool(mode)
+        self.state.display_set_status = DeviceStatus.from_bool(mode)
         return True
 
     async def set_nightlight_mode(self, mode: str) -> bool:
@@ -477,7 +476,7 @@ class VeSyncAirBaseV2(VeSyncAirBypass):
         self.state.light_detection_status = DeviceStatus.from_int(
             details.environmentLightState
             )
-        self.state.display_set_state = DeviceStatus.from_int(details.screenSwitch)
+        self.state.display_set_status = DeviceStatus.from_int(details.screenSwitch)
         self.state.display_status = DeviceStatus.from_int(details.screenState)
         auto_pref = details.autoPreference
         if auto_pref is not None:
@@ -588,7 +587,7 @@ class VeSyncAirBaseV2(VeSyncAirBypass):
         return True
 
     async def toggle_display(self, mode: bool) -> bool:
-        if bool(self.state.display_set_state) == mode:
+        if bool(self.state.display_set_status) == mode:
             _LOGGER.debug('Display is already %s', mode)
             return True
 
@@ -601,7 +600,7 @@ class VeSyncAirBaseV2(VeSyncAirBypass):
         if r is None:
             return False
 
-        self.state.display_set_state = DeviceStatus.from_bool(mode)
+        self.state.display_set_status = DeviceStatus.from_bool(mode)
         self.state.connection_status = ConnectionStatus.ONLINE
         return True
 
@@ -707,6 +706,7 @@ class VeSyncAirBaseV2(VeSyncAirBypass):
             return False
 
         self.state.fan_set_level = new_speed
+        self.state.fan_level = new_speed
         self.state.mode = PurifierModes.MANUAL
         self.state.device_status = DeviceStatus.ON
         self.state.connection_status = ConnectionStatus.ONLINE
@@ -806,7 +806,7 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         self.state.active_time = details.activeTime
         self.state.filter_life = details.filterLife.percent
         self.state.display_status = details.screenStatus
-        self.state.display_set_state = details.screenStatus
+        self.state.display_set_status = details.screenStatus
         self.state.child_lock = bool(DeviceStatus(details.childLock))
         self.state.mode = details.mode
         self.state.fan_level = details.level or 0
@@ -814,15 +814,6 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         self.state.set_air_quality_level(details.airQuality)
 
     async def get_details(self) -> None:
-        # body = self._build_request('deviceDetail')
-        # headers = Helpers.req_header_bypass()
-
-        # r_dict, _ = await self.manager.async_call_api(
-        #     '/cloud/v1/deviceManaged/deviceDetail',
-        #     method='post',
-        #     headers=headers,
-        #     json_object=body.to_dict(),
-        # )
         r_dict = await self.call_bypassv1_api(
             RequestPurifier131, method="deviceDetail", endpoint="deviceDetail"
         )
@@ -837,13 +828,6 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         update_dict = {
             "status": "on" if mode else "off"
         }
-        # body = self._build_request('airPurifierScreenCtl', update_dict=update_dict)
-        # headers = Helpers.req_header_bypass()
-
-        # r_dict, _ = await self.manager.async_call_api(
-        #     '/cloud/v1/deviceManaged/airPurifierScreenCtl', 'post',
-        #     json_object=body.to_dict(), headers=headers
-        # )
         r_dict = await self.call_bypassv1_api(
             RequestPurifier131, method="airPurifierScreenCtl",
             endpoint="airPurifierScreenCtl", update_dict=update_dict
@@ -852,7 +836,7 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         if r is None:
             return False
 
-        self.state.display_set_state = DeviceStatus.from_bool(mode)
+        self.state.display_set_status = DeviceStatus.from_bool(mode)
         self.state.display_status = DeviceStatus.from_bool(mode)
         self.state.connection_status = ConnectionStatus.ONLINE
         return True
@@ -864,12 +848,6 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         update_dict = {
             "status": DeviceStatus.from_bool(toggle).value
         }
-        # body = self._build_request('airPurifierPowerSwitchCtl', update_dict=update_dict)
-        # headers = Helpers.req_header_bypass()
-        # r_dict, _ = await self.manager.async_call_api(
-        #     '/cloud/v1/deviceManaged/airPurifierPowerSwitchCtl', 'post',
-        #     json_object=body.to_dict(), headers=headers
-        # )
         r_dict = await self.call_bypassv1_api(
             RequestPurifier131, method="airPurifierPowerSwitchCtl",
             endpoint="airPurifierPowerSwitchCtl", update_dict=update_dict
@@ -900,13 +878,6 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         update_dict = {
             "level": new_speed
         }
-        # body = self._build_request('airPurifierSpeedCtl', update_dict=update_dict)
-        # headers = Helpers.req_header_bypass()
-
-        # r_dict, _ = await self.manager.async_call_api(
-        #     '/cloud/v1/deviceManaged/airPurifierSpeedCtl', 'post',
-        #     json_object=body, headers=headers
-        # )
         r_dict = await self.call_bypassv1_api(
             RequestPurifier131Level, method="airPurifierSpeedCtl",
             endpoint="airPurifierSpeedCtl", update_dict=update_dict
@@ -935,13 +906,6 @@ class VeSyncAir131(BypassV1Mixin, VeSyncPurifier):
         update_dict = {
             "mode": mode
         }
-        # body = self._build_request('airPurifierModeCtl', update_dict=update_dict)
-        # headers = Helpers.req_header_bypass()
-
-        # r_dict, _ = await self.manager.async_call_api(
-        #     '/cloud/v1/deviceManaged/airPurifierRunModeCtl', 'post',
-        #     json_object=body.to_dict(), headers=headers
-        # )
         r_dict = await self.call_bypassv1_api(
             RequestPurifier131Mode, method="airPurifierRunModeCtl",
             endpoint="airPurifierRunModeCtl", update_dict=update_dict

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/models/fan_models.py

@@ -15,9 +15,8 @@ from pyvesync.models.bypass_models import (
 
 @dataclass
 class TowerFanResult(BypassV2InnerResult):
-    """Vital 100S/200S and Everest Fan Result Model."""
+    """Tower Fan Result Model."""
     powerSwitch: int
-    filterLifePercent: int
     workMode: str
     manualSpeedLevel: int
     fanSpeedLevel: int

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/models/vesync_models.py

@@ -247,7 +247,8 @@ class ResponseDeviceDetailsModel(ResponseBaseModel):
         """Perform device_list pre-deserialization processes.
 
         This performs the following:
-            - Flattens the `deviceProp` field into `deviceStatus`, `connectionStatus` and `macID`
+            - Flattens the `deviceProp` field into `deviceStatus`, `connectionStatus`
+                and `macID`
             - Sets `cid` to `uuid` or `macID` if null
         """
         super().__pre_deserialize__(d)

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/utils/errors.py

@@ -787,7 +787,7 @@ class VeSyncError(Exception):
     """
 
 
-class VesyncLoginError(VeSyncError):
+class VeSyncLoginError(VeSyncError):
     """Exception raised for login authentication errors."""
 
     def __init__(self, msg: str) -> None:
@@ -855,7 +855,7 @@ def raise_api_errors(error_info: ResponseInfo) -> None:
         case ErrorTypes.RATE_LIMIT:
             raise VeSyncRateLimitError
         case ErrorTypes.AUTHENTICATION:
-            raise VesyncLoginError(error_info.message)
+            raise VeSyncLoginError(error_info.message)
         case ErrorTypes.TOKEN_ERROR:
             raise VeSyncTokenError
         case ErrorTypes.SERVER_ERROR:

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6}/src/pyvesync/vesync.py

@@ -39,7 +39,7 @@ from pyvesync.utils.errors import (
     VeSyncAPIStatusCodeError,
     VeSyncError,
     VeSyncServerError,
-    VesyncLoginError,
+    VeSyncLoginError,
     raise_api_errors,
     )
 
@@ -74,7 +74,7 @@ class VeSync:  # pylint: disable=function-redefined
         'username'
     )
 
-    def __init__(self,
+    def __init__(self,  # noqa: PLR0913
                  username: str,
                  password: str,
                  country_code: str = DEFAULT_REGION,
@@ -106,6 +106,8 @@ class VeSync:  # pylint: disable=function-redefined
             time_zone (str): Time zone for device from IANA database, by default
                 DEFAULT_TZ. This is automatically set to the time zone of the
                 VeSync account during login.
+            debug (bool): Enable debug logging, by default False.
+            redact (bool): Enable redaction of sensitive information, by default True.
 
         Attributes:
             session (ClientSession):  Client session for API calls
@@ -310,17 +312,16 @@ class VeSync:  # pylint: disable=function-redefined
 
         Username and password are provided when class is instantiated.
 
-        Returns:
-            True if login successful, False if not.
-
         Raises:
-            VeSyncLoginError: If login fails due to invalid username or password.
+            VeSyncLoginError: If login fails, for example due to invalid username
+                or password.
             VeSyncAPIResponseError: If API response is invalid.
             VeSyncServerError: If server returns an error.
         """
         if not isinstance(self.username, str) or len(self.username) == 0 \
                 or not isinstance(self.password, str) or len(self.password) == 0:
-            raise VesyncLoginError('Username and password must be specified')
+            raise VeSyncLoginError('Username and password must be specified')
+
         request_auth = RequestAuthModel(
             email=self.username,
             method='authByPWDOrOTM',
@@ -332,27 +333,32 @@ class VeSync:  # pylint: disable=function-redefined
         )
         if resp_dict is None:
             raise VeSyncAPIResponseError('Error receiving response to auth request')
-        if resp_dict.get('code') == 0:
-            try:
-                response_model = ResponseLoginModel.from_dict(resp_dict)
-            except Exception as exc:
-                logger.debug('Error parsing auth response: %s', exc)
-                raise VeSyncAPIResponseError(
-                    'Error receiving response to auth request'
-                    ) from exc
-            result = response_model.result
-            if isinstance(result, IntRespAuthResultModel):
-                # If the result is an IntRespAuthResultModel,
-                # we need to log in with the auth code
-                return await self._login_token(auth_code=result.authorizeCode)
-
-        error_info = ErrorCodes.get_error_info(resp_dict.get("code"))
-        resp_message = resp_dict.get('msg')
-        if resp_message is not None:
-            error_info.message = f'{error_info.message} ({resp_message})'
-        raise VeSyncAPIResponseError(
-            f"Error receiving response to auth request - {error_info.message}"
-        )
+
+        if resp_dict.get('code') != 0:
+            error_info = ErrorCodes.get_error_info(resp_dict.get("code"))
+            resp_message = resp_dict.get('msg')
+            if resp_message is not None:
+                error_info.message = f'{error_info.message} ({resp_message})'
+            raise VeSyncAPIResponseError(
+                f"Error receiving response to auth request - {error_info.message}"
+            )
+
+        try:
+            response_model = ResponseLoginModel.from_dict(resp_dict)
+        except Exception as exc:
+            logger.debug('Error parsing auth response: %s', exc)
+            raise VeSyncAPIResponseError(
+                'Error receiving response to auth request'
+            ) from exc
+
+        result = response_model.result
+        if not isinstance(result, IntRespAuthResultModel):
+            raise VeSyncAPIResponseError(
+                "Error receiving response to login request -"
+                " result is not IntRespAuthResultModel"
+            )
+
+        return await self._login_token(auth_code=result.authorizeCode)
 
     async def _login_token(
             self,
@@ -370,11 +376,9 @@ class VeSync:  # pylint: disable=function-redefined
             region_change_token (str): "bizToken" to use when calling this endpoint
                 for a second time with a different region.
 
-        Returns:
-            True if login successful, False if not.
-
         Raises:
-            VeSyncLoginError: If login fails due to invalid username or password.
+            VeSyncLoginError: If login fails, for example due to invalid username
+                or password.
             VeSyncAPIResponseError: If API response is invalid.
             VeSyncServerError: If server returns an error.
         """
@@ -398,35 +402,38 @@ class VeSync:  # pylint: disable=function-redefined
                     "Error receiving response to login request -"
                     "result is not IntRespLoginResultModel"
                 )
-            if response_model.code == 0:
-                result = response_model.result
-                if not isinstance(result, IntRespLoginResultModel):
-                    raise VeSyncAPIResponseError(
-                        "Error receiving response to login request -"
-                        " result is not IntRespLoginResultModel"
-                    )
-                self._token = result.token
-                self._account_id = result.accountID
-                self.country_code = result.countryCode
-                self.enabled = True
-                logger.debug('Login successful')
-                return True
-            error_info = ErrorCodes.get_error_info(resp_dict.get("code"))
-            if error_info.error_type == ErrorTypes.CROSS_REGION:  # "cross region error."
-                result = response_model.result
-                self.country_code = result.countryCode
-                return await self._login_token(region_change_token=result.bizToken)
-            resp_message = resp_dict.get('msg')
-            if resp_message is not None:
-                error_info.message = f'{error_info.message} ({resp_message})'
-            raise VesyncLoginError(
-                f"Error receiving response to login request - {error_info.message}"
-            )
+            if response_model.code != 0:
+                error_info = ErrorCodes.get_error_info(resp_dict.get("code"))
+                if error_info.error_type == ErrorTypes.CROSS_REGION:  # cross region error
+                    result = response_model.result
+                    self.country_code = result.countryCode
+                    await self._login_token(region_change_token=result.bizToken)
+                resp_message = resp_dict.get('msg')
+                if resp_message is not None:
+                    error_info.message = f'{error_info.message} ({resp_message})'
+                raise VeSyncLoginError(
+                    f"Error receiving response to login request - {error_info.message}"
+                )
+
+            result = response_model.result
+            if not isinstance(result, IntRespLoginResultModel):
+                raise VeSyncAPIResponseError(
+                    "Error receiving response to login request -"
+                    " result is not IntRespLoginResultModel"
+                )
+
+            self._token = result.token
+            self._account_id = result.accountID
+            self.country_code = result.countryCode
+            self.enabled = True
+            logger.debug('Login successful')
+
         except (MissingField, UnserializableDataError) as exc:
             logger.debug('Error parsing login response: %s', exc)
             raise VeSyncAPIResponseError(
                 'Error receiving response to login request'
             ) from exc
+        return True
 
     async def update(self) -> None:
         """Fetch updated information about devices and new device list.

{pyvesync-3.0.0b4 → pyvesync-3.0.0b6/src/pyvesync.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyvesync
-Version: 3.0.0b4
+Version: 3.0.0b6
 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>
@@ -94,11 +94,11 @@ async def main():
         # To print logs to file
         manager.log_to_file("pyvesync.log")
 
-        await manager.login()  # Still returns true
+        await manager.login()
         if not manager.enabled:
             print("Not logged in.")
             return
-        await manager.get_devices() # Instantiates supported devices in device list
+        await manager.get_devices() # Instantiates supported devices in device list, automatically called by login, only needed if you would like updates
         await manager.update() # Updates the state of all devices
 
         # manager.devices is a DeviceContainer object
@@ -218,7 +218,7 @@ The [raise_api_errors()](https://webdjoe.github.io/pyvesync/latest/development/u
 - `VeSyncRateLimitError` - The API's rate limit has been exceeded.
 - `VeSyncAPIStatusCodeError` - The API returned a non-200 status code.
 - `VeSyncTokenError` - The API returned a token error and requires `login()` to be called again.
-- `VeSyncLoginError` - The user name or password is incorrect.
+- `VeSyncLoginError` - The username or password is incorrect.
 
 ## Installation
 
@@ -305,7 +305,7 @@ from pyvesync.logs import VeSyncLoginError
 
 async def main():
     async with VeSync("user", "password") as manager:
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         # Acts as a set of device instances
@@ -376,7 +376,7 @@ async def main():
     async with VeSync("user", "password") as manager:
         manager.debug = True
         manager.redact = True  # True by default
-        await manager.login()  # Still returns true
+        await manager.login()
         await manager.update()
 
         outlet = manager.outlets[0]
@@ -436,7 +436,7 @@ DEVICE_NAME = "Device" # Device to test
 async def test_device():
     # Instantiate VeSync class and login
   async with VeSync(USERNAME, PASSWORD, debug=True, redact=True) as manager:
-      login = await manager.login()
+      await manager.login()
 
       # Pull and update devices
       await manager.update()