pyvesync 2.1.13__tar.gz → 2.1.14__tar.gz

{pyvesync-2.1.13/src/pyvesync.egg-info → pyvesync-2.1.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyvesync
-Version: 2.1.13
+Version: 2.1.14
 Summary: pyvesync is a library to manage Etekcity                 Devices, Cosori Air Fryers and Levoit Air                      Purifiers run on the VeSync app.
 Home-page: https://github.com/webdjoe/pyvesync
 Author: Mark Perdue, Joe Trabulsy
@@ -11,7 +11,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Home Automation
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -19,7 +22,7 @@ Requires-Dist: requests>=2.20.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: yaml; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: tox; extra == "dev"
 
 # pyvesync [![build status](https://img.shields.io/pypi/v/pyvesync.svg)](https://pypi.python.org/pypi/pyvesync) [![Build Status](https://dev.azure.com/webdjoe/pyvesync/_apis/build/status/webdjoe.pyvesync?branchName=master)](https://dev.azure.com/webdjoe/pyvesync/_build/latest?definitionId=4&branchName=master) [![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/) <!-- omit in toc -->

{pyvesync-2.1.13 → pyvesync-2.1.14}/setup.py

@@ -10,7 +10,7 @@ with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
 
 setup(
     name='pyvesync',
-    version='2.1.13',
+    version='2.1.14',
     description='pyvesync is a library to manage Etekcity\
                  Devices, Cosori Air Fryers and Levoit Air \
                      Purifiers run on the VeSync app.',
@@ -25,14 +25,17 @@ setup(
         'Intended Audience :: Developers',
         'Intended Audience :: End Users/Desktop',
         'Natural Language :: English',
-        'Programming Language :: Python :: 3.8',
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
+        'Programming Language :: Python :: 3.11',
+        'Topic :: Home Automation',
     ],
     keywords=['iot', 'vesync', 'levoit', 'etekcity', 'cosori', 'valceno'],
     packages=find_packages('src', exclude=['tests', 'test*']),
     package_dir={'': 'src'},
     install_requires=['requests>=2.20.0'],
     extras_require={
-        'dev': ['pytest', 'pytest-cov', 'yaml', 'tox']
+        'dev': ['pytest', 'pytest-cov', 'pyyaml', 'tox']
     },
     python_requires='>=3.9',
 )

{pyvesync-2.1.13 → pyvesync-2.1.14}/src/pyvesync/helpers.py

@@ -273,18 +273,20 @@ class Helpers:
         if cls.shouldredact:
             stringvalue = re.sub(
                 (
-                    r'(?i)'
-                    r'((?<=token": ")|'
-                    r'(?<=password": ")|'
-                    r'(?<=email": ")|'
-                    r'(?<=tk": ")|'
-                    r'(?<=accountId": ")|'
-                    r'(?<=authKey": ")|'
-                    r'(?<=uuid": ")|'
-                    r'(?<=cid": "))'
-                    r'[^"]+'
+                    r"(?i)"
+                    r'((?<=token":\s")|'
+                    r'(?<=password":\s")|'
+                    r'(?<=email":\s")|'
+                    r'(?<=tk":\s")|'
+                    r'(?<=accountId":\s")|'
+                    r'(?<=authKey":\s")|'
+                    r'(?<=uuid":\s")|'
+                    r'(?<=cid":\s")|'
+                    r"(?<=token\s)|"
+                    r"(?<=account_id\s))"
+                    r'[^"\s]+'
                 ),
-                '##_REDACTED_##',
+                "##_REDACTED_##",
                 stringvalue,
             )
         return stringvalue

{pyvesync-2.1.13 → pyvesync-2.1.14}/src/pyvesync/vesyncbulb.py

@@ -16,7 +16,7 @@ Attributes:
 Note:
     The bulb module is built from the `feature_dict` dictionary and used by the
     `vesync.object_factory` and tests to determine the class to instantiate for
-    each bulb model.
+    each bulb model. These classes should not be instantiated manually.
 
 Examples:
     The following example shows the structure of the `feature_dict` dictionary:
@@ -48,6 +48,8 @@ logger = logging.getLogger(__name__)
 
 NUMERIC_T = Optional[Union[int, float, str]]
 
+# --8<-- [start:feature_dict]
+
 feature_dict: dict = {
     'ESL100':
         {
@@ -75,10 +77,11 @@ feature_dict: dict = {
         }
 }
 
+# --8<-- [end:feature_dict]
 
 bulb_modules: dict = {k: v['module'] for k, v in feature_dict.items()}
 
-__all__: list = list(bulb_modules.values()) + ['bulb_modules']
+__all__: list = list(bulb_modules.values()) + ["bulb_modules", "VeSyncBulb"]
 
 
 def pct_to_kelvin(pct: float, max_k: int = 6500, min_k: int = 2700) -> float:
@@ -91,7 +94,8 @@ class VeSyncBulb(VeSyncBaseDevice):
 
     Abstract base class to provide methods for controlling and
     getting details of VeSync bulbs. Inherits from
-    [`VeSyncBaseDevice`][pyvesync.vesyncbasedevice.VeSyncBaseDevice].
+    [`VeSyncBaseDevice`][pyvesync.vesyncbasedevice.VeSyncBaseDevice]. This class
+    should not be used directly for devices, but rather subclassed for each.
 
     Attributes:
         brightness (int): Brightness of bulb (0-100).
@@ -539,7 +543,26 @@ class VeSyncBulb(VeSyncBaseDevice):
                     print(f'{line[0]:.<30} {line[1]} {line[2]}')
 
     def displayJSON(self) -> str:
-        """Return bulb device info in JSON format."""
+        """Return bulb device info in JSON format.
+
+        Returns:
+            str: JSON formatted string of bulb details.
+
+        Example:
+            ```json
+            {
+                "deviceName": "Bulb",
+                "deviceStatus": "on",
+                "connectionStatus": "online",
+                "Brightness": "100%",
+                "WhiteTemperaturePct": "100%",
+                "WhiteTemperatureKelvin": "6500K",
+                "ColorHSV": "{"hue": 0, "saturation": 0, "value": 0}",
+                "ColorRGB": "{"red": 0, "green": 0, "blue": 0}",
+                "ColorMode": "hsv"
+            }
+            ```
+        """
         sup = super().displayJSON()
         sup_val = json.loads(sup)
         if self.connection_status == 'online':
@@ -595,17 +618,16 @@ class VeSyncBulbESL100MC(VeSyncBulb):
             two named tuple attributes - `hsv` & `rgb`. See [pyvesync.helpers.Color][].
 
     Notes:
-        The `self.details` dictionary is structured as follows:
+        The details dictionary contains the device information retreived by the
+        `update()` method:
         ```python
-        >>> self.details
-        {
-            'brightness': 0,
-            'colorMode': 'color',
-            'red': 0,
-            'green': 0,
-            'blue': 0
+        details = {
+            'brightness': 50,
+            'colorMode': 'rgb',
+            'color' : Color(red=0, green=0, blue=0)
         }
         ```
+        See pyvesync.helpers.Color for more information on the Color dataclass.
     """
 
     def __init__(self, details: dict[str, str | list], manager: VeSync) -> None:
@@ -613,7 +635,7 @@ class VeSyncBulbESL100MC(VeSyncBulb):
 
         Args:
             details (dict): Dictionary of bulb state details.
-            manager (VeSync): Manager class used to make API calls
+            manager (VeSync): Manager class used to make API calls.
         """
         super().__init__(details, manager)
         self.details: dict = {}
@@ -811,7 +833,8 @@ class VeSyncBulbESL100MC(VeSyncBulb):
 class VeSyncBulbESL100(VeSyncBulb):
     """Object to hold VeSync ESL100 light bulb.
 
-    This bulb only has the dimmable feature.
+    This bulb only has the dimmable feature. Inherits from pyvesync.vesyncbulb.VeSyncBulb
+    and pyvesync.vesyncbasedevice.VeSyncBaseDevice.
 
     Attributes:
         details (dict): Dictionary of bulb state details.

{pyvesync-2.1.13 → pyvesync-2.1.14}/src/pyvesync/vesyncfan.py

@@ -10,7 +10,7 @@ from pyvesync.helpers import Helpers, Timer
 humid_features: dict = {
     'Classic300S': {
         'module': 'VeSyncHumid200300S',
-        'models': ['Classic300S', 'LUH-A601S-WUSB'],
+        'models': ['Classic300S', 'LUH-A601S-WUSB', 'LUH-A601S-AUSW'],
         'features': ['nightlight'],
         'mist_modes': ['auto', 'sleep', 'manual'],
         'mist_levels': list(range(1, 10))
@@ -60,7 +60,7 @@ humid_features: dict = {
                        'LUH-O601S-WUS',
                        'LUH-O601S-KUS'],
             'features': ['warm_mist'],
-            'mist_modes': ['humidity', 'sleep', 'manual'],
+            'mist_modes': ['auto', 'humidity', 'sleep', 'manual'],
             'mist_levels': list(range(1, 10)),
             'warm_mist_levels': list(range(4))
     },
@@ -73,7 +73,7 @@ humid_features: dict = {
     },
     'Superior6000S': {
             'module': 'VeSyncSuperior6000S',
-            'models': ['LEH-S601S-WUS'],
+            'models': ['LEH-S601S-WUS', 'LEH-S601S-WUSR'],
             'features': [],
             'mist_modes': ['auto', 'humidity', 'sleep', 'manual'],
             'mist_levels': list(range(1, 10))

{pyvesync-2.1.13 → pyvesync-2.1.14}/src/pyvesync/vesyncswitch.py

@@ -1,4 +1,24 @@
-"""Classes for VeSync Switch Devices."""
+"""Classes for VeSync Switch Devices.
+
+This module provides classes for VeSync Switch Devices:
+
+    1. VeSyncSwitch: Abstract Base class for VeSync Switch Devices.
+    2. VeSyncWallSwitch: Class for VeSync Wall Switch Devices ESWL01 and ESWL03.
+    3. VeSyncDimmerSwitch: Class for VeSync Dimmer Switch Devices ESWD16.
+
+
+Attributes:
+    feature_dict (dict): Dictionary of switch models and their supported features.
+        Defines the class to use for each switch model and the list of features
+    switch_modules (dict): Dictionary of switch models as keys and their associated
+        classes as string values.
+
+Note:
+    The switch device is built from the `feature_dict` dictionary and used by the
+    `vesync.object_factory` during initial call to pyvesync.vesync.update() and
+    determines the class to instantiate for each switch model. These classes should
+    not be instantiated manually.
+"""
 
 import logging
 import json
@@ -10,6 +30,8 @@ from pyvesync.vesyncbasedevice import VeSyncBaseDevice
 
 logger = logging.getLogger(__name__)
 
+# --8<-- [start:feature_dict]
+
 feature_dict: Dict[str, Dict[str, Union[list, str]]] = {
     'ESWL01': {
         'module': 'VeSyncWallSwitch',
@@ -25,6 +47,8 @@ feature_dict: Dict[str, Dict[str, Union[list, str]]] = {
     }
 }
 
+# --8<-- [end:feature_dict]
+
 switch_modules: dict = {k: v['module']
                         for k, v in feature_dict.items()}
 
@@ -32,7 +56,16 @@ __all__: list = list(switch_modules.values()) + ['switch_modules']
 
 
 class VeSyncSwitch(VeSyncBaseDevice):
-    """Etekcity Switch Base Class."""
+    """Etekcity Switch Base Class.
+
+    Abstract Base Class for Etekcity Switch Devices, inherting from
+    pyvesync.vesyncbasedevice.VeSyncBaseDevice. Should not be instantiated directly,
+    subclassed by VeSyncWallSwitch and VeSyncDimmerSwitch.
+
+    Attributes:
+        features (list): List of features supported by the switch device.
+        details (dict): Dictionary of switch device details.
+    """
 
     __metaclasss__ = ABCMeta
 

{pyvesync-2.1.13 → pyvesync-2.1.14/src/pyvesync.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyvesync
-Version: 2.1.13
+Version: 2.1.14
 Summary: pyvesync is a library to manage Etekcity                 Devices, Cosori Air Fryers and Levoit Air                      Purifiers run on the VeSync app.
 Home-page: https://github.com/webdjoe/pyvesync
 Author: Mark Perdue, Joe Trabulsy
@@ -11,7 +11,10 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Natural Language :: English
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Home Automation
 Requires-Python: >=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
@@ -19,7 +22,7 @@ Requires-Dist: requests>=2.20.0
 Provides-Extra: dev
 Requires-Dist: pytest; extra == "dev"
 Requires-Dist: pytest-cov; extra == "dev"
-Requires-Dist: yaml; extra == "dev"
+Requires-Dist: pyyaml; extra == "dev"
 Requires-Dist: tox; extra == "dev"
 
 # pyvesync [![build status](https://img.shields.io/pypi/v/pyvesync.svg)](https://pypi.python.org/pypi/pyvesync) [![Build Status](https://dev.azure.com/webdjoe/pyvesync/_apis/build/status/webdjoe.pyvesync?branchName=master)](https://dev.azure.com/webdjoe/pyvesync/_build/latest?definitionId=4&branchName=master) [![Open Source? Yes!](https://badgen.net/badge/Open%20Source%20%3F/Yes%21/blue?icon=github)](https://github.com/Naereen/badges/) [![PyPI license](https://img.shields.io/pypi/l/ansicolortags.svg)](https://pypi.python.org/pypi/ansicolortags/) <!-- omit in toc -->

{pyvesync-2.1.13 → pyvesync-2.1.14}/src/pyvesync.egg-info/requires.txt

@@ -3,5 +3,5 @@ requests>=2.20.0
 [dev]
 pytest
 pytest-cov
-yaml
+pyyaml
 tox