zmk_mf68/docs/docs/dev-setup.md at 4ea641f34a8f097209cefa9d8095ced7dd520897

3.1 KiB

Raw Blame History

id	title	sidebar_label
dev-setup	Basic Setup	Basic Setup

Preprequisites

A unix-like environment with Python 3 installed. So far this has been tested on Fedora and Debian. Further testing is required for macOS and WSL.

Setup

West Build Command

west is the Zephyr™ meta-tool used to configure and build Zephyr™ applications. It can be installed by using the pip python package manager:

pip install --user west

:::note If you don't already have it configured, you may need to update your PATH to include the pip install path. See User Installs and (Stack Overflow)[https://stackoverflow.com/questions/38112756/how-do-i-access-packages-installed-by-pip-user] for more details. :::

Zephyr™ ARM SDK

To build firmwares for the ARM architecture (all supported MCUs/keyboards at this point), you'll need to install the Zephyr™ ARM SDK to your system:

export ZSDK_VERSION=0.11.3
wget -q "https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_VERSION}/zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" && \
	sh "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run" --quiet -- -d /opt/toolchains/zephyr-sdk-${ZSDK_VERSION} && \
	rm "zephyr-toolchain-arm-${ZSDK_VERSION}-setup.run"

Source Code

Next, you'll need to clone the ZMK source repository if you haven't already:

git clone https://github.com/zmkfirmware/zmk.git

Initialize & Update Zephy Workspace

Since ZMK is built as a Zephyr™ application, the next step is to use west to initialize and update your workspace. The ZMK Zephyr™ application is in the app/ source directory:

Initialize West

west init -l app/

Update To Fetch Modules

west update

Export Zephyr™ Core

west zephyr-export

Build

To build for your particular keyboard, the behaviour varies slightly depending on if you are building for a keyboard with an onboard MCU, or one that uses a MCU board addon.

Keyboard (Shield) + MCU Board

ZMK treats keyboards that take a MCU addon board as shields, and treats the smaller MCU board as the true board

Given the following:

MCU Board: Proton-C
Keyboard PCB: kyria
Keymap: default

You can build ZMK with the following:

west build -b proton_c -- -DSHIELD=kyria -DKEYMAP=default

Keyboard With Onboard MCU

Keyboards with onboard MCU chips are simply treated as the board as far as Zephyr™ is concerned.