hue actor

examples/bffh.dhall

@@ -181,6 +181,11 @@
             }
         },
 
+        Hue1 = {
+            module = "Process",
+            params = { cmd = "./examples/hue.py", args = "-vvv" }
+        }
+
         DoorControl1 = {
             -- This actor calls the actor.py script in examples/
             -- It gets passed it's own name, so you can have several actors
@@ -221,14 +226,14 @@
     -- Initiators are configured almost the same way as Actors, refer to actor documentation for more details
     -- The below '{=}' is what you need if you want to define *no* initiators at all and only use the API with apps
     -- to let people use machines.
-    initiators = {=},
+    --initiators = {=},
     -- The "Dummy" initiator will try to use and return a machine as the given user every few seconds. It's good to
     -- test your system but will spam your log so is disabled by default.
-    --initiators = { Initiator = { module = "Dummy", params = { uid = "Testuser" } } },
+    initiators = { Initiator = { module = "Dummy", params = { uid = "Testuser" } } },
 
     -- Linking up machines to initiators. Similar to actors a machine can have several initiators assigned but an
     -- initiator can only be assigned to one machine.
     -- The below is once again how you have to define *no* initiators.
-    init_connections = [] : List { machine : Text, initiator : Text }
-    --init_connections = [{ machine = "Testmachine", initiator = "Initiator" }]
+    --init_connections = [] : List { machine : Text, initiator : Text }
+    init_connections = [{ machine = "Testmachine", initiator = "Initiator" }]
 }

examples/hue.py

@@ -0,0 +1,218 @@
+#!/home/dequbed/.local/share/virtualenvs/test-hue--FYg3JEF/bin/python
+
+import sys
+import argparse
+
+from phue import Bridge
+b = Bridge("192.168.178.152")
+b.connect()
+
+lamps = { "Hue1": 4 }
+
+def reset_lamp(lamp):
+    b.set_light(lamp, hues["reset"])
+
+TRANS=2
+
+hues = {
+    "reset": { "on": True, "ct": 443, "bri": 186 },
+    "free": { "on": True, "hue": 21845, "bri": 186 },
+    "use": { "on": True, "hue": 64611, "sat": 253, "bri": 100 },
+    "check": { "on": True, "hue": 0, "sat": 254, "bri": 254 },
+    "reserved": { "on": True, "hue": 42309, "sat": 237, "bri": 186 },
+    "disabled": { "on": False },
+    "blocked": { "on": True, "hue": 10625, "sat": 254, "bri": 186 }
+}
+
+def on_free(args, actor_name):
+    """
+    Function called when the state of the connected machine changes to Free
+    again
+    """
+    if args.verbose > 2:
+        print("on_free called!")
+
+    if actor_name in lamps:
+        if "free" in hues:
+            b.set_light(lamps[actor_name], hues["free"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unknown id %s for state `Free`" % actor_name)
+        # It's a good idea to exit with an error code in case something
+        # unexpected happens.
+        # The process module logs everything printed to stdout by actors into
+        # the server log, but marks them as `Error` in case the actor process
+        # exits with a code != 0, making debugging somewhat easier.
+        exit(-1)
+
+def on_use(args, actor_name, user_id):
+    """
+    Function called when an user takes control of the connected machine
+
+    user_id contains the UID of the user now using the machine
+    """
+    if args.verbose > 2:
+        print("on_use called!")
+    if actor_name in lamps:
+        if "use" in hues:
+            b.set_light(lamps[actor_name], hues["use"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unknown id %s for state `InUse`" % actor_name)
+        # It's a good idea to exit with an error code in case something
+        # unexpected happens.
+        # The process module logs everything printed to stdout by actors into
+        # the server log, but marks them as `Error` in case the actor process
+        # exits with a code != 0, making debugging somewhat easier.
+        exit(-1)
+
+def on_tocheck(args, actor_name, user_id):
+    """
+    Function called when an user returns control and the connected machine is
+    configured to go to state `ToCheck` instead of `Free` in that case.
+
+    user_id contains the UID of the manager expected to check the machine.
+    The user that used the machine beforehand has to be taken from the last
+    user field using the API (via e.g. the mobile app)
+    """
+    if args.verbose > 2:
+        print("on_tocheck called!")
+    if actor_name in lamps:
+        if "check" in hues:
+            b.set_light(lamps[actor_name], hues["check"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unexpected combo id %s and state 'ToCheck'" % actor_name)
+        exit(-1)
+
+def on_blocked(args, actor_name, user_id):
+    """
+    Function called when an manager marks the connected machine as `Blocked`
+
+    user_id contains the UID of the manager that blocked the machine
+    """
+    if args.verbose > 2:
+        print("on_blocked called!")
+    if actor_name in lamps:
+        if "blocked" in hues:
+            b.set_light(lamps[actor_name], hues["blocked"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unexpected combo id %s and state 'Blocked'" % actor_name)
+        exit(-1)
+
+def on_disabled(args, actor_name):
+    """
+    Function called when the connected machine is marked `Disabled`
+    """
+    if actor_name in lamps:
+        if "disabled" in hues:
+            b.set_light(lamps[actor_name], hues["disabled"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unexpected combo id %s and state 'Disabled'" % actor_name)
+        exit(-1)
+
+def on_reserve(args, actor_name, user_id):
+    """
+    Function called when the connected machine has been reserved by somebody.
+
+    user_id contains the UID of the reserving user.
+    """
+    if actor_name in lamps:
+        if "reserved" in hues:
+            b.set_light(lamps[actor_name], hues["reserved"], transitiontime=TRANS)
+        else:
+            reset_lamp(lamps[actor_name])
+    else:
+        if not args.quiet:
+            print("process called with unexpected combo id %s and state 'Reserved'" % actor_name)
+        exit(-1)
+
+
+def main(args):
+    """
+    Python example actor
+
+    This is an example how to use the `process` actor type to run a Python script.
+    """
+
+    if args.verbose is not None:
+        if args.verbose == 1:
+            print("verbose output enabled")
+        elif args.verbose == 2:
+            print("loud output enabled!")
+        elif args.verbose == 3:
+            print("LOUD output enabled!!!")
+        elif args.verbose > 4:
+            print("Okay stop you're being ridiculous.")
+            sys.exit(-2)
+    else:
+        args.verbose = 0
+
+    # You could also check the actor name here and call different functions
+    # depending on that variable instead of passing it to the state change
+    # methods.
+
+    new_state = args.state
+    if new_state == "free":
+        on_free(args, args.name)
+    elif new_state == "inuse":
+        on_use(args, args.name, args.userid)
+    elif new_state == "tocheck":
+        on_tocheck(args, args.name, args.userid)
+    elif new_state == "blocked":
+        on_blocked(args, args.name, args.userid)
+    elif new_state == "disabled":
+        on_disabled(args, args.name)
+    elif new_state == "reserved":
+        on_reserve(args, args.name, args.userid)
+    else:
+        print("Process actor called with unknown state %s" % new_state)
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    # Parameters are passed to the Process actor as follows:
+    # 1. the contents of params.args, split by whitespace as separate args
+    # 2. the configured id of the actor (e.g. "DoorControl1")
+    # 3. the new state as one of [free|inuse|tocheck|blocked|disabled|reserved]
+
+    parser.add_argument("-q", "--quiet", help="be less verbose", action="store_true")
+    parser.add_argument("-v", "--verbose", help="be more verbose", action="count")
+
+    parser.add_argument("name",
+                        help="name of this actor as configured in bffh.dhall"
+                        )
+
+    # We parse the new state using subparsers so that we only require a userid
+    # in case it's a state that sets one.
+    subparsers = parser.add_subparsers(required=True, dest="state")
+
+    parser_free = subparsers.add_parser("free")
+
+    parser_inuse = subparsers.add_parser("inuse")
+    parser_inuse.add_argument("userid", help="The user that is now using the machine")
+
+    parser_tocheck = subparsers.add_parser("tocheck")
+    parser_tocheck.add_argument("userid", help="The user that should go check the machine")
+
+    parser_blocked = subparsers.add_parser("blocked")
+    parser_blocked.add_argument("userid", help="The user that marked the machine as blocked")
+
+    parser_disabled = subparsers.add_parser("disabled")
+
+    parser_reserved = subparsers.add_parser("reserved")
+    parser_reserved.add_argument("userid", help="The user that reserved the machine")
+
+    args = parser.parse_args()
+    main(args)