This repository contains the prototype firmware of Chrumm. The new firmware is now included in the main repository.

Chrumm firmware

This is the firmware for the Chrumm keyboard prototype. It is implemented in the Arduino C++ dialect and can be compiled and installed with arduino-cli.

Setup

The command line examples are written for the Adafruit ItsyBitsy 32u4 5V 16MHz board, but it should be possible to adapt them to any other capable board. The third-party index URL for the ItsyBitsy is provided in the arduino-cli.yaml configuration file.

Update the index:

arduino-cli core update-index

Install the platform cores:

arduino-cli core install arduino:avr
arduino-cli core install adafruit:avr

Install the HID-Project library:

arduino-cli lib install HID-Project

Compile

Compile the firmware:

arduino-cli compile --fqbn adafruit:avr:itsybitsy32u4_5V chrumm

Upload to board (adjust the port if necessary):

arduino-cli upload --fqbn adafruit:avr:itsybitsy32u4_5V --port /dev/ttyACM0 chrumm

On Linux, I had to add the current user to the dialout group to get permission for the upload. I also had to uninstall modemmanager, because it interfered with the connection.