Initial commit

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

Author: JohnAZoidberg

LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Framework Computer Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,46 @@
+# CircuitPython Scripts for Framework 16 Input Modules
+
+This is not the official firmware for the Framework 16 Input Modules.
+But we want to make it as easy as possible to hack on the modules. As an alternative firmware for playing around, you can use circuitpython to easily write some scripts and run them in the firmware.
+
+Going back to official firmware is as easy as triggering the bootloader mode and copying the official UF2 files on the RP2 drive.
+
+## Preparation
+
+Not supported in upstream CircuitPython yet.
+Clone from the [pull request](https://github.com/adafruit/circuitpython/pull/8233).
+
+Follow the official [build guide](https://learn.adafruit.com/building-circuitpython).
+Once your environment is set up you can compile with:
+
+```sh
+cd ports/raspberrypi
+make BOARD=fwk_keyboard
+
+# Use firmware at build-fwk_keyboard/firmware.uf2
+```
+
+Flash the firmware once and you're good to go.
+
+To go back to Framework official firmware
+
+## Support
+
+- Any Module
+  - [x] Jump to bootloader: `bootloader_jump.py`
+- Any keyboard
+  - [ ] Scan keys
+  - [ ] Example
+- White Backlight Keyboard
+  - [x] Control Backlight
+  - [x] Control Capslock LED
+  - [x] Example: `white_keyboard_blink.py`
+- RGB Keyboard
+  - [ ] Control RGB Backlight
+  - [ ] Example
+- RGB Macropad
+  - [ ] Control RGB Backlight
+  - [ ] Example
+- LED Matrix
+  - [ ] Control LED Matrix
+  - [ ] Example WIP: `led_matrix.py`

bootloader_jump.py

@@ -0,0 +1,4 @@
+# Jump to the bootloader to flash new UF2 firmware
+import microcontroller
+microcontroller.on_next_reset(microcontroller.RunMode.UF2)
+microcontroller.reset()

led_matrix.py

@@ -0,0 +1,18 @@
+import board
+import busio
+import digitalio
+
+# Enable LED Matrix Controller
+sdb = digitalio.DigitalInOut(board.GP29)
+sdb.direction = digitalio.Direction.OUTPUT
+sdb.value = True
+
+from adafruit_is31fl3731 import IS31FL3731
+i2c = busio.I2C(board.SCL, board.SDA)
+i2c.try_lock()
+print('\n i2c scan: ' + str(i2c.scan()))
+i2c.unlock()
+
+# TODO: Doesn't seem to work yet
+display = IS31FL3731(i2c, address=0x20)
+display.fill(250)

white_keyboard_blink.py

@@ -0,0 +1,20 @@
+import time
+import board
+import busio
+import digitalio
+import pwmio
+
+capslock = digitalio.DigitalInOut(board.GP24)
+capslock.direction = digitalio.Direction.OUTPUT
+
+backlight = pwmio.PWMOut(board.GP25, frequency=5000, duty_cycle=0)
+
+# Blink capslock LED and backlight
+while True:
+    capslock.value = True
+    backlight.duty_cycle = int(65535 / 2) # 50% brightness
+    time.sleep(1)
+
+    capslock.value = False
+    backlight.duty_cycle = 0
+    time.sleep(1)