UI and Button Handling (#18)

* basic window

* run loop with asyncio & command queue

* button handling and command queue

* update test script, remove print statements

* red, green, blue parameters

* working textualize ui

* readme

Author: blainerothrock

README.md

@@ -36,7 +36,8 @@ robot.move(0, 0)            # Stop the robot
 
 robot.led(0, 0, 0)          # Turn off the LED
 
-robot.run()                 # Execute the commands
+a = robot.set_key_binding('a').led(0, 0, 255, 1) # set LED color one button A
+w = robot.set_key_binding('w').move(100, 100)    # bind move forward to key W
 ```
 
 ## API

demo/test.py

@@ -1,9 +1,17 @@
 from weallcode_robot import Robot
 
 # Create a robot
-name = "beep"
+name = "WAC-C9B9"
 robot = Robot(name)
 
+# assign button A to set LED to blue for 1 second
+robot.button_a.led(0, 0, 255, 1)
+
+# assign button B to set LED to red & buzz at 440Hz for 0.5 seconds
+robot.button_b.led(255, 0, 0)
+
+a = robot.set_key_binding('a').led(0, 0, 255, 1)
+
 # Display the robot's name (uppercased) on the robot's display for 2.5 seconds
 robot.displayText(name.upper(), 2.5)
 
@@ -49,13 +57,11 @@
 robot.led(0, 0, 255, 0.25)
 
 # Play a tone (Hz) for .5 seconds
-robot.buzz(440, 0.25)
+# robot.buzz(440, 0.25)
 
 # Move 30, 40, 60, 80, 100, -30, -40, -60, -80, -100 percentages for 0.5 seconds
 for x in [-100, -80, -60, 60, 80, 100]:
     # Move forward at x% speed for 0.5 seconds
     robot.move(x, -x, 0.25)
     robot.stop()
     robot.wait(0.25)
-
-robot.run()

demo/test_keybindings.py

@@ -0,0 +1,52 @@
+from weallcode_robot import Robot
+
+# Create a robot
+name = "WAC-2463"
+robot = Robot(name)
+
+robot.led(0,0,255,1)
+
+a = robot.set_key_binding('a').led(0, 0, 255, 1)
+b = robot.set_key_binding('b').led(255, 0, 0, 1)
+c = robot.set_key_binding('c').led(0, 255, 0, 1)
+
+w = robot.set_key_binding('w').move(100, 100).displayDots(
+    # fmt: off
+    [
+        0, 0, 1, 0, 0,
+        0, 0, 1, 0, 0,
+        0, 0, 1, 0, 0,
+        0, 1, 1, 1, 0,
+        0, 0, 1, 0, 0,
+    ]
+)
+a = robot.set_key_binding('a').move(100, 0).displayDots(
+    # fmt: off
+    [
+        0, 0, 0, 0, 0,
+        0, 0, 0, 1, 0,
+        1, 1, 1, 1, 1,
+        0, 0, 0, 1, 0,
+        0, 0, 0, 0, 0,
+    ]
+)
+s = robot.set_key_binding('d').move(0, 100).displayDots(
+    # fmt: off
+    [
+        0, 0, 0, 0, 0,
+        0, 1, 0, 0, 0,
+        1, 1, 1, 1, 1,
+        0, 1, 0, 0, 0,
+        0, 0, 0, 0, 0,
+    ]
+)
+d = robot.set_key_binding('s').move(-100, -100).displayDots(
+    # fmt: off
+    [
+        0, 0, 1, 0, 0,
+        0, 1, 1, 1, 0,
+        0, 0, 1, 0, 0,
+        0, 0, 1, 0, 0,
+        0, 0, 1, 0, 0,
+    ]
+)

demo/tk_play.py

@@ -0,0 +1,7 @@
+import tkinter as tk
+
+window = tk.Tk()
+window.title('')
+
+
+window.mainloop()

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "weallcode_robot"
-version = "3.0.2"
+version = "3.0.3"
 description = "Micro:bit TinyBit BLE Python Library"
 license = "MIT"
 authors = [
@@ -45,3 +45,4 @@ black = "^23.3.0"
 pre-commit = "^3.2.1"
 isort = "^5.12.0"
 ruff = "^0.0.260"
+textual = "^0.52.1"

weallcode_robot/commands.py

@@ -1,8 +1,93 @@
 import asyncio
 import logging
+from queue import Queue
 
 from bleak import BleakClient
 
+from .utils import copy_asyncio_queue, empty_asyncio_queue
+
+
+class CommandQueue():
+    def __init__(self, name: str):
+        self.name = name
+        
+        self.queue = asyncio.Queue(maxsize=100)
+        self._queue = None
+
+    def put(self, command):
+        if not self.queue.full():
+            self.queue.put_nowait(command)
+
+    async def get(self):
+        return await self.queue.get()
+    
+    def empty(self):
+        return self.queue.empty()
+    
+    def led(self, red, green, blue, duration: float = 0):
+        self.put(LEDCommand(red, green, blue))
+        self.wait(duration)
+        return self
+
+    def move(self, right, left, duration: float = 0):
+        self.put(MoveCommand(left, right))
+        self.wait(duration)
+        return self
+
+    def stop(self, duration: float = 0):
+        self.put(MoveCommand(0, 0))
+        self.wait(duration)
+        return self
+
+    def wait(self, duration: float):
+        if duration > 0:
+            self.put(WaitCommand(duration))
+        return self
+
+    def displayText(self, text: str, duration: float = 0):
+        self.put(DisplayTextCommand(text))
+        self.wait(duration)
+        return self
+
+    def displayDots(self, matrix: list[int], duration: float = 0):
+        self.put(DisplayDotMatrixCommand(matrix))
+        self.wait(duration)
+        return self
+
+    def clearDisplay(self):
+        self.put(DisplayDotMatrixCommand())
+        return self
+
+    def buzz(self, frequency: int, duration: float = 0.25):
+        self.put(BuzzerCommand(frequency))
+        self.wait(duration)
+        return self
+
+    async def clear_immediate(self):
+        await empty_asyncio_queue(self.queue)
+        self.clear()
+        return self
+    
+    def clear(self):
+        self.put(DisplayDotMatrixCommand())
+        self.put(MoveCommand(0, 0))
+        self.put(LEDCommand(0, 0, 0))
+        self.put(BuzzerCommand(0))
+        return self
+
+    async def save(self):
+        self._queue = await copy_asyncio_queue(self.queue)
+
+    def save_sync(self):
+        self._queue = self.queue
+
+    async def restore(self):
+        if self._queue:
+            self.queue = await copy_asyncio_queue(self._queue)
+
+    def restore_sync(self):
+        if self._queue:
+            self.queue = self._queue
 
 class RobotCommand:
     def __init__(self):