python: Enable packaging via hatch

```
> cd python

> python3 -m build
> ls -1 dist
framework16_inputmodule-0.1.0-py3-none-any.whl
framework16_inputmodule-0.1.0.tar.gz

mkdir temp && temp
python3 -m venv venv
source venv/bin/activate

> python3 -m pip install ../dist/framework16_inputmodule-0.1.0.tar.gz

> inputmodulectl

> inputmodulegui
```

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

Author: JohnAZoidberg

.gitignore

@@ -21,6 +21,9 @@ message.bin
 # Python
 __pycache__
 
+# Hatch
+_version.py
+
 # pyinstaller
 build/
 dist/

python/README.md

@@ -0,0 +1,197 @@
+# Framework Laptop 16 - Input Module Firmware/Software
+
+This repository contains both the firmware for the Framework Laptop 16 input modules,
+as well as the tool to control them.
+
+Rust firmware project setup based off of: https://github.com/rp-rs/rp2040-project-template
+
+## Modules
+
+See pages of the individual modules for details about how they work and how
+they're controlled.
+
+- [LED Matrix](ledmatrix/README.md)
+- [Minimal C1 Input Module](c1minimal/README.md)
+- [2nd Display](b1display/README.md)
+- [QT PY RP2040](qtpy/README.md)
+
+## Generic Features
+
+All modules are built with an RP2040 microcontroller
+Features that all modules share
+
+- Firmware written in bare-metal Rust
+- Reset into RP2040 bootloader when firmware crashes/panics
+- Sleep Mode to save power
+- API over USB ACM Serial Port - Requires no Drivers on Windows and Linux
+  - Go to sleep
+  - Reset into bootloader
+  - Control and read module state (brightness, displayed image, ...)
+
+## Control from the host
+
+To build your own application see the: [API command documentation](commands.md)
+
+Or use our `inputmodule-control` app, which you can download from the latest
+[GH Actions](https://github.com/FrameworkComputer/led_matrix_fw/actions) run or
+the [release page](https://github.com/FrameworkComputer/led_matrix_fw/releases).
+Optionally there are is also a [Python script](python.md).
+
+For device specific commands, see their individual documentation pages.
+
+###### Permissions on Linux
+To ensure that the input module's port is accessible, install the `udev` rule and trigger a reload:
+
+```
+sudo cp release/50-framework-inputmodule.rules /etc/udev/rules.d/
+sudo udevadm control --reload && sudo udevadm trigger
+```
+
+##### Common commands:
+
+###### Listing available devices
+
+```sh
+> inputmodule-control --list
+/dev/ttyACM0
+  VID     0x32AC
+  PID     0x0020
+  SN      FRAKDEAM0020110001
+  Product LED_Matrix
+/dev/ttyACM1
+  VID     0x32AC
+  PID     0x0021
+  SN      FRAKDEAM0000000000
+  Product B1_Display
+```
+
+###### Apply command to single device
+
+By default a command will be sent to all devices that can be found, to apply it
+to a single device, specify the COM port.
+In this example the command is targeted at `b1-display`, so it will only apply
+to this module type.
+
+```
+# Example on Linux
+> inputmodule-control --serial-dev /dev/ttyACM0 b1-display --pattern black
+
+# Example on Windows
+> inputmodule-control.exe --serial-dev COM5 b1-display --pattern black
+```
+
+###### Send command when device connects
+
+By default the app tries to connect with the device and aborts if it can't
+connect. But you might want to start the app, have it wait until the device is
+connected and then send the command.
+
+```
+> inputmodule-control b1-display --pattern black
+Failed to find serial devivce. Please manually specify with --serial-dev
+
+# No failure, waits until the device is connected, sends command and exits
+> inputmodule-control --wait-for-device b1-display --pattern black
+
+# If the device is already connected, it does nothing, just wait 1s.
+# This means you can run this command by a system service and restart it when
+# it finishes. Then it will only ever do anything if the device reconnects.
+> inputmodule-control --wait-for-device b1-display --pattern black
+Device already present. No need to wait. Not executing command.
+```
+
+## Update the Firmware
+
+First, put the module into bootloader mode.
+
+This can be done either by pressing the bootsel button while plugging it in or
+by using one of the following commands: 
+
+```sh
+inputmodule-control led-matrix --bootloader
+inputmodule-control b1-display --bootloader
+inputmodule-control c1-minimal --bootloader
+```
+
+Then the module will present itself in the same way as a USB thumb drive.
+Copy the UF2 firmware file onto it and the device will flash and reset automatically.
+Alternatively when building from source, run one of the following commands:
+
+```sh
+cargo run -p ledmatrix
+cargo run -p b1display
+cargo run -p c1minimal
+```
+
+## Building the firmware
+
+Dependencies: Rust
+
+Prepare Rust toolchain (once):
+
+```sh
+rustup target install thumbv6m-none-eabi
+cargo install flip-link
+```
+
+Build:
+
+```sh
+cargo make --cwd ledmatrix
+cargo make --cwd b1display
+cargo make --cwd c1minimal
+```
+
+Generate the UF2 update file:
+
+```sh
+cargo make --cwd ledmatrix uf2
+cargo make --cwd b1display uf2
+cargo make --cwd c1minimal uf2
+```
+
+## Building the Application
+
+Dependencies: Rust, pkg-config, libudev
+
+Currently have to specify the build target because it's not possible to specify a per package build target.
+Tracking issue: https://github.com/rust-lang/cargo/issues/9406
+
+```
+# Build it
+> cargo make --cwd inputmodule-control
+
+# Build and run it, showing the tool version
+> cargo make --cwd inputmodule-control run -- --version
+```
+
+### Check the firmware version of the device
+
+###### In-band using commandline
+
+```sh
+> inputmodule-control b1-display --version
+Device Version: 0.1.3
+```
+
+###### By looking at the USB descriptor
+
+On Linux:
+
+```sh
+> lsusb -d 32ac: -v 2> /dev/null | grep -P 'ID 32ac|bcdDevice'
+Bus 003 Device 078: ID 32ac:0021 Framework Laptop 16 B1 Display
+  bcdDevice            0.10
+```
+
+## Rust Panic
+
+When the Rust code panics, the RP2040 resets itself into bootloader mode.
+This means a new firmware can be written to overwrite the old one.
+
+Additionally the panic message is written to XIP RAM, which can be read with [picotool](https://github.com/raspberrypi/picotool):
+
+```sh
+sudo picotool save -r 0x15000000 0x15004000 message.bin
+strings message.bin | head
+```

python/framework16_inputmodules/ledmatrix_control.py renamed to python/framework16_inputmodules/cli.py

@@ -6,8 +6,8 @@
 from serial.tools import list_ports
 
 # Local dependencies
-import gui
-from inputmodule import (
+from framework16_inputmodules import gui
+from framework16_inputmodules.inputmodule import (
     INPUTMODULE_PIDS,
     send_command,
     get_version,
@@ -18,15 +18,15 @@
     GameOfLifeStartParam,
     GameControlVal,
 )
-from gui.games import (
+from framework16_inputmodules.gui.games import (
     snake,
     snake_embedded,
     pong_embedded,
     game_of_life_embedded,
     wpm_demo,
 )
-from gui.ledmatrix import random_eq, clock, blinking
-from inputmodule.ledmatrix import (
+from framework16_inputmodules.gui.ledmatrix import random_eq, clock, blinking
+from framework16_inputmodules.inputmodule.ledmatrix import (
     eq,
     breathing,
     camera,
@@ -44,7 +44,7 @@
     image_bl,
     image_greyscale,
 )
-from inputmodule.b1display import (
+from framework16_inputmodules.inputmodule.b1display import (
     b1image_bl,
     invert_screen_cmd,
     screen_saver_cmd,
@@ -56,14 +56,18 @@
     display_on_cmd,
     display_string,
 )
-from inputmodule.c1minimal import set_color, get_color, RGB_COLORS
+from framework16_inputmodules.inputmodule.c1minimal import (
+    set_color,
+    get_color,
+    RGB_COLORS,
+)
 
 # Optional dependencies:
 # from PIL import Image
 # import PySimpleGUI as sg
 
 
-def main():
+def main_cli():
     parser = argparse.ArgumentParser()
     parser.add_argument(
         "-l", "--list", help="List all compatible devices", action="store_true"
@@ -387,5 +391,11 @@ def print_devs(ports):
         print(f"  Product: {port.product}")
 
 
+def main_gui():
+    devices = find_devs()  # show=False, verbose=False)
+    print("Found {} devices".format(len(devices)))
+    gui.run_gui(devices)
+
+
 if __name__ == "__main__":
-    main()
+    main_cli()

python/framework16_inputmodules/gui/__init__.py

@@ -4,18 +4,18 @@
 
 import PySimpleGUI as sg
 
-from inputmodule import (
+from framework16_inputmodules.inputmodule import (
     send_command,
     get_version,
     brightness,
     get_brightness,
     bootloader,
     CommandVals,
 )
-from gui.games import snake
-from gui.ledmatrix import countdown, random_eq, clock
-from gui.gui_threading import stop_thread, is_dev_disconnected
-from inputmodule.ledmatrix import (
+from framework16_inputmodules.gui.games import snake
+from framework16_inputmodules.gui.ledmatrix import countdown, random_eq, clock
+from framework16_inputmodules.gui.gui_threading import stop_thread, is_dev_disconnected
+from framework16_inputmodules.inputmodule.ledmatrix import (
     percentage,
     pattern,
     animate,

python/framework16_inputmodules/gui/games.py

@@ -4,8 +4,18 @@
 import time
 import threading
 
-from inputmodule import GameControlVal, send_command, CommandVals, Game
-from inputmodule.ledmatrix import show_string, WIDTH, HEIGHT, render_matrix
+from framework16_inputmodules.inputmodule import (
+    GameControlVal,
+    send_command,
+    CommandVals,
+    Game,
+)
+from framework16_inputmodules.inputmodule.ledmatrix import (
+    show_string,
+    WIDTH,
+    HEIGHT,
+    render_matrix,
+)
 
 # Constants
 ARG_UP = 0

python/framework16_inputmodules/gui/ledmatrix.py

@@ -2,9 +2,18 @@
 import time
 import random
 
-from gui.gui_threading import reset_thread, is_thread_stopped, is_dev_disconnected
-from inputmodule.ledmatrix import light_leds, show_string, eq, breathing
-from inputmodule import brightness
+from framework16_inputmodules.gui.gui_threading import (
+    reset_thread,
+    is_thread_stopped,
+    is_dev_disconnected,
+)
+from framework16_inputmodules.inputmodule.ledmatrix import (
+    light_leds,
+    show_string,
+    eq,
+    breathing,
+)
+from framework16_inputmodules.inputmodule import brightness
 
 
 def countdown(dev, seconds):

python/framework16_inputmodules/inputmodule/__init__.py

@@ -2,7 +2,7 @@
 import serial
 
 # TODO: Make independent from GUI
-from gui.gui_threading import disconnect_dev
+from framework16_inputmodules.gui.gui_threading import disconnect_dev
 
 FWK_MAGIC = [0x32, 0xAC]
 FWK_VID = 0x32AC

python/framework16_inputmodules/inputmodule/b1display.py

@@ -1,6 +1,6 @@
 import sys
 
-from inputmodule import send_command, CommandVals, FWK_MAGIC
+from framework16_inputmodules.inputmodule import send_command, CommandVals, FWK_MAGIC
 
 B1_WIDTH = 300
 B1_HEIGHT = 400

python/framework16_inputmodules/inputmodule/c1minimal.py

@@ -1,4 +1,4 @@
-from inputmodule import send_command, CommandVals
+from framework16_inputmodules.inputmodule import send_command, CommandVals
 
 RGB_COLORS = ["white", "black", "red", "green", "blue", "cyan", "yellow", "purple"]
 

python/framework16_inputmodules/inputmodule/ledmatrix.py

@@ -2,8 +2,8 @@
 
 import serial
 
-import font
-from inputmodule import (
+from framework16_inputmodules import font
+from framework16_inputmodules.inputmodule import (
     send_command,
     CommandVals,
     PatternVals,