Merge pull request #617 from uzlonewolf/bulb-rewrite

Rewrite BulbDevice and rework set_multiple_values(), again

Author: jasonacox

RELEASE.md

@@ -1,5 +1,57 @@
 # RELEASE NOTES
 
+## v1.17.0 - BulbDevice Rewrite
+
+* Rewrite BulbDevice and rework set_multiple_values() @uzlonewolf in https://github.com/jasonacox/tinytuya/pull/617
+* Tool updates: pcap parse fix, new broadcast relay by @uzlonewolf in https://github.com/jasonacox/tinytuya/pull/612
+* Fix initialization bug with python2 (embedded devices) by @Ircama in https://github.com/jasonacox/tinytuya/pull/615
+
+BulbDevice Example Usage
+
+```python
+import time
+import random
+import tinytuya
+
+d = tinytuya.BulbDevice(DEVICEID, address=DEVICEIP, local_key=DEVICEKEY, version=DEVICEVERS, persist=True)
+
+# BASIC FUNCTIONS
+print('Basic Tests')
+d.set_colour(255,127,63)           # Set to orange
+d.set_white_percentage(100.0, 0.0) # 100% brightness, 0% colour temperature
+d.set_brightness_percentage(100)   # 100% brightness
+
+# MUSIC MODE
+print("Music Mode")
+d.set_mode('music')
+d.set_socketPersistent( True )
+# Devices respond with a command ACK, but do not send DP updates.
+# Setting the 2 options below causes it to wait for a response but
+#   return immediately after an ACK.
+d.set_sendWait( None )
+d.set_retry( False )
+for x in range(100):
+    red = random.randint(0,255)
+    green = random.randint(0,255)
+    blue = random.randint(0,255)
+    if (x % 6 == 0):
+        # extend every 6 beat
+        d.set_music_colour( d.MUSIC_TRANSITION_FADE, red, green, blue )
+        time.sleep(2)
+    else:
+        # Jump!
+        d.set_music_colour( d.MUSIC_TRANSITION_JUMP, red, green, blue )
+        time.sleep(0.1) # the bulbs seem to get upset if updates are faster than 0.1s (100ms)
+
+# SCENE MODE
+if d.bulb_has_capability(d.BULB_FEATURE_SCENE_DATA):
+    d.set_mode('scene')
+    print('String based scenes compatible smartbulb detected.')
+    # Example: Color rotation 
+    print('Switch to Scene 7 - Color Rotation')
+    d.set_scene( 7, '464602000003e803e800000000464602007803e803e80000000046460200f003e803e800000000464602003d03e803e80000000046460200ae03e803e800000000464602011303e803e800000000')
+```
+
 ## v1.16.3 - Cloud Error Handling
 
 * Add error handling in Cloud getdevices() function for edge case where old devices.json has corrupt or malformed device entries.

examples/bulb-music.py

@@ -3,34 +3,38 @@
 """
  TinyTuya - Smart Bulb RGB Music Test
 
- TODO: Figure out what strings to send to the bulb to 
-       represent real music data, beats, note, fades, etc.
-
  Author: Jason A. Cox
  For more information see https://github.com/jasonacox/tinytuya
 
 """
 import tinytuya
 import time
 import random
+import os
 
 #tinytuya.set_debug()
 
-# SmartBulb
 DEVICEID = "01234567891234567890"
-DEVICEIP = "10.0.1.99"
-DEVICEKEY = "0123456789abcdef"
-DEVICEVERS = "3.3"
+DEVICEIP = "Auto" # Will try to discover the bulb on the network
+DEVICEKEY = ""    # Leave blank to read from devices.json
+DEVICEVERS = 3.3  # Must be set correctly unless IP=Auto
+
+# Check for environmental variables and always use those if available
+DEVICEID = os.getenv("DEVICEID", DEVICEID)
+DEVICEIP = os.getenv("DEVICEIP", DEVICEIP)
+DEVICEKEY = os.getenv("DEVICEKEY", DEVICEKEY)
+DEVICEVERS = os.getenv("DEVICEVERS", DEVICEVERS)
 
 print("TinyTuya - Smart Bulb Music Test [%s]\n" % tinytuya.__version__)
 print('TESTING: Device %s at %s with key %s version %s' %
       (DEVICEID, DEVICEIP, DEVICEKEY, DEVICEVERS))
 
 # Connect to Tuya BulbDevice
-d = tinytuya.BulbDevice(DEVICEID, DEVICEIP, DEVICEKEY)
-d.set_version(float(DEVICEVERS)) # IMPORTANT to always set version 
-# Keep socket connection open between commands
-d.set_socketPersistent(True)  
+d = tinytuya.BulbDevice(DEVICEID, address=DEVICEIP, local_key=DEVICEKEY, version=DEVICEVERS, persist=True)
+
+if (not DEVICEIP) or (DEVICEIP == 'Auto') or (not DEVICEKEY) or (not DEVICEVERS):
+    print('Device %s found at %s with key %r version %s' %
+          (d.id, d.address, d.local_key, d.version))
 
 # Show status of device
 data = d.status()
@@ -41,25 +45,30 @@
 d.set_mode('music')
 data = d.status()
 
-x = 0
-while (x<20):
+d.set_socketPersistent( True )
+
+# Devices respond with a command ACK, but do not send DP updates.
+# Setting the 2 options below causes it to wait for a response but
+#   return immediately after an ACK.
+d.set_sendWait( None )
+d.set_retry( False )
+
+for x in range(100):
     # Value is 0 1111 2222 3333 4444 5555
     # see: https://developer.tuya.com/en/docs/iot/solarlight-function-definition?id=K9tp16f086d5h#title-10-DP27(8)%3A%20music
-    mode             = 0 # 0 - hard transitions (jumping), 1 - smooth transitions (gradient) 
-    hue              = random.randint(0,360)  # 1111 (hue:        0–360,  0X0000–0X0168)
-    saturation       = random.randint(0,1000) # 2222 (saturation: 0–1000, 0X0000–0X03E8)
-    brightness       = random.randint(0,1000) # 3333 (brightness: 0–1000, 0X0000–0X03E8)
-    white_brightness = 0 # 4444: indicates brightness. It ranges from 0 to 1,000.
-    temperature      = 0 # 5555: the temperature value (0–1000)
-    value = f"{mode:01X}{hue:04X}{saturation:04X}{brightness:04X}{white_brightness:04X}{temperature:04X}"
-    print (" > Sending %s" % value)
-    payload = d.generate_payload(tinytuya.CONTROL, {"27": value})
-    d.send(payload)
-    if (x % 3):
-        time.sleep(1)  # extend every 3 beat
-    time.sleep(0.2)
-    x = x + 1
+    red = random.randint(0,255)
+    green = random.randint(0,255)
+    blue = random.randint(0,255)
+
+    if (x % 6 == 0):
+        # extend every 6 beat
+        d.set_music_colour( d.MUSIC_TRANSITION_FADE, red, green, blue )
+        time.sleep(2)
+    else:
+        # Jump!
+        d.set_music_colour( d.MUSIC_TRANSITION_JUMP, red, green, blue )
+        time.sleep(0.1) # the bulbs seem to get upset if updates are faster than 0.1s (100ms)
 
 # Done
 print('\nDone')
-d.set_white()
+d.turn_off()

examples/bulb-scenes.py

@@ -1,29 +1,38 @@
 # TinyTuya Example
 # -*- coding: utf-8 -*-
 """
- TinyTuya - RGB SmartBulb - Scene Test for Bulbs with DPS Index 25
+ TinyTuya - RGB SmartBulb - Scene Test for Bulbs
 
  Author: Jason A. Cox
  For more information see https://github.com/jasonacox/tinytuya
 
 """
 import tinytuya
 import time
+import os
+
 
 DEVICEID = "01234567891234567890"
-DEVICEIP = "10.0.1.99"
-DEVICEKEY = "0123456789abcdef"
-DEVICEVERS = "3.3"
+DEVICEIP = "Auto" # Will try to discover the bulb on the network
+DEVICEKEY = ""    # Leave blank to read from devices.json
+DEVICEVERS = 3.3  # Must be set correctly unless IP=Auto
+
+# Check for environmental variables and always use those if available
+DEVICEID = os.getenv("DEVICEID", DEVICEID)
+DEVICEIP = os.getenv("DEVICEIP", DEVICEIP)
+DEVICEKEY = os.getenv("DEVICEKEY", DEVICEKEY)
+DEVICEVERS = os.getenv("DEVICEVERS", DEVICEVERS)
 
 print("TinyTuya - Smart Bulb String Scenes Test [%s]\n" % tinytuya.__version__)
 print('TESTING: Device %s at %s with key %s version %s' %
       (DEVICEID, DEVICEIP, DEVICEKEY, DEVICEVERS))
 
 # Connect to Tuya BulbDevice
-d = tinytuya.BulbDevice(DEVICEID, DEVICEIP, DEVICEKEY)
-d.set_version(float(DEVICEVERS)) # IMPORTANT to always set version 
-# Keep socket connection open between commands
-d.set_socketPersistent(True)  
+d = tinytuya.BulbDevice(DEVICEID, address=DEVICEIP, local_key=DEVICEKEY, version=DEVICEVERS, persist=True)
+
+if (not DEVICEIP) or (DEVICEIP == 'Auto') or (not DEVICEKEY) or (not DEVICEVERS):
+    print('Device %s found at %s with key %r version %s' %
+          (d.id, d.address, d.local_key, d.version))
 
 # Show status of device
 data = d.status()
@@ -33,33 +42,28 @@
 print('\nSetting bulb mode to Scenes')
 d.set_mode('scene')
 
-# Determine bulb type - if it has index 25 it uses strings to set scene
-if("dps" in data):
-    if("25" in data["dps"]):
-        print('\n   [Bulb Type B] String based scenes compatible smartbulb detected.')
+if d.bulb_has_capability(d.BULB_FEATURE_SCENE_DATA):
+    print('\n   String based scenes compatible smartbulb detected.')
+    # Example: Color rotation 
+    print('    Switch to Scene 7 - Color Rotation')
+    d.set_scene( 7, '464602000003e803e800000000464602007803e803e80000000046460200f003e803e800000000464602003d03e803e80000000046460200ae03e803e800000000464602011303e803e800000000')
+    time.sleep(10)
 
-        # Example: Color rotation 
-        print('    Scene - Color Rotation')
-        d.set_value(25, '07464602000003e803e800000000464602007803e803e80000000046460200f003e803e800000000464602003d03e803e80000000046460200ae03e803e800000000464602011303e803e800000000')
-        time.sleep(10)
+    # Example: Read scene
+    print('    Switch to Scene 1 - Reading Light')
+    d.set_scene( 1, '0e0d0000000000000003e803e8')
+    time.sleep(5)
 
-        # Example: Read scene
-        print('    Scene - Reading Light')
-        d.set_value(25, '010e0d0000000000000003e803e8')
+    # You can pull the scene strings from your smartbulb by running the async_send_receive.py script
+    # and using the SmartLife app to change between scenes.  
+else:
+    print('\n   Your smartbulb does not appear to support string based scenes.')
+    # Rotate through numeric scenes
+    for n in range(1, 5):
+        print('    Scene - %d' % n)
+        d.set_scene(n)
         time.sleep(5)
 
-        # You can pull the scene strings from your smartbulb by running the async_send_receive.py script
-        # and using the SmartLife app to change between scenes.  
-
-    else:
-        print('\n   [Bulb Type A] Your smartbulb does not appear to support string based scenes.')
-
-        # Rotate through numeric scenes
-        for n in range(1, 4):
-            print('    Scene - %d' % n)
-            d.set_scene(n)
-            time.sleep(5)
-
 # Done
 print('\nDone')
-d.set_white()
+d.turn_off()