added DelayWorkflow; removed sending null data; added optional data payload to SendTriggerWorkflow

Author: sboettcher

logic/message.py

@@ -104,9 +104,15 @@ def toJSON(self):
         >>> m.toJSON()
         '{"method": "trigger", "state": "on", "data": null}'
         """
-        result = json.dumps({
-            "method": self.method.name.lower(),
-            "state": self.state.name.lower(),
-            "data": self.data
-        })
+        if self.data:
+            result = json.dumps({
+                "method": self.method.name.lower(),
+                "state": self.state.name.lower(),
+                "data": self.data
+            })
+        else:
+            result = json.dumps({
+                "method": self.method.name.lower(),
+                "state": self.state.name.lower()
+            })
         return result

logic/workflow_definition.py

@@ -40,7 +40,9 @@ def create(self, settings):
                     LightControlWorkflow(Location.LOBBYROOM, State.ON, 255, (0, 0, 0)),
                     LightControlWorkflow(Location.MAINROOM, State.ON, 255, (0, 0, 0)),
                     LightControlWorkflow(Location.SERVERROOM, State.ON, 255, (0, 0, 0)),
-                    TTSAudioWorkflow("TTS1", "Warning, power failure! Warning, power failure!"),
+                    DelayWorkflow("FailDelay1", 1),
+                    TTSAudioWorkflow("FailTTS1", "Warning, power failure! Warning, power failure!"),
+                    DelayWorkflow("FailDelay2", 5),
                     LightControlWorkflow(Location.LOBBYROOM, State.ON, 255, (255, 0, 0)),
                     #SendTriggerWorkflow("Play Video", "env/video", State.ON),
                 ]),
@@ -52,7 +54,7 @@ def create(self, settings):
                 CombinedWorkflow("1st Door", [
                     SendTriggerWorkflow("Open Control Room Door", "4/door/entrance", State.ON),
                     LightControlWorkflow(Location.MAINROOM, State.ON, 255, (255, 0, 0)),
-                    TTSAudioWorkflow("TTS2", "Warning, emergency backup battery empty, please recharge!"),
+                    TTSAudioWorkflow("Door1TTS1", "Warning, emergency backup battery empty, please recharge!"),
                 ]),
             ]),
 
@@ -65,7 +67,7 @@ def create(self, settings):
                     LightControlWorkflow(Location.LOBBYROOM, State.ON, 255, (255, 255, 255)),
                     LightControlWorkflow(Location.MAINROOM, State.ON, 255, (255, 255, 255)),
                     LightControlWorkflow(Location.SERVERROOM, State.ON, 255, (255, 0, 0)),
-                    TTSAudioWorkflow("TTS3", "Emergency power restored! Generators offline! Restart server!"),
+                    TTSAudioWorkflow("RestoredTTS1", "Emergency power restored! Generators offline! Restart server!"),
                 ]),
                 SequenceWorkflow("Puzzle 3 - Radio", [
                     Workflow("Antenna Aligned", "3/gamecontrol/antenna"),

logic/workflow_extras.py

@@ -1,5 +1,5 @@
-import json
-from workflow import *
+import json, time
+from workflow import CombinedWorkflow, SingleCommandWorkflow
 from message import Message, Method, State
 from util import Location
 
@@ -60,10 +60,10 @@ def __init__(self, workflows, settings=None):
 
 class SendTriggerWorkflow(SingleCommandWorkflow):
     """
-    This workflow sends trigger:on and trigger:off to a given topic.
+    This workflow sends trigger:on and trigger:off to a given topic. Can optionally send data as well.
     """
 
-    def __init__(self, name, topic, target_state):
+    def __init__(self, name, topic, target_state, data=None):
         """
         Initializes a new instance of this class.
 
@@ -80,6 +80,7 @@ def __init__(self, name, topic, target_state):
         """
         self.target_state = target_state
         self.topic = topic
+        self.data = data
         super().__init__(name)
 
     def _execute_single_command(self, client):
@@ -91,11 +92,11 @@ def _execute_single_command(self, client):
         client : Client
             MQTT client
         """
-        self._publishTrigger(client, self.target_state)
+        self._publishTrigger(client, self.target_state, self.data)
 
-    def _publishTrigger(self, client, state):
+    def _publishTrigger(self, client, state, data=None):
         if self.topic is not None:
-            message = Message(Method.TRIGGER, state)
+            message = Message(Method.TRIGGER, state, data)
             client.publish(self.topic, message.toJSON(), 2)
             print(f"[{self.name}] Triggered '{state.name}'...")
 
@@ -250,8 +251,6 @@ def _publishTrigger(self, client, state, data):
         )
 
 
-
-
 class LightControlWorkflow(CombinedWorkflow):
     """
     This workflow controls the LED stripes at the specified locationin one single workfow.
@@ -294,3 +293,28 @@ def __init__(self, target_location, target_state, brightness=255, color=(255, 25
 
         name = f"Turn {target_state.name} {target_location.name} lights ({brightness})/255"
         super().__init__(name, workflows, None)
+
+
+class DelayWorkflow(SingleCommandWorkflow):
+    """
+    This workflow implements a blocking delay.
+    """
+
+    def __init__(self, name, delay_sec):
+        """
+        Initializes a new instance of this class.
+
+        Parameters
+        ----------
+        name : str
+            Display name of the workflow.
+
+        delay_sec : int
+            The number of seconds delay.
+        """
+        self.delay_sec = delay_sec
+        super().__init__(name)
+
+    def _execute_single_command(self, client):
+        if self.delay_sec > 0:
+            time.sleep(self.delay_sec)