Merge pull request #17 from relic-se/keyboard

Keyboard Navigation

Author: relic-se

code.py

@@ -154,7 +154,7 @@ def download_zip(url: str, name: str|None = None) -> str:
 fg_palette[0] = config.palette_fg if config is not None else 0xffffff
 
 # setup display
-displayio.release_displays()
+#displayio.release_displays()
 try:
     adafruit_fruitjam.peripherals.request_display_config()  # user display configuration
 except ValueError:  # invalid user config or no user config provided
@@ -194,6 +194,8 @@ def download_zip(url: str, name: str|None = None) -> str:
 STATUS_HEIGHT = 16
 STATUS_PADDING = 4
 
+HELP_MARGIN = 1
+
 MENU_HEIGHT = 24
 MENU_GAP = 8
 
@@ -314,6 +316,16 @@ def selected(self, value: bool) -> None:
 )
 status_group.append(page_label)
 
+# add keyboard navigation help
+help_label = Label(
+    font=FONT,
+    text="[Arrow]: Move [Enter]: Select [1-9]: Category",
+    color=(config.palette_fg if config is not None else 0xffffff),
+    anchor_point=(0, 1.0),
+    anchored_position=(STATUS_PADDING, display.height - STATUS_HEIGHT - HELP_MARGIN)
+)
+root_group.append(help_label)
+
 def log(msg: str) -> None:
     status_label.text = msg
     print(msg)
@@ -527,6 +539,7 @@ def show_dialog(content: str, actions: list = None) -> None:
                 width=button_width,
                 **BUTTON_PROPS,
             ))
+        dialog_buttons[0].selected = True  # initial selection
 
     # hide other UI elements
     category_group.hidden = True
@@ -812,9 +825,12 @@ def open_application(full_name: str = None) -> None:
         supervisor.reload()
 
 selected_application = None
-def select_application(index: int) -> None:
+def select_application(index: int|tuple) -> None:
     global selected_category, current_page, selected_application
 
+    if isinstance(index, tuple):
+        index = index[1] * PAGE_COLUMNS + index[0]
+
     index += current_page * PAGE_SIZE
     if index < 0 or index >= len(applications[selected_category]):
         return
@@ -888,6 +904,65 @@ def toggle_application(full_name: str = None) -> bool:
 
     return result
 
+# item selection
+
+selected_item = None
+
+def set_selected_item_color(value: bool, item: tuple|AnchoredTileGrid|None = None) -> None:
+    if item is None:
+        item = selected_item
+    if item is not None:
+        if isinstance(item, tuple):
+            item_grid.get_content(item)[2].background_color = (config.palette_accent if config is not None else 0x008800) if value else None
+        elif isinstance(item, AnchoredTileGrid):
+            item.pixel_shader[2] = (config.palette_accent if config is not None else 0x008800) if value else original_arrow_btn_color
+
+def select_item(value: tuple|AnchoredTileGrid|None) -> None:
+    global selected_item
+    set_selected_item_color(False)  # reset selected state on previous item
+    selected_item = value  # assign selected
+    set_selected_item_color(True)  # set selected state on current item
+
+def change_selected_item(dx: int, dy: int) -> bool:
+    if (dx == 0 and dy == 0) or (dx != 0 and dy != 0) or abs(dx) > 1 or abs(dy) > 1:  # only change 1 axis by 1
+        return
+
+    # previous value
+    value = selected_item
+    if value is left_arrow:
+        value = (-1, 0)
+    elif value is right_arrow:
+        value = (PAGE_COLUMNS, 0)
+    elif value is None:
+        # initial value
+        value = (
+            ((PAGE_COLUMNS + 1) * (dx < 0) - 1) if dx != 0 else 0,
+            ((PAGE_ROWS + 1) * (dy < 0) - 1) if dy != 0 else 0
+        )
+    
+    while True:
+        # apply delta
+        value = (
+            ((value[0] + dx + 1) % (PAGE_COLUMNS + 2)) - 1, # allow -1 and PAGE_COLUMNS
+            (value[1] + dy) % PAGE_ROWS
+        )
+
+        # check visibility
+        if value[0] < 0:
+            if not left_arrow.hidden:
+                value = left_arrow
+                break
+        elif value[0] >= PAGE_COLUMNS:
+            if not right_arrow.hidden:
+                value = right_arrow
+                break
+        elif not item_grid.get_content(value).hidden:
+            break
+
+    select_item(value)
+
+select_item((0, 0))  # initial selection
+
 # mouse control
 mouse = None
 if config is not None and config.use_mouse and (mouse := adafruit_usb_host_mouse.find_and_init_boot_mouse()) is not None:
@@ -909,23 +984,79 @@ def atexit_callback() -> None:
     sys.stdin.read(1)
 
 # control loop
+def str_unshift(value: str, data: str = "", count: int = 1) -> tuple:
+    if len(value) < count:
+        return None, value
+    return data + value[:count], value[count:]
+
+def key_unshift(buffer: str) -> tuple:
+    key, buffer = str_unshift(buffer)
+    if key is None:
+        return None, buffer
+    if key == "\x1b" and buffer and buffer[0] == "[":
+        key, buffer = str_unshift(buffer, key, 2)
+    return key, buffer
+
 try:
     previous_mouse_state = False
     while True:
 
         # keyboard input
         if (available := supervisor.runtime.serial_bytes_available) > 0:
-            key = sys.stdin.read(available)
-            if key == "\x1b":  # escape
-                reset()
+            buffer = sys.stdin.read(available)
+            while True:
+                key, buffer = key_unshift(buffer)
+                if key is None:
+                    break
+
+                if dialog_buttons.hidden:
+                    if key == "\x1b":  # escape
+                        reset()
+                    elif key == "\x1b[A":  # up
+                        change_selected_item(0, -1)
+                    elif key == "\x1b[B":  # down
+                        change_selected_item(0, 1)
+                    elif key == "\x1b[C":  # right
+                        change_selected_item(1, 0)
+                    elif key == "\x1b[D":  # left
+                        change_selected_item(-1, 0)
+                    elif key == "\n":  # enter
+                        if selected_item is right_arrow:
+                            next_page()
+                        elif selected_item is left_arrow:
+                            previous_page()
+                        elif isinstance(selected_item, tuple):
+                            select_application(selected_item)
+                    elif key in "1234567890":
+                        key = (int(key) - 1) % 11  # map from 0 to 10 (inclusive)
+                        if key < len(categories):
+                            select_category(categories[key])
+                else:
+                    if key == "\x1b":  # escape
+                        deselect_application()
+                    elif key == "\x1b[C" or key == "\x1b[D":  # right or left
+                        dx = (ord("C") - ord(key[2])) * 2 + 1
+                        try:
+                            i = next((i for i, x in enumerate(dialog_buttons) if x.selected))
+                        except StopIteration:
+                            i = len(dialog_buttons) - 1 if dx > 0 else 0
+                        dialog_buttons[i].selected = False
+                        dialog_buttons[(i + dx) % len(dialog_buttons)].selected = True
+                    elif key == "\n":  # enter
+                        try:
+                            button = next((x for x in dialog_buttons if x.selected))
+                        except StopIteration:
+                            pass
+                        else:
+                            button.click()
 
         # mouse input
         if mouse is not None and mouse.update() is not None:
             mouse_state = "left" in mouse.pressed_btns
             if mouse_state and not previous_mouse_state:
                 if dialog_buttons.hidden:
                     if (clicked_cell := item_grid.which_cell_contains((mouse.x * SCALE, mouse.y * SCALE))) is not None:
-                        select_application(clicked_cell[1] * PAGE_COLUMNS + clicked_cell[0])
+                        select_application(clicked_cell)
                     elif not right_arrow.hidden and right_arrow.contains((mouse.x, mouse.y, 0)):
                         next_page()
                     elif not left_arrow.hidden and left_arrow.contains((mouse.x, mouse.y, 0)):