python: Implement firmware update

Signed-off-by: Daniel Schaefer <dhs@frame.work>

Author: JohnAZoidberg

.github/workflows/software.yml

@@ -105,6 +105,12 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
+    - name: Download releases to bundle
+      run: |
+        mkdir releases
+        mkdir releases\0.2.0
+        Invoke-WebRequest -Uri https://github.com/FrameworkComputer/inputmodule-rs/releases/download/v0.2.0/ledmatrix.uf2  -OutFile releases\0.2.0\ledmatrix.uf2
+
     - name: Create Executable
       uses: Martin005/pyinstaller-action@main
       with:

python/inputmodule/cli.py

@@ -14,7 +14,7 @@
     brightness,
     get_brightness,
     CommandVals,
-    bootloader,
+    bootloader_jump,
     GameOfLifeStartParam,
     GameControlVal,
 )
@@ -272,7 +272,7 @@ def main_cli():
         sys.exit(1)
 
     if args.bootloader:
-        bootloader(dev)
+        bootloader_jump(dev)
     elif args.sleep is not None:
         send_command(dev, CommandVals.Sleep, [args.sleep])
     elif args.is_sleeping:
@@ -394,6 +394,7 @@ def find_devs():
 def print_devs(ports):
     for port in ports:
         print(f"{port.device}")
+        print(f"  {port.name}")
         print(f"  VID:     0x{port.vid:04X}")
         print(f"  PID:     0x{port.pid:04X}")
         print(f"  SN:      {port.serial_number}")

python/inputmodule/firmware_update.py

@@ -0,0 +1,80 @@
+import os
+import time
+
+from inputmodule.inputmodule import bootloader_jump
+from inputmodule import uf2conv
+
+def dev_to_str(dev):
+    return dev.name
+
+def flash_firmware(dev, fw_path):
+    print(f"Flashing {fw_path} onto {dev_to_str(dev)}")
+
+    # First jump to bootloader
+    drives = uf2conv.list_drives()
+    if not drives:
+        print("Jump to bootloader")
+        bootloader_jump(dev)
+
+    timeout = 10  # 5s
+    while not drives:
+        if timeout == 0:
+            print("Failed to find device in bootloader")
+            # TODO: Handle return value
+            return False
+        # Wait for it to appear
+        time.sleep(0.5)
+        timeout -= 1
+        drives = uf2conv.get_drives()
+
+
+    if len(drives) == 0:
+        print("No drive to deploy.")
+        return False
+
+    # Firmware is pretty small, can just fit it all into memory
+    with open(fw_path, 'rb') as f:
+        fw_buf = f.read()
+
+    for d in drives:
+        print("Flashing {} ({})".format(d, uf2conv.board_id(d)))
+        uf2conv.write_file(d + "/NEW.UF2", fw_buf)
+
+    print("Flashing finished")
+
+# Example return value
+# {
+#   '0.1.7': {
+#     'ansi': 'framework_ansi_default_v0.1.7.uf2',
+#     'gridpad': 'framework_gridpad_default_v0.1.7.uf2'
+#   },
+#   '0.1.8': {
+#     'ansi': 'framework_ansi_default.uf2',
+#     'gridpad': 'framework_gridpad_default.uf2',
+#   }
+# }
+def find_releases(res_path, filename_format):
+    from os import listdir
+    from os.path import isfile, join
+    import re
+
+    releases = {}
+    try:
+        versions = listdir(os.path.join(res_path, "releases"))
+    except FileNotFoundError:
+        return releases
+
+    for version in versions:
+        path = join(res_path, "releases", version)
+        releases[version] = {}
+        for filename in listdir(path):
+            if not isfile(join(path, filename)):
+                continue
+            type_search = re.search(filename_format, filename)
+            if not type_search:
+                print(f"Filename '{filename}' not matching patten!")
+                sys.exit(1)
+                continue
+            fw_type = type_search.group(1)
+            releases[version][fw_type] = os.path.join(res_path, "releases", version, filename)
+    return releases

python/inputmodule/gui/__init__.py

@@ -5,12 +5,13 @@
 import tkinter as tk
 from tkinter import ttk, messagebox
 
+from inputmodule import firmware_update
 from inputmodule.inputmodule import (
     send_command,
     get_version,
     brightness,
     get_brightness,
-    bootloader,
+    bootloader_jump,
     CommandVals,
     Game,
     GameControlVal
@@ -54,10 +55,12 @@ def run_gui(devices):
     tab1 = ttk.Frame(tabControl)
     tab_games = ttk.Frame(tabControl)
     tab2 = ttk.Frame(tabControl)
+    tab_fw = ttk.Frame(tabControl)
     tab3 = ttk.Frame(tabControl)
     tabControl.add(tab1, text="Home")
     tabControl.add(tab_games, text="Games")
     tabControl.add(tab2, text="Dynamic Controls")
+    tabControl.add(tab_fw, text="Firmware Update")
     tabControl.add(tab3, text="Advanced")
     tabControl.pack(expand=1, fill="both")
 
@@ -75,7 +78,7 @@ def run_gui(devices):
         checkbox_var = tk.BooleanVar(value=True)
         checkbox = ttk.Checkbutton(detected_devices_frame, text=device_info, variable=checkbox_var, style="TCheckbutton")
         checkbox.pack(anchor="w")
-        device_checkboxes[dev.name] = checkbox_var
+        device_checkboxes[dev.name] = (checkbox_var, checkbox)
 
     # Brightness Slider
     brightness_frame = ttk.LabelFrame(tab1, text="Brightness", style="TLabelframe")
@@ -160,6 +163,26 @@ def run_gui(devices):
     symbols_frame.pack(fill="x", padx=10, pady=5)
     ttk.Button(symbols_frame, text="Send '2 5 degC thunder'", command=lambda: send_symbols(devices), style="TButton").pack(side="left", padx=5, pady=5)
 
+    # Firmware Update
+    bootloader_frame = ttk.LabelFrame(tab_fw, text="Bootloader", style="TLabelframe")
+    bootloader_frame.pack(fill="x", padx=10, pady=5)
+    ttk.Button(bootloader_frame, text="Enter Bootloader", command=lambda: perform_action(devices, "bootloader"), style="TButton").pack(side="left", padx=5, pady=5)
+
+    bundled_fw_frame = ttk.LabelFrame(tab_fw, text="Bundled Updates", style="TLabelframe")
+    bundled_fw_frame.pack(fill="x", padx=10, pady=5)
+    releases = firmware_update.find_releases(resource_path(), r'(ledmatrix).uf2')
+    if not releases:
+        tk.Label(bundled_fw_frame, text="Cannot find firmware updates").pack(side="top", padx=5, pady=5)
+    else:
+        versions = sorted(list(releases.keys()), reverse=True)
+
+        #tk.Label(fw_update_frame, text="Ignore user configured keymap").pack(side="top", padx=5, pady=5)
+        fw_ver_combo = ttk.Combobox(bundled_fw_frame, values=versions, style="TCombobox", state="readonly")
+        fw_ver_combo.pack(side=tk.LEFT, padx=5, pady=5)
+        fw_ver_combo.current(0)
+        flash_btn = ttk.Button(bundled_fw_frame, text="Update", command=lambda: tk_flash_firmware(devices, releases, fw_ver_combo.get(), 'ledmatrix'), style="TButton")
+        flash_btn.pack(side="left", padx=5, pady=5)
+
     # PWM Frequency Combo Box
     pwm_freq_frame = ttk.LabelFrame(tab3, text="PWM Frequency", style="TLabelframe")
     pwm_freq_frame.pack(fill="x", padx=10, pady=5)
@@ -177,7 +200,6 @@ def run_gui(devices):
     device_control_frame = ttk.LabelFrame(tab1, text="Device Control", style="TLabelframe")
     device_control_frame.pack(fill="x", padx=10, pady=5)
     control_buttons = {
-        "Bootloader": "bootloader",
         "Sleep": "sleep",
         "Wake": "wake"
     }
@@ -194,8 +216,12 @@ def perform_action(devices, action):
     if action in action_map:
         threading.Thread(target=action_map[action], args=(devices,), daemon=True).start(),
 
+    if action == "bootloader":
+        disable_devices(devices)
+        restart_hint()
+
     action_map = {
-        "bootloader": bootloader,
+        "bootloader": bootloader_jump,
         "sleep": lambda dev: send_command(dev, CommandVals.Sleep, [True]),
         "wake": lambda dev: send_command(dev, CommandVals.Sleep, [False]),
         "start_animation": lambda dev: animate(dev, True),
@@ -263,14 +289,47 @@ def set_pwm_freq(devices, freq):
         pwm_freq(dev, freq)
 
 def get_selected_devices(devices):
-    return [dev for dev in devices if dev.name in device_checkboxes and device_checkboxes[dev.name].get()]
+    return [dev for dev in devices if dev.name in device_checkboxes and device_checkboxes[dev.name][0].get()]
 
 def resource_path():
     """Get absolute path to resource, works for dev and for PyInstaller"""
     try:
         # PyInstaller creates a temp folder and stores path in _MEIPASS
         base_path = sys._MEIPASS
     except Exception:
-        base_path = os.path.abspath("../../")
+        base_path = os.path.abspath(".")
 
     return base_path
+
+def info_popup(msg):
+    parent = tk.Tk()
+    parent.title("Info")
+    message = tk.Message(parent, text=msg, width=800)
+    message.pack(padx=20, pady=20)
+    parent.mainloop()
+
+def tk_flash_firmware(devices, releases, version, fw_type):
+    selected_devices = get_selected_devices(devices)
+    if len(selected_devices) != 1:
+        info_popup('To flash select exactly 1 device.')
+        return
+    dev = selected_devices[0]
+    firmware_update.flash_firmware(dev, releases[version][fw_type])
+    # Disable device that we just flashed
+    disable_devices(devices)
+    restart_hint()
+
+def restart_hint():
+    parent = tk.Tk()
+    parent.title("Restart Application")
+    message = tk.Message(parent, text="After updating a device,\n restart the application to reload the connections.", width=800)
+    message.pack(padx=20, pady=20)
+    parent.mainloop()
+
+def disable_devices(devices):
+    # Disable checkbox of selected devices
+    for dev in devices:
+        for name, (checkbox_var, checkbox) in device_checkboxes.items():
+            if name == dev.name:
+                checkbox_var.set(False)
+                checkbox.config(state=tk.DISABLED)

python/inputmodule/inputmodule/__init__.py

@@ -90,7 +90,7 @@ class GameControlVal(IntEnum):
 RESPONSE_SIZE = 32
 
 
-def bootloader(dev):
+def bootloader_jump(dev):
     """Reboot into the bootloader to flash new firmware"""
     send_command(dev, CommandVals.BootloaderReset, [0x00])