Dimmer and Brightness Functions

Author: jasonacox

README.md

@@ -144,6 +144,7 @@ Classes
 
     BulbDevice
         set_colour(r, g, b):
+        set_hsv(h, s, v):
         set_white(brightness, colourtemp):
         set_white_percentage(brightness=100, colourtemp=0):
         set_brightness(brightness):
@@ -169,12 +170,14 @@ Starting with v1.2.0 TinyTuya functions will return error details in the JSON da
 
 The "Err" number will be one of these:
 
-* 900 - Invalid JSON Response from Device
-* 901 - Network Error: Unable to Connect
-* 902 - Timeout Waiting for Device
-* 903 - Specified Value Out of Range
-* 904 - Unexpected Payload from Device
-* 905 - Network Error: Device Unreachable
+* 900 (ERR_JSON) - Invalid JSON Response from Device
+* 901 (ERR_CONNECT) - Network Error: Unable to Connect
+* 902 (ERR_TIMEOUT) - Timeout Waiting for Device
+* 903 (ERR_RANGE) - Specified Value Out of Range
+* 904 (ERR_PAYLOAD) - Unexpected Payload from Device
+* 905 (ERR_OFFLINE) - Network Error: Device Unreachable
+* 906 (ERR_STATE) - Device in Unknown State
+* 907 (ERR_FUNCTION) - Function Not Supported by Device
 
 ### Example Usage
 

RELEASE.md

@@ -6,10 +6,13 @@
 * Add socket.shutdown(socket.SHUT_RDWR)
 * Add function to send multiple DPS index updates with one call
 
-## v1.2.3 - Dimmer Function
+## v1.2.3 - Dimmer and Brightness Functions
 
 * PyPi Version 1.2.3
-* Added `set_dimmer()` to OutletDevice class
+* Added `set_dimmer()` to OutletDevice class.
+* Added `set_hsv()` to BulbDevice class.
+* Updated `set_brightness()` in BulbDevice to handle *white* and *colour* modes. Issue #30
+* BulbDevice determines features of device and presents boolean variables `has_colour`, `has_brightness` and `has_colourtemp` to ignore requests that do not exist (returns error).
 
 ## v1.2.2 - Bug Fix for Bulb Functions
 

tinytuya/__init__.py

@@ -183,6 +183,8 @@
 ERR_RANGE = 903
 ERR_PAYLOAD = 904
 ERR_OFFLINE = 905
+ERR_STATE = 906
+ERR_FUNCTION = 907
 
 error_codes = {
     ERR_JSON: 'Invalid JSON Response from Device',
@@ -191,6 +193,8 @@
     ERR_RANGE: 'Specified Value Out of Range',
     ERR_PAYLOAD: 'Unexpected Payload from Device',
     ERR_OFFLINE: 'Network Error: Device Unreachable',
+    ERR_STATE: 'Device in Unknown State',
+    ERR_FUNCTION: 'Function Not Supported by Device',
     None: 'Unknown Error'
 }
 
@@ -1047,8 +1051,11 @@ class BulbDevice(Device):
         '24': 'colour',
     }
 
-    # Default Bulb Type
+    # Set Default Bulb Types
     bulb_type = 'A'
+    has_brightness = False
+    has_colourtemp = False
+    has_colour = False
 
     def __init__(self, dev_id, address, local_key="", dev_type="default"):
         super(BulbDevice, self).__init__(dev_id, address, local_key, dev_type)
@@ -1146,9 +1153,9 @@ def _hexvalue_to_hsv(hexvalue, bulb='A'):
             hexvalue(string): The hex representation generated by BulbDevice._rgb_to_hexvalue()
         """
         if(bulb == 'A'):
-            h = int(hexvalue[7:10], 16) / 360
-            s = int(hexvalue[10:12], 16) / 255
-            v = int(hexvalue[12:14], 16) / 255
+            h = int(hexvalue[7:10], 16) / 360.0
+            s = int(hexvalue[10:12], 16) / 255.0
+            v = int(hexvalue[12:14], 16) / 255.0
         if(bulb == 'B'):
             # hexvalue is in hsv
             h = int(hexvalue[0:4], 16)/360.0
@@ -1165,11 +1172,18 @@ def set_version(self, version):
             Type B has keys 20-29
         """
         self.version = version
-        # Try to determine type of BulbDevice Type based on switch DPS
+
+        # Try to determine type of BulbDevice Type based on DPS indexes
         status = self.status()
         if 'dps' in status:
             if '1' not in status['dps']:
                 self.bulb_type = 'B'
+            if self.DPS_INDEX_BRIGHTNESS[self.bulb_type] in status['dps']:
+                self.has_brightness = True
+            if self.DPS_INDEX_COLOURTEMP[self.bulb_type] in status['dps']:
+                self.has_colourtemp = True
+            if self.DPS_INDEX_COLOUR[self.bulb_type] in status['dps']:
+                self.has_colour = True
         else:
             # response has no dps
             self.bulb_type = 'B'
@@ -1236,6 +1250,8 @@ def set_colour(self, r, g, b):
             g(int): Value for the colour green as int from 0-255.
             b(int): Value for the colour blue as int from 0-255.
         """
+        if not self.has_colour:
+            return error_json(ERR_FUNCTION, "set_colour: Device does not support color.")
         if not 0 <= r <= 255:
             return error_json(ERR_RANGE,
                 "set_colour: The value for red needs to be between 0 and 255.")
@@ -1254,6 +1270,36 @@ def set_colour(self, r, g, b):
         data = self._send_receive(payload)
         return data
 
+    def set_hsv(self, h, s, v):
+        """
+        Set colour of an rgb bulb using h, s, v.
+
+        Args:
+            h(float): colour Hue as int from 0-1
+            s(float): colour Saturation as int from 0-1
+            v(float): colour Value as int from 0-1
+        """
+        if not self.has_colour:
+            return error_json(ERR_FUNCTION, "set_colour: Device does not support color.")
+        if not 0 <= h <= 1.0:
+            return error_json(ERR_RANGE,
+                "set_colour: The value for Hue needs to be between 0 and 1.")
+        if not 0 <= s <= 1.0:
+            return error_json(ERR_RANGE,
+                "set_colour: The value for Saturation needs to be between 0 and 1.")
+        if not 0 <= v <= 1.0:
+            return error_json(ERR_RANGE,
+                "set_colour: The value for Value needs to be between 0 and 1.")
+
+        (r,g,b) = colorsys.hsv_to_rgb(h,s,v)
+        hexvalue = BulbDevice._rgb_to_hexvalue(r*255.0, g*255.0, b*255.0, self.bulb_type)
+
+        payload = self.generate_payload(CONTROL, {
+            self.DPS_INDEX_MODE[self.bulb_type]: self.DPS_MODE_COLOUR,
+            self.DPS_INDEX_COLOUR[self.bulb_type]: hexvalue})
+        data = self._send_receive(payload)
+        return data
+
     def set_white_percentage(self, brightness=100, colourtemp=0):
         """
         Set white coloured theme of an rgb bulb.
@@ -1349,9 +1395,28 @@ def set_brightness(self, brightness):
         if self.bulb_type == 'B' and not (10 <= brightness <= 1000):
                 return error_json(ERR_RANGE,"set_brightness: The brightness needs to be between 10 and 1000.")
 
-        payload = self.generate_payload(
-            CONTROL, {self.DPS_INDEX_BRIGHTNESS[self.bulb_type]: brightness})
-        data = self._send_receive(payload)
+        # Determine which mode bulb is in and adjust accordingly
+        state = self.state()
+        data = error_json(ERR_STATE,"set_brightness: Unknown bulb state.")
+
+        if 'mode' in state:
+            if state['mode'] == 'white':
+                # for white mode use DPS for brightness
+                if not self.has_brightness:
+                    return error_json(ERR_FUNCTION, "set_colour: Device does not support brightness.")
+                payload = self.generate_payload(
+                    CONTROL, {self.DPS_INDEX_BRIGHTNESS[self.bulb_type]: brightness})
+                data = self._send_receive(payload)
+        
+            if state['mode'] == 'colour':
+                # for colour mode use hsv to increase brightness
+                if self.bulb_type == 'A':
+                    value = brightness / 255.0
+                else:
+                    value = brightness / 1000.0
+                (h,s,v) = self.colour_hsv()
+                data = self.set_hsv(h,s,value)
+        
         return data
 
     def set_colourtemp_percentage(self, colourtemp=100):
@@ -1377,6 +1442,8 @@ def set_colourtemp(self, colourtemp):
         Args:
             colourtemp(int): Value for the colour temperature (0-255).
         """
+        if not self.has_colourtemp:
+            return error_json(ERR_FUNCTION, "set_colourtemp: Device does not support colortemp.")
         if self.bulb_type == 'A' and not (0 <= colourtemp <= 255):
             return error_json(ERR_RANGE,
                 "set_colourtemp: The colour temperature needs to be between 0 and 255.")
@@ -1411,6 +1478,8 @@ def state(self):
         """Return state of Bulb"""
         status = self.status()
         state = {}
+        if not status:
+            return error_json(ERR_JSON,"state: empty response")
 
         for key in status[self.DPS].keys():
             if(key in self.DPS_2_STATE):