diff --git a/scripts/readme.md b/scripts/readme.md deleted file mode 100644 index e32c948..0000000 --- a/scripts/readme.md +++ /dev/null @@ -1,108 +0,0 @@ -This folder contains scripts that automate installing and building using a local -toolchain. The scripts provide an alternative to using -[Github Actions](https://zmk.dev/docs/user-setup#installing-the-firmware) and -the [developer toolchain](https://zmk.dev/docs/development/setup). - -If the zmk-config repo contains a `combos.dtsi` file, the script will also -automatically update the `MAX_COMBOS_PER_KEY` and `MAX_KEYS_PER_COMBO` settings -for all boards, depending on the combos specified in `combos.dtsi`. - -If the `west.yml` contains any modules other than `ZMK`, the script will look for them in -`HOST_MODULES_DIR` and automatically enable them for the build. - -## Build steps - -### 1. Clone the ZMK repository - -Clone the ZMK repository and checkout the branch that you want to build against. -By default the build script will look for the ZMK repo in `~/zmk`. Other -locations can be specified with `--host-zmk-dir` or by changing the default -location for `HOST_ZMK_DIR` inside the script. - -For example, to build against my `main-3.2` branch, run: - -```bash -cd "$HOME" -git clone https://github.com/urob/zmk -git checkout main-3.2 -``` - -### 2. Clone your zmk-config repository - -By default the build script will look for the zmk-config repo in `~/zmk-config`. -Other locations can be specified with `--host-config-dir` or by changing the -default location for `HOST_CONFIG_DIR` inside the script. - -For example, to use my zmk-config repo, run: - -```bash -cd "$HOME" -git clone https://github.com/urob/zmk-config -``` - -### 3. Install the build requisites - -The build script can be used to install either a "docker" or a "local" -toolchain. If unsure, I recommend using the docker toolchain. Depending on your -installation choice, do **one** of the following: - -1. Install `yq` and `Docker` or `Podman` (recommended). If using Podman, configure the - docker registry. On Debian or Ubuntu, you can do both by running: - ```bash - sudo apt-get install podman yq - echo 'unqualified-search-registries = ["docker.io"]' > $XDG_CONFIG_HOME/containers/registries.conf - ``` -2. Install a local - [developer toolchain](https://zmk.dev/docs/development/setup). The - `zmk_local_install.sh` script in this repository automates the process for - Debian-based operating system. - -### 4. Run the build script - -Run the `zmk_build.sh` script to build your boards. By default, the script will -build all boards specified in `build.yaml` in your `zmk-config` repo. The -default can be overwritten with the `-b` option. - -If using docker/podman, the script will pull down the required dependencies the -first time it is used. The script will automatically detect whether the build -requirement have changed, and will only re-download the dependencies if needed. - -In order to easily switch between multiple ZMK branches that have different -build requirements, one can specify the desired Zephyr version using the `-v` -option. Docker container and volumes are index by the Zephyr version, so -switching between Zephyr version won't require re-downloading new dependencies. -In order to force re-installing all build requirements, pass the `-c` option, -which will wipe out the Docker container and volume. - -By default the script will copy the firmware into the `OUTPUT_DIR` folder -specified in the script. Other locations can be specified using the -`--output-dir` argument. - -To switch between Docker and Podman, set the `DOCKER_BIN` variable in the script -(defaults to `podman`). If using Docker and the user is not in the docker-group, -then one can use Docker in sudo-mode by using the `-s` flag for the script. If -using Podman, running in rootless mode is recommended. - -One can pass custom options to `west` by preluding them with `--`. - -For example, to build my boards using Zephyr version 3.2 in sudo mode and pass -the "pristine" option to west, run: - -```bash -zmk_build.sh -s -v 3.2 -- -p -``` - -See the script for a full set of options. - -## Developing interactively using Docker - -The docker container can be entered interactively using with all the necessary -mounts using: The script shares a build environment with the build script (again -indexed by Zephyr versions). - -For example, to start an interactive Docker session in sudo mode using Zephyr -version 3.2, run: - -```bash -zmk_run_docker.sh -s -v 3.2 -``` diff --git a/scripts/zmk_build.sh b/scripts/zmk_build.sh deleted file mode 100755 index 8537975..0000000 --- a/scripts/zmk_build.sh +++ /dev/null @@ -1,240 +0,0 @@ -#!/usr/bin/env bash - -# Parse input arguments -while [[ $# -gt 0 ]]; do - case $1 in - # needed when user isn't in docker group - -s | --su) - SUDO="sudo" - ;; - - -l | --local) - RUNWITH_DOCKER="false" - ;; - - -m | --multithread) - MULTITHREAD="true" - ;; - - --no-multithread) - MULTITHREAD="false" - ;; - - -c | --clear-cache) - CLEAR_CACHE="true" - ;; - - # comma or space separated list of boards (use quotes if space separated) - # if ommitted, will compile list of boards in build.yaml - -b | --board) - BOARDS="$2" - shift - ;; - - # comma or space separated list of modules (use quotes if space separated) - # if ommitted, will compile list of modules in west.yml - --modules) - MODULES="$2" - shift - ;; - - -v | --version) - ZEPHYR_VERSION="$2" - shift - ;; - - -o | --output-dir) - OUTPUT_DIR="$2" - shift - ;; - - --log-dir) - LOG_DIR="$2" - shift - ;; - - --host-config-dir) - HOST_CONFIG_DIR="$2" - shift - ;; - - --host-zmk-dir) - HOST_ZMK_DIR="$2" - shift - ;; - - --docker-config-dir) - DOCKER_CONFIG_DIR="$2" - shift - ;; - - --docker-zmk-dir) - DOCKER_ZMK_DIR="$2" - shift - ;; - - --) - WEST_OPTS="${@:2}" - break - ;; - - *) - echo "Unknown option $1" - exit 1 - ;; - - esac - shift -done - -# Set defaults -[[ -z $ZEPHYR_VERSION ]] && ZEPHYR_VERSION="3.5" -[[ -z $RUNWITH_DOCKER ]] && RUNWITH_DOCKER="true" -[[ -z $MULTITHREAD ]] && MULTITHREAD="true" - -[[ -z $OUTPUT_DIR ]] && OUTPUT_DIR="$WINHOME/Downloads" -[[ -z $LOG_DIR ]] && LOG_DIR="/tmp" - -[[ -z $HOST_ZMK_DIR ]] && HOST_ZMK_DIR="$HOME/zmk" -[[ -z $HOST_MODULES_DIR ]] && HOST_MODULES_DIR="$HOME/zmk-modules" -[[ -z $HOST_CONFIG_DIR ]] && HOST_CONFIG_DIR="$HOME/zmk-config" - -[[ -z $DOCKER_ZMK_DIR ]] && DOCKER_ZMK_DIR="/workspace/zmk" -[[ -z $DOCKER_MODULES_DIR ]] && DOCKER_MODULES_DIR="/workspace/zmk-modules" -[[ -z $DOCKER_CONFIG_DIR ]] && DOCKER_CONFIG_DIR="/workspace/zmk-config" - -[[ -z $BOARDS ]] && BOARDS="$(yq -r '.include[].board' $HOST_CONFIG_DIR/build.yaml)" -[[ -z $MODULES ]] && MODULES="$(yq -r '.manifest.projects[].name | - select(. != "zmk")' $HOST_CONFIG_DIR/config/west.yml)" - -[[ -z $CLEAR_CACHE ]] && CLEAR_CACHE="false" - -DOCKER_IMG="zmkfirmware/zmk-dev-arm:$ZEPHYR_VERSION" -DOCKER_BIN="$SUDO podman" - -echo "Configured modules: $MODULES" -MODULES=$( - echo $MODULES | - sed -z 's/[, \n]/;/g' | # use ; as separator - sed -r "s|([^;]*);|${DOCKER_MODULES_DIR}/\1;|g" | # insert modules root path - sed 's/;$/\n/' # remove final ; -) - -# +-------------------------+ -# | AUTOMATE CONFIG OPTIONS | -# +-------------------------+ - -cd "$HOST_CONFIG_DIR" - -if [[ -f config/combos.dtsi ]]; then - # update maximum combos per key - count=$( - tail -n +10 config/combos.dtsi | - grep -Eo '[LR][TMBH][0-9]' | - sort | uniq -c | sort -nr | - awk 'NR==1{print $1}' - ) - sed -Ei "/CONFIG_ZMK_COMBO_MAX_COMBOS_PER_KEY/s/=.+/=$count/" config/*.conf - echo "Setting MAX_COMBOS_PER_KEY to $count" - - # update maximum keys per combo - count=$( - tail -n +10 config/combos.dtsi | - grep -o -n '[LR][TMBH][0-9]' | - cut -d : -f 1 | uniq -c | sort -nr | - awk 'NR==1{print $1}' - ) - sed -Ei "/CONFIG_ZMK_COMBO_MAX_KEYS_PER_COMBO/s/=.+/=$count/" config/*.conf - echo "Setting MAX_KEYS_PER_COMBO to $count" -fi - -# +--------------------+ -# | BUILD THE FIRMWARE | -# +--------------------+ - -if [[ $RUNWITH_DOCKER = true ]]; then - echo "Build mode: docker" - # DOCKER_CMD="$DOCKER_BIN run --name zmk-$ZEPHYR_VERSION --rm \ - DOCKER_CMD="$DOCKER_BIN run --rm \ - --mount type=bind,source=$HOST_ZMK_DIR,target=$DOCKER_ZMK_DIR \ - --mount type=bind,source=$HOST_CONFIG_DIR,target=$DOCKER_CONFIG_DIR,readonly \ - --mount type=bind,source=$HOST_MODULES_DIR,target=$DOCKER_MODULES_DIR,readonly \ - --mount type=volume,source=zmk-root-user-$ZEPHYR_VERSION,target=/root \ - --mount type=volume,source=zmk-zephyr-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/zephyr \ - --mount type=volume,source=zmk-zephyr-modules-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/modules \ - --mount type=volume,source=zmk-zephyr-tools-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/tools" - - # Reset volumes - if [[ $CLEAR_CACHE = true ]]; then - $DOCKER_BIN volume rm $($DOCKER_BIN volume ls -q | grep "^zmk-.*-$ZEPHYR_VERSION$") - fi - - # Update west if needed - OLD_WEST="/root/west.yml.old" - $DOCKER_CMD -w "$DOCKER_ZMK_DIR" "$DOCKER_IMG" /bin/bash -c " \ - if [[ ! -f .west/config ]]; then west init -l app/; fi \ - && if [[ -f $OLD_WEST ]]; then md5_old=\$(md5sum $OLD_WEST | cut -d' ' -f1); fi \ - && [[ \$md5_old != \$(md5sum app/west.yml | cut -d' ' -f1) ]] \ - && west update \ - && cp app/west.yml $OLD_WEST" - - # Build parameters - DOCKER_PREFIX="$DOCKER_CMD -w $DOCKER_ZMK_DIR/app $DOCKER_IMG" - SUFFIX="${ZEPHYR_VERSION}_docker" - CONFIG_DIR="$DOCKER_CONFIG_DIR/config" - -else - echo "Build mode: local" - SUFFIX="${ZEPHYR_VERSION}" - CONFIG_DIR="$HOST_CONFIG_DIR/config" - cd "$HOST_ZMK_DIR/app" -fi - -# usage: compile_board board -compile_board() { - BUILD_DIR="${1}_$SUFFIX" - LOGFILE="$LOG_DIR/zmk_build_$1.log" - [[ $MULTITHREAD = "true" ]] || echo -en "\n$(tput setaf 2)Building $1... $(tput sgr0)" - [[ $MULTITHREAD = "true" ]] && echo -e "$(tput setaf 2)Building $1... $(tput sgr0)" - $DOCKER_PREFIX west build -d "build/$BUILD_DIR" -b $1 $WEST_OPTS \ - -- -DZMK_CONFIG="$CONFIG_DIR" -DZMK_EXTRA_MODULES="$MODULES" -Wno-dev >"$LOGFILE" 2>&1 - if [[ $? -eq 0 ]]; then - [[ $MULTITHREAD = "true" ]] || echo "$(tput setaf 2)done$(tput sgr0)" - echo "Build log saved to \"$LOGFILE\"." - if [[ -f $HOST_ZMK_DIR/app/build/$BUILD_DIR/zephyr/zmk.uf2 ]]; then - TYPE="uf2" - else - TYPE="bin" - fi - OUTPUT="$OUTPUT_DIR/$1-zmk.$TYPE" - [[ -f $OUTPUT ]] && [[ ! -L $OUTPUT ]] && mv "$OUTPUT" "$OUTPUT.bak" - cp "$HOST_ZMK_DIR/app/build/$BUILD_DIR/zephyr/zmk.$TYPE" "$OUTPUT" - else - echo - cat "$LOGFILE" - echo "$(tput setaf 1)Error: $1 failed$(tput sgr0)" - fi -} - -cd "$HOST_ZMK_DIR/app" -if [[ $MULTITHREAD = "true" ]]; then - i=1 - for board in $(echo $BOARDS | sed 's/,/ /g'); do - compile_board $board & - eval "T${i}=\${!}" - eval "B${i}=\$board" # Store the board name in a corresponding variable - ((i++)) - done - - echo "Starting $(($i - 1)) background threads:" - for ((x = 1; x < i; x++)); do - pid="T$x" - wait "${!pid}" - board="B$x" # Retrieve the board name from the corresponding variable - echo -e "$(tput setaf 3)Thread $x with PID ${!pid} has finished: ${!board}$(tput sgr0)" - done -else - for board in $(echo $BOARDS | sed 's/,/ /g'); do - compile_board $board - done -fi diff --git a/scripts/zmk_local_install.sh b/scripts/zmk_local_install.sh deleted file mode 100755 index f48cab2..0000000 --- a/scripts/zmk_local_install.sh +++ /dev/null @@ -1,57 +0,0 @@ -#!/usr/bin/env bash - -### Step 1: Update OS -sudo apt update -sudo apt upgrade - -### Step 2: Install dependencies -sudo apt-get install --yes --no-install-recommends git cmake ninja-build gperf \ - ccache dfu-util device-tree-compiler wget \ - python3-dev python3-pip python3-setuptools python3-tk python3-wheel xz-utils file \ - make gcc gcc-multilib g++-multilib libsdl2-dev libmagic1 - -### Step 3: Install Zephyr SDK - -# Find latest release version -# ZSDK_URL="https://github.com/zephyrproject-rtos/sdk-ng/releases/latest" -# ZSDK_VERSION="$(curl -fsSLI -o /dev/null -w %{url_effective} ${ZSDK_URL} | sed 's/^.*v//')" -ZSDK_VERSION="0.16.3" - -# Download and verify latest Zephyr SDK bundle -cd ~/.local -wget https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_VERSION}/zephyr-sdk-${ZSDK_VERSION}_linux-x86_64.tar.xz -wget -O - https://github.com/zephyrproject-rtos/sdk-ng/releases/download/v${ZSDK_VERSION}/sha256.sum | shasum --check --ignore-missing -## TODO: abort if exit code is error - -# Extract the Zephyr SDK bundle archive -tar xvf zephyr-sdk-${ZSDK_VERSION}_linux-x86_64.tar.xz -rm zephyr-sdk-${ZSDK_VERSION}_linux-x86_64.tar.xz - -# Run the Zephyr SDK bundle setup script -cd zephyr-sdk-${ZSDK_VERSION} -./setup.sh - -# Install udev rules, which allow you to flash most Zephyr boards as a regular user -sudo cp ~/zephyr-sdk-${ZSDK_VERSION}/sysroots/x86_64-pokysdk-linux/usr/share/openocd/contrib/60-openocd.rules /etc/udev/rules.d -sudo udevadm control --reload - -### Step 4: Get Zephyr and install Python dependencies - -# Install West -pip3 install --user -U west # may need to replace with "python3 -m pip" or "python -m pip" - -# Get the Zephyr cource code: -cd ~/zmk -west init -l app/ -west update - -# Export a Zephyr CMake package to allow CMake to load the code needed to build ZMK -west zephyr-export - -# Install Zephyr Python Dependencies -pip3 install --user -r zephyr/scripts/requirements.txt # see above - -### Step 5: Install Docusaurus -sudo apt-get install --yes --no-install-recommends npm -cd ~/zmk/docs -npm ci diff --git a/scripts/zmk_run_docker.sh b/scripts/zmk_run_docker.sh deleted file mode 100755 index 543f3f6..0000000 --- a/scripts/zmk_run_docker.sh +++ /dev/null @@ -1,98 +0,0 @@ -#!/usr/bin/env bash - -# This script sets up a docker development environment and starts an interactive shell. -# For a one-stop-shop script for building boards, which sets up a build environment in -# the background and re-uses it across runs, see zmk_build.sh instead. - -# Parse input arguments -while [[ $# -gt 0 ]]; do - case $1 in - # needed when user isn't in docker group - -s | --sudu) - SUDO="sudo" - ;; - - -c | --clear-cache) - CLEAR_CACHE="true" - ;; - - -d | --install-doc-tools) - DOC_TOOLS="true" - ;; - - -v | --version) - ZEPHYR_VERSION="$2" - shift - ;; - - --host-config-dir) - HOST_CONFIG_DIR="$2" - shift - ;; - - --host-zmk-dir) - HOST_ZMK_DIR="$2" - shift - ;; - - --docker-config-dir) - DOCKER_CONFIG_DIR="$2" - shift - ;; - - --docker-zmk-dir) - DOCKER_ZMK_DIR="$2" - shift - ;; - - *) - echo "Unknown option $1" - exit 1 - ;; - - esac - shift -done - -# Set defaults -[[ -z $ZEPHYR_VERSION ]] && ZEPHYR_VERSION="3.5" - -[[ -z $HOST_ZMK_DIR ]] && HOST_ZMK_DIR="$HOME/zmk" -[[ -z $HOST_CONFIG_DIR ]] && HOST_CONFIG_DIR="$HOME/zmk-config" - -[[ -z $DOCKER_ZMK_DIR ]] && DOCKER_ZMK_DIR="/workspace/zmk" -[[ -z $DOCKER_CONFIG_DIR ]] && DOCKER_CONFIG_DIR="/workspace/zmk-config" - -[[ -z $CLEAR_CACHE ]] && CLEAR_CACHE="false" -[[ -z $DOC_TOOLS ]] && DOC_TOOLS="false" - -DOCKER_IMG="zmkfirmware/zmk-dev-arm:$ZEPHYR_VERSION" -DOCKER_CMD="$SUDO docker run --name zmk-$ZEPHYR_VERSION --rm \ - --mount type=bind,source=$HOST_ZMK_DIR,target=$DOCKER_ZMK_DIR \ - --mount type=bind,source=$HOST_CONFIG_DIR,target=$DOCKER_CONFIG_DIR \ - --mount type=volume,source=zmk-root-user-$ZEPHYR_VERSION,target=/root \ - --mount type=volume,source=zmk-zephyr-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/zephyr \ - --mount type=volume,source=zmk-zephyr-modules-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/modules \ - --mount type=volume,source=zmk-zephyr-tools-$ZEPHYR_VERSION,target=$DOCKER_ZMK_DIR/tools" - -# Reset volumes -if [[ $CLEAR_CACHE = true ]]; then - $SUDO docker volume rm $(sudo docker volume ls -q | grep "^zmk-.*-$ZEPHYR_VERSION$") -fi - -# Update west if needed -OLD_WEST="/root/west.yml.old" -$DOCKER_CMD -w "$DOCKER_ZMK_DIR" "$DOCKER_IMG" /bin/bash -c " \ - if [[ ! -f .west/config ]]; then west init -l app/; fi \ - && if [[ -f $OLD_WEST ]]; then md5_old=\$(md5sum $OLD_WEST | cut -d' ' -f1); fi \ - && [[ \$md5_old != \$(md5sum app/west.yml | cut -d' ' -f1) ]] \ - && cp app/west.yml $OLD_WEST \ - && west update" - -# Install docosaurus -if [[ $DOC_TOOLS = true ]]; then - $DOCKER_CMD -w "$DOCKER_ZMK_DIR/docs" "$DOCKER_IMG" npm ci -fi - -# Start interactive shell -$DOCKER_CMD -w "$DOCKER_ZMK_DIR" -it "$DOCKER_IMG" /bin/bash