Skip to content

Latest commit

 

History

History
107 lines (72 loc) · 3.19 KB

readme.md

File metadata and controls

107 lines (72 loc) · 3.19 KB
Raw

fl3pp moonlander firmware

This repository contains custom firmware for the ZSA Moonlander keyboard.

There once was a more elaborate setup in place, including a custom QMK abstraction as well as custom implemented features and a test infrastructure. This was removed for the sake of simplicity. You can still find the source code under the git tag unicode.

Prerequisites

To run:

  • WinCompose to enter Unicode code-points. Set the compose key to F13 (in %appdata%\WinCompose\settings.ini -> [composing]compose_key=VK.F13)

To compile & flash:

  • The Make build tool

  • The Wally flashing tool

  • The QMK MSYS development environment (set environment variable QMK_HOME to path of installation)

  • ZSA's fork of the QMK firmware (check current release branch)

git clone --recurse-submodules --branch firmware23 https://github.com/zsa/qmk_firmware zsa_qmk_firmware

Makefile and MSYS

There is a Makefile setup which automates many of the building steps. It automatically redirects all commands to the MSYS environment for Windows.

Following make targets have been setup:

  • make build: Builds the keymap
  • make flash: Builds and flashes the firmware on the keyboard. In order for this command to work, you must first set your keyboard in reset-mode (RESET in keymap.c)
  • make setup: Configure QMK to use this repository
  • make clean: Remove keymap binary
  • make console: Start the QMK debug console
  • make all: Compile keymap

There also is a msys.cmd file available, which allows you to either execute commands directly in the MSYS environment or start an interactive shell if executed without additional process arguments.

Environment Setup

  1. Install and configure the prerequisites

  2. Clone your keymap code into keyboards/moonlander/keymaps/<layout>

git clone [email protected]:fl3pp/moonlander_firmware.git /c/dev/qmk/zsa_qmk_firmware/keyboards/moonlander/keymaps/fl3pp
  1. Setup the QMK Environment using make
make setup
  1. Compile your firmware
make build

Debugging

To enable debugging, activate the console in the compilation rules in rules.mk:

CONSOLE_ENABLE = yes

Inside your keymap, you can then use the uprintf function as replacement for printf.

To view the printed messages, start the QMK debug console:

make console

Note: The console functionality is about 5KB in size, and depending on your messages, can take up quite a few CPU cycles. So if you aren't actively debugging your keymap, exclude the code from linking into your binary using the CONSOLE_ENABLE compilation symbol.

Other

  • List supported keyboards .\msys.cmd qmk list-keyboards

  • Print a layout of a keyboard using: .\msys.cmd qmk info --keyboard <keyboard> --layouts