Add more comprehensive example and clean up.

Author: zhoufeiy

blossom_network_interface.py

@@ -18,11 +18,10 @@ def __init__(self, server_ip, server_port):
 
         self.url = f"http://{self.server_ip}:{self.server_port}/data"
         self.data = {
-            "function": "do_start_sequence",
+            "function": "do_sequence",
             "kwargs": {
                 "blossom_id": 0,
                 "delay_time": 0.5,
-                "audio_length": 20,
                 "seq": "reset"
             }
         }

example.py

@@ -1,5 +1,7 @@
 import os
+import threading
 from time import sleep
+from time import time
 
 import dotenv
 from blossom_interface import BlossomInterface
@@ -8,7 +10,9 @@
 
 if __name__ == '__main__':
     dotenv.load_dotenv()
-    bl = BlossomInterface(False, os.getenv("SERVER_IP"), os.getenv("SERVER_PORT"))
+    # Initialize blossom interface
+    # Multi-blossom setup will only work with network interface
+    bl = BlossomInterface(True, os.getenv("SERVER_IP"), os.getenv("SERVER_PORT"))
 
     # Control blossom with bl object
     bl.reset()
@@ -27,4 +31,36 @@
     bl.do_sequence(idle_sequences[0], 0, 0)
     random.shuffle(idle_sequences)
     bl.do_sequence(idle_sequences[0], 0, 1)
-    input()
+
+    # You might want to control blossom without use sleep() that blocks main program. In that case, use threading.
+    # In most cases, sleep() is used for playing several sequences in a row. Because bl.do_sequence() will interrupt
+    # current sequence.
+    # You can use threading with sleep to do this.
+    # Or if your sequence is not dynamic, you can use blossom_sequence_comb.py to combine sequences to be a new
+    # sequence.
+
+    # Example:
+    class MyBlossomInterface:
+        def __init__(self, bli):
+            self.bli = bli
+
+        def do_idle_sequences(self, delay_time, blossom_id, total_rounds):
+            my_idle_sequences = ["breathing/exhale", "breathing/inhale", "fear/fear_startled", "happy/happy_lookingup",
+                              "sad/sad_downcast"]
+            sleep(delay_time)
+            for i in range(total_rounds):
+                random.shuffle(my_idle_sequences)
+                print(f"Sequence: {my_idle_sequences[0]}, Blossom ID: {0}")
+                self.bli.do_sequence(my_idle_sequences[0], 0, 0)
+                random.shuffle(my_idle_sequences)
+                print(f"Sequence: {my_idle_sequences[0]}, Blossom ID: {1}")
+                self.bli.do_sequence(my_idle_sequences[0], 0, 1)
+                sleep(3)
+
+    # import threading
+    my_bl = MyBlossomInterface(bl)
+    bl_thread_target = my_bl.do_idle_sequences
+    bl_thread_kwargs = {"delay_time": 0, "blossom_id": 0, "total_rounds": 3}
+    bl_thread = threading.Thread(target=bl_thread_target, kwargs=bl_thread_kwargs)
+    bl_thread.start()
+    # Doing something else