add preliminary support for Adafruit macropad (#3)

Author: dupontgu

fw/README.md

@@ -1,3 +1,4 @@
+### Check out the official project website [here](https://t9-library-generator.uk.r.appspot.com/)
 # Firmware
 This code _should_ run on any CircuitPython-enabled board, but is most useful when there is >= 4MB of flash.
 As of May 2021, it's only been tested on various RP2040 dev boards.
@@ -11,6 +12,7 @@ Currently supported boards:
 * [Pimoroni Tiny2040](./tiny2040)
 * [Raspberry Pi Pico](./pico)
 * [Adafruit QT Py RP2040](./qtpy2040)
+* [Adafruit MacroPad RP2040](./ada-macropad)
 
 There are also [`macos`](./macos)/[`win32`](./win32) folders, which contain mocked IO dependencies so that the firmware can be
 tested natively on desktop. *For key press detection on Mac, you'll need to give accessibility permissions to Python*.

fw/ada-macropad/README.md

@@ -0,0 +1,17 @@
+## Required (Circuit/Micro)Python Libraries:
+**MUST BE VERSION 7.0.0 OR NEWER!!!**
+**Make sure the following files are in a folder called `lib`, on your microcontroller**
+* adafruit_display_text
+    * `adafruit_display_text/__init__.mpy`
+    * `adafruit_display_text/bitmap_label.mpy`
+    * `adafruit_display_text/label.mpy`
+* adafruit_hid
+    * `adafruit_hid/__init__.mpy`
+    * `adafruit_hid/consumer_control_code.mpy`
+    * `adafruit_hid/consumer_control.mpy`
+    * `adafruit_hid/keyboard_layout_us.mpy`
+    * `adafruit_hid/keyboard.mpy`
+    * `adafruit_hid/keycode.mpy`
+    * `adafruit_hid/mouse.mpy`
+* `adafruit_simple_text_display.mpy`
+* `neopixel.mpy`

fw/ada-macropad/keyboard.py

@@ -0,0 +1,20 @@
+import usb_hid
+import adafruit_hid.keyboard
+from adafruit_hid.keyboard_layout_us import KeyboardLayoutUS
+import adafruit_hid.keycode
+
+class Keyboard():
+    def __init__(self):
+        self.keyboard = adafruit_hid.keyboard.Keyboard(usb_hid.devices)
+        self.keyboard_layout = KeyboardLayoutUS(self.keyboard)
+
+    def press(self, key):
+        self.keyboard.press(key)
+
+    def release_all(self):
+        self.keyboard.release_all()
+
+    def write(self, text):
+        self.keyboard_layout.write(text)
+
+Keycode = adafruit_hid.keycode.Keycode

fw/ada-macropad/led.py

@@ -0,0 +1,15 @@
+import board
+import neopixel
+
+class Led():
+    def __init__(self):
+        self.pixel = neopixel.NeoPixel(board.NEOPIXEL, 12)
+    
+    def show_red(self):
+        self.pixel.fill((150, 0, 0))
+
+    def show_green(self):
+        self.pixel.fill((0, 150, 0))
+
+    def show_blue(self):
+        self.pixel.fill((0, 0, 150))

fw/ada-macropad/library.t9l

@@ -0,0 +1,32 @@
+import board
+from adafruit_simple_text_display import SimpleTextDisplay
+
+class Display():
+    def __init__(self):
+        title=None
+        title_scale=1
+        title_length=80
+        text_scale=2
+        font=None
+        self._text_lines = SimpleTextDisplay(
+            title=title,
+            title_color=SimpleTextDisplay.WHITE,
+            title_scale=title_scale,
+            title_length=title_length,
+            text_scale=text_scale,
+            font=font,
+            colors=(SimpleTextDisplay.WHITE,),
+            display=board.DISPLAY,
+        )
+
+    def display_results(self, result, index):
+        arr = result.words if len(result.words) > 0 else result.pres
+        word_count = len(arr)
+        if word_count > 0:
+            # display can only display 2.5 lines
+            for i in range(0, max(3, word_count)):
+                adj_i = (i + index) % word_count
+                w = arr[adj_i]
+                # highlight the first line
+                self._text_lines[i].text = ">"+w+"<" if i == 0 else w
+        self._text_lines.show()

fw/ada-macropad/t9_display.py

@@ -0,0 +1,22 @@
+
+import board
+import keypad
+
+class Keypad():
+    def __init__(self, keys):
+        self._key_pins = [getattr(board, "KEY%d" % (num + 1)) for num in list(range(12))]
+        self._keys = keypad.Keys(self._key_pins, value_when_pressed=False, pull=True)
+        self._key_map = [item for sublist in list(keys) for item in sublist]
+        self._held_keys = []
+
+    @property
+    def pressed_keys(self):
+        current = self._keys.events.get()
+        while current is not None:
+            k = self._key_map[current.key_number]
+            if current.pressed and k not in self._held_keys:
+                self._held_keys.append(k)
+            elif current.released and k in self._held_keys:
+                self._held_keys.remove(k)
+            current = self._keys.events.get()
+        return self._held_keys

fw/ada-macropad/t9_keypad.py

@@ -1,8 +1,9 @@
 import time
 from led import Led
-from keypad import Keypad
+from t9_keypad import Keypad
 from keyboard import Keyboard
 from keyboard import Keycode
+from t9_display import Display
 
 NO_WORD = 0
 PARTIAL_WORD = 1
@@ -35,6 +36,8 @@
 keyboard = Keyboard()
 time.sleep(0.5) 
 
+display = Display()
+
 # Alternate macropad mode - map key input to function keys
 def run_macro_mode():
     macro_map = {
@@ -338,6 +341,7 @@ def poll_keys():
                 elif pres_count > 0:
                     word_index = (word_index + 1) % pres_count
                     submit(result.pres[word_index])
+                display.display_results(result, word_index)
                 continue
             # backspace, pop results stack
             if c == '1':
@@ -372,6 +376,7 @@ def poll_keys():
             # if we've run out of valid words/prefixes for a key sequence, just start appending the number
             elif c >= '2' and c <= '9':
                 emit_raw_text(c, False)
+            display.display_results(result, word_index)
             last_result = result
 
 

fw/core/code.py

@@ -0,0 +1,6 @@
+class Display():
+    def __init__(self):
+        pass
+
+    def display_results(self, result, index):
+        pass