/zkb

Primary LanguageC

zkb

WIP. keyboard firmware for Nordic Semiconductor nRF52840 MCU, specifically the nice!nano board.

setup

  1. Download the Nordic SDK from here. Version requirements are currently unknown, but 17.0.2 is known to work
  2. Extract the downloaded SDK to sdk/, and modify SDK_PATH in the Makefile accordingly
  3. Install the arm-none-eabi toolchain (including binutils and gcc), from here
  4. Ensure that the downloaded toolchain is either (a) in your $PATH (eg. as arm-none-eabi-gcc), or modify the variables in the Makefile accordingly
  5. Download adafruit-nrfutil from here (or install via pip

The final folder structure should look something like this:

zkb/
  |- kernel/
  |- sdk/
     |- nrf-sdk-17.0.2/
        |- components
        |- config
        |- ...

building

Just make will build a hex file, as well as a DFU .zip package for flashing in build/

flashing

  1. Place the board into DFU mode (double-tap reset)
  2. Figure out the path to the device (should be somewhere under /dev/)
  3. Run make flash DEVICE_PATH=/dev/path-to-device