Merge pull request #654 from jasonacox/v1.17.5

jasonacox · web-flow · commit 86dc9d21c653 · 2026-02-21T09:11:15.000-08:00
Enhance CoverDevice with automatic command type detection
diff --git a/README.md b/README.md
@@ -236,9 +236,25 @@ BulbDevice Additional Functions
     result = state():
 
 CoverDevice Additional Functions
-    open_cover(switch=1):
-    close_cover(switch=1):
-    stop_cover(switch=1):
+    open_cover(switch=None, nowait=False):
+    close_cover(switch=None, nowait=False):
+    stop_cover(switch=None, nowait=False):
+    continue_cover(switch=None, nowait=False):
+    set_cover_type(cover_type):                  # Manually set cover type (1-8)
+    
+    CoverDevice automatically detects one of 8 device types by checking status:
+      Type 1: ["open", "close", "stop", "continue"] - Most curtains, blinds, roller shades (DEFAULT)
+      Type 2: [true, false]                         - Simple relays, garage doors, locks
+      Type 3: ["0", "1", "2"]                       - String-numeric position/state
+      Type 4: ["00", "01", "02", "03"]              - Zero-prefixed numeric position/state
+      Type 5: ["fopen", "fclose"]                   - Directional binary (no stop)
+      Type 6: ["on", "off", "stop"]                 - Switch-lexicon open/close
+      Type 7: ["up", "down", "stop"]                - Vertical-motion (lifts, hoists)
+      Type 8: ["ZZ", "FZ", "STOP"]                  - Vendor-specific (Abalon-style, older standard)
+    
+    Detection uses priority ordering based on real-world frequency (Type 1 → Type 8 → Type 3 → others).
+    Defaults to Type 1 if detection fails. Manual override: set_cover_type(type_id).
+    Common DPS IDs: 1 (most common), 101 (second most common), 4 (dual-curtain second curtain).
 
 Cloud Functions
     setregion(apiRegion)
@@ -349,6 +365,34 @@ d.set_mode('scene')
 # Scene Example: Set Color Rotation Scene
 d.set_value(25, '07464602000003e803e800000000464602007803e803e80000000046460200f003e803e800000000464602003d03e803e80000000046460200ae03e803e800000000464602011303e803e800000000')
 
+"""
+Cover Device (Window Shade)
+"""
+c = tinytuya.CoverDevice('DEVICE_ID_HERE', 'IP_ADDRESS_HERE', 'LOCAL_KEY_HERE')
+c.set_version(3.3)
+data = c.status()
+
+# Show status
+print('Dictionary %r' % data)
+
+# CoverDevice will automatically detect the device type (1-8)
+# and use the appropriate commands
+
+# Open the cover
+c.open_cover()
+
+# Close the cover  
+c.close_cover()
+
+# Stop the cover
+c.stop_cover()
+
+# Continue cover motion (if supported by device type)
+c.continue_cover()
+
+# Manually set cover type if auto-detection doesn't work
+c.set_cover_type(1)   # Force Type 1 (open/close/stop/continue)
+
 ```
 ### Example Device Monitor
 
diff --git a/RELEASE.md b/RELEASE.md
@@ -1,5 +1,24 @@
 # RELEASE NOTES
 
+## v1.17.5 - CoverDevice Enhanced Type Detection
+
+* CoverDevice: Major rewrite to support 8 different device command types with automatic detection (credit for discovery: @make-all):
+  * Type 1: `["open", "close", "stop", "continue"]` - Most curtains, blinds, roller shades (DEFAULT)
+  * Type 2: `[true, false]` - Simple relays, garage doors, locks
+  * Type 3: `["0", "1", "2"]` - String-numeric position/state
+  * Type 4: `["00", "01", "02", "03"]` - Zero-prefixed numeric position/state
+  * Type 5: `["fopen", "fclose"]` - Directional binary (no stop)
+  * Type 6: `["on", "off", "stop"]` - Switch-lexicon
+  * Type 7: `["up", "down", "stop"]` - Vertical-motion (lifts, hoists)
+  * Type 8: `["ZZ", "FZ", "STOP"]` - Vendor-specific (Abalon-style, older standard)
+* Added `continue_cover()` method for device types that support it (Types 1 and 4)
+* Added `set_cover_type(type_id)` method to manually override auto-detection
+* Added `DEFAULT_COVER_TYPE` constant set to Type 1 (most comprehensive)
+* Device type is automatically detected on first command using priority ordering based on real-world frequency:
+  * Priority: Type 1 (most common) → Type 8 (second most common, older standard) → Type 3 → others
+  * Common DPS IDs: 1 (most common), 101 (second most common), 4 (dual-curtain second curtain)
+* Defaults to Type 1 if detection fails for best compatibility
+
 ## 1.17.4 - Cloud Config
 
 - Cloud: Add `configFile` option to the Cloud constructor, allowing users to specify the config file location (default remains 'tinytuya.json') by @blackw1ng in https://github.com/jasonacox/tinytuya/pull/640
diff --git a/tinytuya/CoverDevice.py b/tinytuya/CoverDevice.py
@@ -12,9 +12,35 @@
 
  Functions
     CoverDevice:
-        open_cover(switch=1):
-        close_cover(switch=1):
-        stop_cover(switch=1):
+        open_cover(switch=None, nowait=False)       # Open the cover (switch defaults to DPS_INDEX_MOVE)
+        close_cover(switch=None, nowait=False)      # Close the cover (switch defaults to DPS_INDEX_MOVE)
+        stop_cover(switch=None, nowait=False)       # Stop the cover motion (switch defaults to DPS_INDEX_MOVE)
+        continue_cover(switch=None, nowait=False)   # Continue cover motion (if supported)
+        set_cover_type(cover_type)                  # Manually set cover type (1-8)
+
+ Notes
+    CoverDevice automatically detects the device type (1-8) based on status response:
+    
+    Type 1: ["open", "close", "stop", "continue"] - Most curtains, blinds, roller shades (DEFAULT)
+    Type 2: [true, false]                         - Simple relays, garage doors, locks  
+    Type 3: ["0", "1", "2"]                       - String-numeric position/state
+    Type 4: ["00", "01", "02", "03"]              - Zero-prefixed numeric position/state
+    Type 5: ["fopen", "fclose"]                   - Directional binary (no stop)
+    Type 6: ["on", "off", "stop"]                 - Switch-lexicon open/close
+    Type 7: ["up", "down", "stop"]                - Vertical-motion (lifts, hoists)
+    Type 8: ["ZZ", "FZ", "STOP"]                  - Vendor-specific (Abalon-style, older standard)
+    
+    Credit for discovery: @make-all in https://github.com/jasonacox/tinytuya/issues/653
+    Detection occurs on first command by checking device status. Uses priority ordering
+    to handle overlapping values (Type 1 has highest priority). Defaults to Type 1 if
+    detection fails. You can manually override using set_cover_type(type_id) if needed.
+    
+    Common DPS IDs:
+    - DPS 1: Most common for cover control
+    - DPS 101: Second most common (often backlight or secondary function)
+    - DPS 4: Commonly used for second curtain in dual-curtain devices
+      (DPS 2 and 3 typically for position write/read, DPS 5 and 6 for second curtain,
+       with configuration and timers starting from DPS 7 onward)
 
     Inherited
         json = status()                    # returns json payload
@@ -46,24 +72,229 @@
 class CoverDevice(Device):
     """
     Represents a Tuya based Smart Window Cover.
+    
+    Supports 8 different command types with automatic detection.
     """
 
     DPS_INDEX_MOVE = "1"
     DPS_INDEX_BL = "101"
+    DEFAULT_COVER_TYPE = 1  # Default to Type 1 (most common)
 
     DPS_2_STATE = {
         "1": "movement",
         "101": "backlight",
     }
 
-    def open_cover(self, switch=1, nowait=False):
-        """Open the cover"""
-        self.set_status("on", switch, nowait=nowait)
+    # Cover type command mappings
+    COVER_TYPES = {
+        1: {  # Comprehensive movement class
+            'open': 'open',
+            'close': 'close',
+            'stop': 'stop',
+            'continue': 'continue',
+            'detect_values': ['open', 'close', 'stop', 'continue']
+        },
+        2: {  # Binary on/off class
+            'open': True,
+            'close': False,
+            'stop': None,  # Not supported
+            'continue': None,
+            'detect_values': [True, False]
+        },
+        3: {  # String-numeric index class
+            'open': '1',
+            'close': '2',
+            'stop': '0',
+            'continue': None,
+            'detect_values': ['0', '1', '2']
+        },
+        4: {  # Zero-prefixed numeric index class
+            'open': '01',
+            'close': '02',
+            'stop': '00',
+            'continue': '03',
+            'detect_values': ['00', '01', '02', '03']
+        },
+        5: {  # Directional binary class
+            'open': 'fopen',
+            'close': 'fclose',
+            'stop': None,  # Not supported
+            'continue': None,
+            'detect_values': ['fopen', 'fclose']
+        },
+        6: {  # Switch-lexicon class
+            'open': 'on',
+            'close': 'off',
+            'stop': 'stop',
+            'continue': None,
+            'detect_values': ['on', 'off', 'stop']
+        },
+        7: {  # Vertical-motion class
+            'open': 'up',
+            'close': 'down',
+            'stop': 'stop',
+            'continue': None,
+            'detect_values': ['up', 'down', 'stop']
+        },
+        8: {  # Vendor-specific class (Abalon-style)
+            'open': 'ZZ',
+            'close': 'FZ',
+            'stop': 'STOP',
+            'continue': None,
+            'detect_values': ['ZZ', 'FZ', 'STOP']
+        }
+    }
+
+    def __init__(self, *args, **kwargs):
+        super(CoverDevice, self).__init__(*args, **kwargs)
+        self._cover_type_detected = False
+        self._cover_type = None  # Will be set to 1-8 after detection
+
+    def _detect_cover_type(self, switch=None):
+        """
+        Automatically detect the cover device type (1-8) by checking device status.
+        Uses priority ordering to handle overlapping values (e.g., 'stop' appears in Types 1, 6, 7).
+        Type 1 has highest priority as it's the most comprehensive.
+        
+        Args:
+            switch (str/int): The DPS index to check. Defaults to DPS_INDEX_MOVE.
+        """
+        if self._cover_type_detected:
+            return
+
+        if switch is None:
+            switch = self.DPS_INDEX_MOVE
+
+        # Set default to Type 1 (most comprehensive) before attempting detection
+        self._cover_type = self.DEFAULT_COVER_TYPE
+
+        try:
+            result = self.status()
+            if result and 'dps' in result:
+                dps_key = str(switch)
+                dps_value = result['dps'].get(dps_key)
+                
+                # Try to match the current value to a known cover type
+                # Priority order: 1, 8, 3, 4, 5, 7, 2, 6 (most common to least common)
+                # Type 1: Most common (comprehensive standard)
+                # Type 8: Second most common (older vendor standard)
+                # Type 3: Third most common (string-numeric)
+                # Others: Rare variations
+                if dps_value is not None:
+                    priority_order = [1, 8, 3, 4, 5, 7, 2, 6]
+                    for type_id in priority_order:
+                        type_info = self.COVER_TYPES[type_id]
+                        if dps_value in type_info['detect_values']:
+                            self._cover_type = type_id
+                            break
+                    
+        except Exception:
+            # If status check fails, use default Type 1
+            pass
+        
+        self._cover_type_detected = True
+
+    def set_cover_type(self, cover_type):
+        """
+        Manually set the cover device type.
+        
+        Args:
+            cover_type (int): Cover type ID (1-8).
+        
+        Raises:
+            ValueError: If cover_type is not between 1 and 8.
+        
+        Example:
+            cover.set_cover_type(1)  # Set to Type 1 (open/close/stop/continue)
+            cover.set_cover_type(6)  # Set to Type 6 (on/off/stop)
+        """
+        if cover_type not in self.COVER_TYPES:
+            raise ValueError(f"Invalid cover_type: {cover_type}. Must be between 1 and 8.")
+        
+        self._cover_type = cover_type
+        self._cover_type_detected = True
+
+    def _get_command(self, action, switch=None):
+        """
+        Get the appropriate command for the detected cover type.
+        
+        Args:
+            action (str): The action to perform ('open', 'close', 'stop', 'continue').
+            switch (str/int): The DPS index. Defaults to DPS_INDEX_MOVE.
+        
+        Returns:
+            The command value for the detected cover type, or None if not supported.
+        """
+        if not self._cover_type_detected:
+            self._detect_cover_type(switch)
+        
+        if self._cover_type and self._cover_type in self.COVER_TYPES:
+            return self.COVER_TYPES[self._cover_type].get(action)
+        
+        return None
+
+    def open_cover(self, switch=None, nowait=False):
+        """
+        Open the cover.
+        
+        Args:
+            switch (str/int): The DPS index. Defaults to DPS_INDEX_MOVE.
+            nowait (bool): Don't wait for device response.
+        """
+        if switch is None:
+            switch = self.DPS_INDEX_MOVE
+        
+        command = self._get_command('open', switch)
+        if command is not None:
+            self.set_value(switch, command, nowait=nowait)
+
+    def close_cover(self, switch=None, nowait=False):
+        """
+        Close the cover.
+        
+        Args:
+            switch (str/int): The DPS index. Defaults to DPS_INDEX_MOVE.
+            nowait (bool): Don't wait for device response.
+        """
+        if switch is None:
+            switch = self.DPS_INDEX_MOVE
+        
+        command = self._get_command('close', switch)
+        if command is not None:
+            self.set_value(switch, command, nowait=nowait)
 
-    def close_cover(self, switch=1, nowait=False):
-        """Close the cover"""
-        self.set_status("off", switch, nowait=nowait)
+    def stop_cover(self, switch=None, nowait=False):
+        """
+        Stop the cover motion.
+        
+        Args:
+            switch (str/int): The DPS index. Defaults to DPS_INDEX_MOVE.
+            nowait (bool): Don't wait for device response.
+        
+        Note:
+            Not all cover types support stop. Types 2 and 5 do not have a stop command.
+        """
+        if switch is None:
+            switch = self.DPS_INDEX_MOVE
+        
+        command = self._get_command('stop', switch)
+        if command is not None:
+            self.set_value(switch, command, nowait=nowait)
 
-    def stop_cover(self, switch=1, nowait=False):
-        """Stop the motion of the cover"""
-        self.set_status("stop", switch, nowait=nowait)
+    def continue_cover(self, switch=None, nowait=False):
+        """
+        Continue the cover motion (if supported).
+        
+        Args:
+            switch (str/int): The DPS index. Defaults to DPS_INDEX_MOVE.
+            nowait (bool): Don't wait for device response.
+        
+        Note:
+            Only Type 1 and Type 4 support the continue command.
+        """
+        if switch is None:
+            switch = self.DPS_INDEX_MOVE
+        
+        command = self._get_command('continue', switch)
+        if command is not None:
+            self.set_value(switch, command, nowait=nowait)
diff --git a/tinytuya/core/core.py b/tinytuya/core/core.py
@@ -101,7 +101,7 @@
 if HAVE_COLORAMA:
     init()
 
-version_tuple = (1, 17, 4)  # Major, Minor, Patch
+version_tuple = (1, 17, 5)  # Major, Minor, Patch
 version = __version__ = "%d.%d.%d" % version_tuple
 __author__ = "jasonacox"
 
