From a18c35aeee1af6e25baa9dbb2a7f205183b9989d Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Tue, 9 Jul 2024 22:00:24 +0200 Subject: [PATCH 1/8] add: configuration for dongle --- boards/shields/temper/Kconfig.defconfig | 12 +++++------ boards/shields/temper/Kconfig.shield | 3 +++ boards/shields/temper/temper.conf | 3 +-- boards/shields/temper/temper.dtsi | 21 ------------------ boards/shields/temper/temper.zmk.yml | 4 +--- boards/shields/temper/temper_dongle.conf | 6 ++++++ boards/shields/temper/temper_dongle.overlay | 17 +++++++++++++++ build.sh | 24 +++++++++++++++++++++ build.yaml | 3 +++ 9 files changed, 61 insertions(+), 32 deletions(-) create mode 100644 boards/shields/temper/temper_dongle.conf create mode 100644 boards/shields/temper/temper_dongle.overlay create mode 100755 build.sh diff --git a/boards/shields/temper/Kconfig.defconfig b/boards/shields/temper/Kconfig.defconfig index 62291e5c..d09e0e31 100644 --- a/boards/shields/temper/Kconfig.defconfig +++ b/boards/shields/temper/Kconfig.defconfig @@ -1,14 +1,14 @@ -if SHIELD_TEMPER_LEFT +if SHIELD_TEMPER_DONGLE config ZMK_KEYBOARD_NAME - default "temper" - + default "Temper Dongle" + config ZMK_SPLIT_ROLE_CENTRAL - default y - + default y + endif -if SHIELD_TEMPER_LEFT || SHIELD_TEMPER_RIGHT +if SHIELD_TEMPER_LEFT || SHIELD_TEMPER_RIGHT || SHIELD_TEMPER_DONGLE config ZMK_SPLIT default y diff --git a/boards/shields/temper/Kconfig.shield b/boards/shields/temper/Kconfig.shield index 23e1713c..bdd7ddac 100644 --- a/boards/shields/temper/Kconfig.shield +++ b/boards/shields/temper/Kconfig.shield @@ -6,3 +6,6 @@ config SHIELD_TEMPER_LEFT config SHIELD_TEMPER_RIGHT def_bool $(shields_list_contains,temper_right) + +config SHIELD_TEMPER_DONGLE + def_bool $(shields_list_contains,temper_dongle) diff --git a/boards/shields/temper/temper.conf b/boards/shields/temper/temper.conf index f6631784..6b4a087e 100644 --- a/boards/shields/temper/temper.conf +++ b/boards/shields/temper/temper.conf @@ -1,2 +1 @@ -# Uncomment the following line to enable deep sleep -CONFIG_ZMK_SLEEP=y \ No newline at end of file +CONFIG_BT_CTLR_TX_PWR_PLUS_8=y diff --git a/boards/shields/temper/temper.dtsi b/boards/shields/temper/temper.dtsi index 7405c422..056a591b 100644 --- a/boards/shields/temper/temper.dtsi +++ b/boards/shields/temper/temper.dtsi @@ -8,7 +8,6 @@ / { chosen { - zephyr,display = &oled; zmk,kscan = &kscan0; zmk,matrix_transform = &default_transform; }; @@ -45,23 +44,3 @@ RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(2,6) RC(2,7) RC(2,8) RC(2,9) // TODO: per-key RGB node(s)? }; - -&pro_micro_i2c { - status = "okay"; - - oled: ssd1306@3c { - compatible = "solomon,ssd1306fb"; - reg = <0x3c>; - label = "DISPLAY"; - width = <128>; - height = <32>; - segment-offset = <0>; - page-offset = <0>; - display-offset = <0>; - multiplex-ratio = <31>; - segment-remap; - com-invdir; - com-sequential; - prechargep = <0x22>; - }; -}; diff --git a/boards/shields/temper/temper.zmk.yml b/boards/shields/temper/temper.zmk.yml index eab579dd..0988bc97 100644 --- a/boards/shields/temper/temper.zmk.yml +++ b/boards/shields/temper/temper.zmk.yml @@ -4,11 +4,9 @@ name: Chocofi Temper type: shield url: https://github.com/raeedcho/chocofi-temper requires: [pro_micro] -exposes: [i2c_oled] features: - keys - - display - - underglow siblings: - temper_left - temper_right + - temper_dongle diff --git a/boards/shields/temper/temper_dongle.conf b/boards/shields/temper/temper_dongle.conf new file mode 100644 index 00000000..ad069dfd --- /dev/null +++ b/boards/shields/temper/temper_dongle.conf @@ -0,0 +1,6 @@ +CONFIG_ZMK_SPLIT_BLE_CENTRAL_PERIPHERALS=2 + +CONFIG_ZMK_SLEEP=n +# CONFIG_PM_DEVICE=n +CONFIG_ZMK_IDLE_SLEEP_TIMEOUT=900000 +CONFIG_ZMK_EXT_POWER=y diff --git a/boards/shields/temper/temper_dongle.overlay b/boards/shields/temper/temper_dongle.overlay new file mode 100644 index 00000000..eadf123a --- /dev/null +++ b/boards/shields/temper/temper_dongle.overlay @@ -0,0 +1,17 @@ +/* + * Copyright (c) 2020 Pete Johanson + * + * SPDX-License-Identifier: MIT + */ + +#include "temper.dtsi" + +&kscan0 { + col-gpios + = <&pro_micro 15 GPIO_ACTIVE_HIGH> + , <&pro_micro 18 GPIO_ACTIVE_HIGH> + , <&pro_micro 19 GPIO_ACTIVE_HIGH> + , <&pro_micro 20 GPIO_ACTIVE_HIGH> + , <&pro_micro 21 GPIO_ACTIVE_HIGH> + ; +}; diff --git a/build.sh b/build.sh new file mode 100755 index 00000000..d8d8a5d3 --- /dev/null +++ b/build.sh @@ -0,0 +1,24 @@ +#!/usr/bin/env zsh + +ZMK_CONFIG_PATH="/Users/zeljkobekcic/Projects/Private/temper-zmk-config/config" +ZMK_EXTRA_MODULES_PATH="/Users/zeljkobekcic/Projects/Private/temper-zmk-config" +OUTPUT_DIRECTORY="/Users/zeljkobekcic/Projects/Private/temper-zmk-config/outputs/" + +rm -rf "$OUTPUT_DIRECTORY" +mkdir -p "$OUTPUT_DIRECTORY" + +( + cd ~/Projects/Private/zmk + source .venv/bin/activate + cd app + west build -d build/temper_left -b nice_nano_v2 --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_PATH" -DSHIELD=temper_left -DZMK_EXTRA_MODULES="$ZMK_EXTRA_MODULES_PATH" + west build -d build/temper_right -b nice_nano_v2 --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_PATH" -DSHIELD=temper_right -DZMK_EXTRA_MODULES="$ZMK_EXTRA_MODULES_PATH" + west build -d build/temper_dongle -b nice_nano_v2 --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_PATH" -DSHIELD=temper_dongle -DZMK_EXTRA_MODULES="$ZMK_EXTRA_MODULES_PATH" + deactivate + + cp build/temper_dongle/zephyr/zmk.uf2 "$OUTPUT_DIRECTORY/temper_dongle.uf2" + cp build/temper_right/zephyr/zmk.uf2 "$OUTPUT_DIRECTORY/temper_right.uf2" + cp build/temper_left/zephyr/zmk.uf2 "$OUTPUT_DIRECTORY/temper_left.uf2" + + rm -rf build +) diff --git a/build.yaml b/build.yaml index 427ef4f8..4cc3c8b3 100644 --- a/build.yaml +++ b/build.yaml @@ -17,3 +17,6 @@ include: shield: temper_left - board: nice_nano_v2 shield: temper_right + - board: nice_nano_v2 + shield: temper_dongle + From cbd7b8a041f39ffdc9049560fdeb6a8275ac1839 Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:17:07 +0200 Subject: [PATCH 2/8] chore: rename dongle mode --- boards/shields/temper/Kconfig.shield | 11 ----------- build.sh | 7 +++---- build.yaml | 8 +++++--- .../boards/shields/temper-dongle}/Kconfig.defconfig | 0 config/boards/shields/temper-dongle/Kconfig.shield | 11 +++++++++++ .../shields/temper-dongle}/boards/nice_nano.overlay | 0 .../temper-dongle}/boards/nice_nano_v2.overlay | 0 .../boards/shields/temper-dongle}/temper.conf | 0 .../boards/shields/temper-dongle}/temper.dtsi | 0 .../boards/shields/temper-dongle}/temper.keymap | 0 .../boards/shields/temper-dongle}/temper.zmk.yml | 6 +++--- .../shields/temper-dongle/temper_dongle_dongle.conf | 0 .../temper-dongle/temper_dongle_dongle.overlay | 0 .../shields/temper-dongle/temper_dongle_left.conf | 0 .../shields/temper-dongle/temper_dongle_left.overlay | 0 .../shields/temper-dongle/temper_dongle_right.conf | 0 .../shields/temper-dongle/temper_dongle_right.overlay | 0 zephyr/module.yml | 3 --- 18 files changed, 22 insertions(+), 24 deletions(-) delete mode 100644 boards/shields/temper/Kconfig.shield rename {boards/shields/temper => config/boards/shields/temper-dongle}/Kconfig.defconfig (100%) create mode 100644 config/boards/shields/temper-dongle/Kconfig.shield rename {boards/shields/temper => config/boards/shields/temper-dongle}/boards/nice_nano.overlay (100%) rename {boards/shields/temper => config/boards/shields/temper-dongle}/boards/nice_nano_v2.overlay (100%) rename {boards/shields/temper => config/boards/shields/temper-dongle}/temper.conf (100%) rename {boards/shields/temper => config/boards/shields/temper-dongle}/temper.dtsi (100%) rename {boards/shields/temper => config/boards/shields/temper-dongle}/temper.keymap (100%) rename {boards/shields/temper => config/boards/shields/temper-dongle}/temper.zmk.yml (69%) rename boards/shields/temper/temper_dongle.conf => config/boards/shields/temper-dongle/temper_dongle_dongle.conf (100%) rename boards/shields/temper/temper_dongle.overlay => config/boards/shields/temper-dongle/temper_dongle_dongle.overlay (100%) rename boards/shields/temper/temper_left.conf => config/boards/shields/temper-dongle/temper_dongle_left.conf (100%) rename boards/shields/temper/temper_left.overlay => config/boards/shields/temper-dongle/temper_dongle_left.overlay (100%) rename boards/shields/temper/temper_right.conf => config/boards/shields/temper-dongle/temper_dongle_right.conf (100%) rename boards/shields/temper/temper_right.overlay => config/boards/shields/temper-dongle/temper_dongle_right.overlay (100%) delete mode 100644 zephyr/module.yml diff --git a/boards/shields/temper/Kconfig.shield b/boards/shields/temper/Kconfig.shield deleted file mode 100644 index bdd7ddac..00000000 --- a/boards/shields/temper/Kconfig.shield +++ /dev/null @@ -1,11 +0,0 @@ -# Copyright (c) 2020 Pete Johanson -# SPDX-License-Identifier: MIT - -config SHIELD_TEMPER_LEFT - def_bool $(shields_list_contains,temper_left) - -config SHIELD_TEMPER_RIGHT - def_bool $(shields_list_contains,temper_right) - -config SHIELD_TEMPER_DONGLE - def_bool $(shields_list_contains,temper_dongle) diff --git a/build.sh b/build.sh index 7734fd6f..b7424e79 100755 --- a/build.sh +++ b/build.sh @@ -1,8 +1,7 @@ #!/usr/bin/env zsh ZMK_APP_PATH="$HOME/Projects/Private/zmk/app" -ZMK_CONFIG_PATH="$HOME/Projects/Private/temper-zmk-config/config" -ZMK_EXTRA_MODULES_PATH="$HOME/Projects/Private/temper-zmk-config" +ZMK_CONFIG_ROOT_PATH="$HOME/Projects/Private/temper-zmk-config" OUTPUT_DIRECTORY="$HOME/Projects/Private/temper-zmk-config/outputs/" rm -rf "$OUTPUT_DIRECTORY" @@ -11,11 +10,11 @@ mkdir -p "$OUTPUT_DIRECTORY" cd "$ZMK_APP_PATH" source ../.venv/bin/activate -yq '.include | map(.board + " " + .shield)' "$ZMK_EXTRA_MODULES_PATH/build.yaml" | while read line; do +yq '.include | map(.board + " " + .shield)' "$ZMK_CONFIG_ROOT_PATH/build.yaml" | while read line; do board=$(echo $line | awk '{ print $2 }') shield=$(echo $line | awk '{ print $3 }') - west build -d "build/$shield-$board" -b $board --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_PATH" -DSHIELD=$shield -DZMK_EXTRA_MODULES="$ZMK_EXTRA_MODULES_PATH" + west build -d "build/$shield-$board" -b $board --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_ROOT_PATH/config" -DSHIELD=$shield cp "build/$shield-$board/zephyr/zmk.uf2" "$OUTPUT_DIRECTORY/$shield-$board.uf2" done diff --git a/build.yaml b/build.yaml index 4cc3c8b3..be0072b6 100644 --- a/build.yaml +++ b/build.yaml @@ -14,9 +14,11 @@ --- include: - board: nice_nano_v2 - shield: temper_left + shield: temper_dongle_left - board: nice_nano_v2 - shield: temper_right + shield: temper_dongle_right - board: nice_nano_v2 - shield: temper_dongle + shield: temper_dongle_dongle + - board: nice_nano_v2 + shield: settings_reset diff --git a/boards/shields/temper/Kconfig.defconfig b/config/boards/shields/temper-dongle/Kconfig.defconfig similarity index 100% rename from boards/shields/temper/Kconfig.defconfig rename to config/boards/shields/temper-dongle/Kconfig.defconfig diff --git a/config/boards/shields/temper-dongle/Kconfig.shield b/config/boards/shields/temper-dongle/Kconfig.shield new file mode 100644 index 00000000..fd2426f6 --- /dev/null +++ b/config/boards/shields/temper-dongle/Kconfig.shield @@ -0,0 +1,11 @@ +# Copyright (c) 2020 Pete Johanson +# SPDX-License-Identifier: MIT + +config SHIELD_TEMPER_LEFT + def_bool $(shields_list_contains,temper_dongle_left) + +config SHIELD_TEMPER_RIGHT + def_bool $(shields_list_contains,temper_dongle_right) + +config SHIELD_TEMPER_DONGLE + def_bool $(shields_list_contains,temper_dongle_dongle) diff --git a/boards/shields/temper/boards/nice_nano.overlay b/config/boards/shields/temper-dongle/boards/nice_nano.overlay similarity index 100% rename from boards/shields/temper/boards/nice_nano.overlay rename to config/boards/shields/temper-dongle/boards/nice_nano.overlay diff --git a/boards/shields/temper/boards/nice_nano_v2.overlay b/config/boards/shields/temper-dongle/boards/nice_nano_v2.overlay similarity index 100% rename from boards/shields/temper/boards/nice_nano_v2.overlay rename to config/boards/shields/temper-dongle/boards/nice_nano_v2.overlay diff --git a/boards/shields/temper/temper.conf b/config/boards/shields/temper-dongle/temper.conf similarity index 100% rename from boards/shields/temper/temper.conf rename to config/boards/shields/temper-dongle/temper.conf diff --git a/boards/shields/temper/temper.dtsi b/config/boards/shields/temper-dongle/temper.dtsi similarity index 100% rename from boards/shields/temper/temper.dtsi rename to config/boards/shields/temper-dongle/temper.dtsi diff --git a/boards/shields/temper/temper.keymap b/config/boards/shields/temper-dongle/temper.keymap similarity index 100% rename from boards/shields/temper/temper.keymap rename to config/boards/shields/temper-dongle/temper.keymap diff --git a/boards/shields/temper/temper.zmk.yml b/config/boards/shields/temper-dongle/temper.zmk.yml similarity index 69% rename from boards/shields/temper/temper.zmk.yml rename to config/boards/shields/temper-dongle/temper.zmk.yml index 0988bc97..445e5a49 100644 --- a/boards/shields/temper/temper.zmk.yml +++ b/config/boards/shields/temper-dongle/temper.zmk.yml @@ -7,6 +7,6 @@ requires: [pro_micro] features: - keys siblings: - - temper_left - - temper_right - - temper_dongle + - temper_dongle_left + - temper_dongle_right + - temper_dongle_dongle diff --git a/boards/shields/temper/temper_dongle.conf b/config/boards/shields/temper-dongle/temper_dongle_dongle.conf similarity index 100% rename from boards/shields/temper/temper_dongle.conf rename to config/boards/shields/temper-dongle/temper_dongle_dongle.conf diff --git a/boards/shields/temper/temper_dongle.overlay b/config/boards/shields/temper-dongle/temper_dongle_dongle.overlay similarity index 100% rename from boards/shields/temper/temper_dongle.overlay rename to config/boards/shields/temper-dongle/temper_dongle_dongle.overlay diff --git a/boards/shields/temper/temper_left.conf b/config/boards/shields/temper-dongle/temper_dongle_left.conf similarity index 100% rename from boards/shields/temper/temper_left.conf rename to config/boards/shields/temper-dongle/temper_dongle_left.conf diff --git a/boards/shields/temper/temper_left.overlay b/config/boards/shields/temper-dongle/temper_dongle_left.overlay similarity index 100% rename from boards/shields/temper/temper_left.overlay rename to config/boards/shields/temper-dongle/temper_dongle_left.overlay diff --git a/boards/shields/temper/temper_right.conf b/config/boards/shields/temper-dongle/temper_dongle_right.conf similarity index 100% rename from boards/shields/temper/temper_right.conf rename to config/boards/shields/temper-dongle/temper_dongle_right.conf diff --git a/boards/shields/temper/temper_right.overlay b/config/boards/shields/temper-dongle/temper_dongle_right.overlay similarity index 100% rename from boards/shields/temper/temper_right.overlay rename to config/boards/shields/temper-dongle/temper_dongle_right.overlay diff --git a/zephyr/module.yml b/zephyr/module.yml deleted file mode 100644 index 1cc2b356..00000000 --- a/zephyr/module.yml +++ /dev/null @@ -1,3 +0,0 @@ -build: - settings: - board_root: . From b994811649527b02da30750607750083430f241b Mon Sep 17 00:00:00 2001 From: zeljkobekcic Date: Sat, 13 Jul 2024 13:17:25 +0000 Subject: [PATCH 3/8] doc: update keymap image --- keymap_img/*.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 keymap_img/*.yaml diff --git a/keymap_img/*.yaml b/keymap_img/*.yaml new file mode 100644 index 00000000..e69de29b From 7ba0abd91ad6e9e82f1ee0289964b4578023574d Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:28:37 +0200 Subject: [PATCH 4/8] doc: update readme --- README.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c2e33964..0cc51481 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,18 @@ This is my personal ZMK config for the [temper](https://github.com/raeedcho/temper). -Some notes about this config: -- Four main layers (default, numbers/symbols, navigation, and function) -- Default layer is Colemak DHm, but there's also a QWERTY layer that can be toggled on -- Navigation layer has vim-like arrow keys +## Installing -![Temper Keymap](keymap_img/temper.svg) +1. Flash all three microcontrollers with the reset firmware which has been build. All three with the same `.uf2` firmware. +2. Flash all microcontrollers with their respective firmware +3. Turn off bluetooth, plug in the dongle and everything should be working out of the box. + +## Building locally + +Change the paths in the environment variables in the `.build.sh`, then run it. + +```shell +./build.sh +``` + +This will create a directory called `output` and in there are all the `.uf2` files From c9fb3056912dd47f61f50f519f97f72950d14c89 Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:30:20 +0200 Subject: [PATCH 5/8] doc: update readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0cc51481..f6c66a2d 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This is my personal ZMK config for the [temper](https://github.com/raeedcho/temp ## Installing -1. Flash all three microcontrollers with the reset firmware which has been build. All three with the same `.uf2` firmware. +1. Flash all three microcontrollers with the reset firmware which has been build. All three with the same `.uf2` firmware. More information about this step can be found in the official documentation of ZMK . 2. Flash all microcontrollers with their respective firmware 3. Turn off bluetooth, plug in the dongle and everything should be working out of the box. From d31dd0308bb592d2ac55f071c64ad2146e787117 Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:38:31 +0200 Subject: [PATCH 6/8] add: normal temper config --- build.sh | 28 ++++++++++++++-------------- build.yaml | 4 ++++ 2 files changed, 18 insertions(+), 14 deletions(-) diff --git a/build.sh b/build.sh index 6c592b22..b4884057 100755 --- a/build.sh +++ b/build.sh @@ -1,24 +1,24 @@ ZMK_APP_PATH="$HOME/Projects/Private/zmk/app" ZMK_CONFIG_ROOT_PATH="$HOME/Projects/Private/temper-zmk-config" -OUTPUT_DIRECTORY="$HOME/Projects/Private/temper-zmk-config/outputs/" +OUTPUT_DIRECTORY="$ZMK_CONFIG_ROOT_PATH/outputs/" rm -rf "$OUTPUT_DIRECTORY" mkdir -p "$OUTPUT_DIRECTORY" -cd "$ZMK_APP_PATH" -source ../.venv/bin/activate +( + cd "$ZMK_APP_PATH" + source ../.venv/bin/activate -# format to json lines then read ech json object per loop iterationn -yq -o=json -I=0 '.include[]' "$ZMK_EXTRA_MODULES_PATH/build.yaml" | while read line; do - board=$(echo $line | jq -r '.board') - shield=$(echo $line | jq -r '.shield') + # format to json lines then read ech json object per loop iterationn + yq -o=json -I=0 '.include[]' "$ZMK_CONFIG_ROOT_PATH/build.yaml" | while read -r line; do + board=$(echo "$line" | jq -r '.board') + shield=$(echo "$line" | jq -r '.shield') - west build -d "build/$shield-$board" -b $board --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_PATH" -DSHIELD="$shield" - cp "build/$shield-$board/zephyr/zmk.uf2" "$OUTPUT_DIRECTORY/$shield-$board.uf2" -done + west build -d "build/$shield-$board" -b "$board" --pristine -- -DZMK_CONFIG="$ZMK_CONFIG_ROOT_PATH/config" -DSHIELD="$shield" + cp "build/$shield-$board/zephyr/zmk.uf2" "$OUTPUT_DIRECTORY/$shield-$board.uf2" + done -deactivate + deactivate -rm -rf build - -cd - + rm -rf build +) diff --git a/build.yaml b/build.yaml index be0072b6..3154b931 100644 --- a/build.yaml +++ b/build.yaml @@ -13,6 +13,10 @@ # --- include: + - board: nice_nano_v2 + shield: temper_left + - board: nice_nano_v2 + shield: temper_right - board: nice_nano_v2 shield: temper_dongle_left - board: nice_nano_v2 From e662c4ae15b1bd9c4efd3387de604c284d316479 Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:43:56 +0200 Subject: [PATCH 7/8] chore: remove keyboard drawing and .vscode directory --- .github/workflows/doc.yml | 25 - .vscode/settings.json | 5 - keymap_img/*.yaml | 0 keymap_img/keymap_drawer.config.yaml | 317 ------------ keymap_img/temper.svg | 698 --------------------------- keymap_img/temper.yaml | 159 ------ 6 files changed, 1204 deletions(-) delete mode 100644 .github/workflows/doc.yml delete mode 100644 .vscode/settings.json delete mode 100644 keymap_img/*.yaml delete mode 100644 keymap_img/keymap_drawer.config.yaml delete mode 100644 keymap_img/temper.svg delete mode 100644 keymap_img/temper.yaml diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml deleted file mode 100644 index 437b79df..00000000 --- a/.github/workflows/doc.yml +++ /dev/null @@ -1,25 +0,0 @@ -name: draw keymap - -on: - workflow_dispatch: # can be triggered manually - push: # automatically run on changes to following paths - paths: - - ".github/workflows/doc.yml" - - "keymap_img/keymap_drawer.config.yaml" - - "config/*.keymap" - - "config/*.dtsi" - - "boards/*/*/*.keymap" - - "boards/*/*/*.dtsi" - -jobs: - draw: - uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main - permissions: - contents: write # allow workflow to commit to the repo - with: - commit_message: "doc: update keymap image" # commit message for the changes - keymap_patterns: "boards/*/*/*.keymap" # path to the keymaps to parse - config_path: "keymap_img/keymap_drawer.config.yaml" # config file, ignored if it does not exist - output_folder: "keymap_img" # path to save produced SVG and keymap YAML files - parse_args: "temper:'-c 10'" # map of extra args to pass to `keymap parse`, e.g. "corne:'-l Def Lwr Rse' cradio:''" - draw_args: "temper:'-k chocofi -s default num nav fun'" # map of extra args to pass to `keymap draw`, e.g. "corne:'-k corne_rotated' cradio:'-k paroxysm'" \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index b4d63a89..00000000 --- a/.vscode/settings.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "files.associations": { - "*.keymap": "c" - } -} \ No newline at end of file diff --git a/keymap_img/*.yaml b/keymap_img/*.yaml deleted file mode 100644 index e69de29b..00000000 diff --git a/keymap_img/keymap_drawer.config.yaml b/keymap_img/keymap_drawer.config.yaml deleted file mode 100644 index b518e248..00000000 --- a/keymap_img/keymap_drawer.config.yaml +++ /dev/null @@ -1,317 +0,0 @@ -draw_config: - append_colon_to_layer_header: true - arc_radius: 6.0 - arc_scale: 1.0 - combo_h: 26.0 - combo_w: 28.0 - inner_pad_h: 2.0 - inner_pad_w: 2.0 - key_h: 56.0 - key_rx: 6.0 - key_ry: 6.0 - key_w: 60.0 - line_spacing: 1.2 - outer_pad_h: 56.0 - outer_pad_w: 30.0 - small_pad: 2.0 - split_gap: 30.0 - svg_style: | - /* font and background color specifications */ - svg { - font-family: SFMono-Regular,Consolas,Liberation Mono,Menlo,monospace; - font-size: 14px; - font-kerning: normal; - text-rendering: optimizeLegibility; - fill: #24292e; - } - - /* default key styling */ - rect { - fill: #f6f8fa; - stroke: #c9cccf; - stroke-width: 1; - } - - /* color accent for combo boxes */ - rect.combo { - fill: #cdf; - } - - /* color accent for held keys */ - rect.held, rect.combo.held { - fill: #fdd; - } - - /* color accent for ghost (optional) keys */ - rect.ghost, rect.combo.ghost { - fill: #ddd; - } - - text { - text-anchor: middle; - dominant-baseline: middle; - } - - /* styling for layer labels */ - text.label { - font-weight: bold; - text-anchor: start; - stroke: white; - stroke-width: 2; - paint-order: stroke; - } - - /* styling for combo tap, and key hold/shifted label text */ - text.combo, text.hold, text.shifted { - font-size: 11px; - } - - text.hold { - text-anchor: middle; - dominant-baseline: auto; - } - - text.shifted { - text-anchor: middle; - dominant-baseline: hanging; - } - - /* styling for hold/shifted label text in combo box */ - text.combo.hold, text.combo.shifted { - font-size: 8px; - } - - /* styling for combo dendrons */ - path { - stroke-width: 1; - stroke: gray; - fill: none; - } -parse_config: - assign_combos_to_layers: false - preprocess: true - qmk_keycode_map: - AMPERSAND: '&' - AMPR: '&' - ASTERISK: '*' - ASTR: '*' - AT: '@' - BACKSLASH: \ - BSLS: \ - CIRC: ^ - CIRCUMFLEX: ^ - COLN: ':' - COLON: ':' - COMM: ',' - COMMA: ',' - DLR: $ - DOLLAR: $ - DOT: . - DOUBLE_QUOTE: '"' - DQT: '"' - DQUO: '"' - EQL: '=' - EQUAL: '=' - EXCLAIM: '!' - EXLM: '!' - GRAVE: '`' - GRV: '`' - GT: '>' - HASH: '#' - LABK: < - LBRC: '[' - LCBR: '{' - LEFT_ANGLE_BRACKET: < - LEFT_BRACKET: '[' - LEFT_CURLY_BRACE: '{' - LEFT_PAREN: ( - LPRN: ( - LT: < - MINS: '-' - MINUS: '-' - 'NO': '' - NONUS_HASH: '#' - NUHS: '#' - PERC: '%' - PERCENT: '%' - PIPE: '|' - PLUS: + - QUES: '?' - QUESTION: '?' - QUOT: '''' - QUOTE: '''' - RABK: '>' - RBRC: ']' - RCBR: '}' - RIGHT_ANGLE_BRACKET: '>' - RIGHT_BRACKET: ']' - RIGHT_CURLY_BRACE: '}' - RIGHT_PAREN: ) - RPRN: ) - SCLN: ; - SEMICOLON: ; - SLASH: / - SLSH: / - TILD: '~' - TILDE: '~' - TRANSPARENT: '' - TRNS: '' - UNDERSCORE: _ - UNDS: _ - SPACE: ⎵ - raw_binding_map: - '&mm_grescm': {t: '⎋', s: '` ~'} - '&mm_bspc_del': {t: '⌫', s: '⌦'} - '&bspc_del': {t: '⌫', s: '⌦'} - '&mm_grescm_gui': {t: ⎋, h: ⌘, s: '~ `'} - '&mm_spc_unds_layer': {t: '⎵', h: 'SYM', s: '_ -'} - '&mm_plus_minus': {t: '+', s: '-'} - '&mm_grave_caret': {t: '`', s: '^'} - '&mm_bracket_r': {t: '(', s: ')'} - '&mm_comma_semi_meh': {t: ',', s: ';', h: 'MEH'} - '&mm_dot_colon': {t: '.', s: ':'} - '&mm_none_undo': '' - '&mm_left_word_cut': '↞' - '&mm_up_save': '↑' - '&mm_down_copy': '↓' - '&mm_none_paste': '' - '&mm_1_cut': '1' - '&mm_2_copy': '2' - '&mm_5_save': '5' - '&swapper_cmd_tab': {t: '⌘↹'} - '&td_at_email': {t: '@'} - '&num_word': 'NUM' - '&nav_word': 'NAV' - '&caps_word_capslock': "Caps\nWord" - '&caps_word': '⇪' - '&td_shift_l': '⇧' - '&td_shift_r': '⇧' - '&td_nav_layer': {t: '⏎', h: 'NAV'} - '&td_bt_clear': 'BT CLR' - '&m_type_md_code_block': '```' - '&kt LSHFT': "⇧\nLock" - '<_num_word 4 0': {t: "Num\nWord", h: 'Num'} - '<og LGUI 5': {t: "Cancel\nNav", h: '⌘'} - '<og LGUI 6': {t: "Cancel\nNum", h: '⌘'} - '<og LGUI 7': {t: "Cancel\nSym", h: '⌘'} - '<og LGUI 8': {t: "Cancel\nFunc", h: '⌘'} - '<og LGUI 9': {t: "Cancel\nAdjust", h: '⌘'} - skip_binding_parsing: false - zmk_keycode_map: - AMPERSAND: '&' - AMPS: '&' - APOS: {t: "'", s: '"'} - APOSTROPHE: < - ASTERISK: '*' - ASTRK: '*' - AT: '@' - AT_SIGN: '@' - BACKSLASH: {t: '\', s: '|'} - BSLH: \ - CARET: ^ - COLON: ':' - COMMA: {t: ',', s: '<'} - DLLR: $ - DOLLAR: $ - DOT: {t: '.', s: '>'} - DOUBLE_QUOTES: '"' - DQT: '"' - EQUAL: {t: '=', s: '+'} - EXCL: '!' - EXCLAMATION: '!' - FSLH: / - GRAVE: {t: '`', s: '~'} - GREATER_THAN: '>' - GT: '>' - HASH: '#' - LBKT: {t: '[', s: '{'} - LBRC: '{' - LEFT_BRACE: '{' - LEFT_BRACKET: '[' - LEFT_PARENTHESIS: ( - LESS_THAN: < - LPAR: ( - LT: < - MINUS: {t: '-', s: '_'} - NON_US_BACKSLASH: \ - NON_US_BSLH: '|' - NON_US_HASH: '#' - NUHS: '#' - PERCENT: '%' - PERIOD: . - PIPE: '|' - PIPE2: '|' - PLUS: + - POUND: '#' - PRCNT: '%' - QMARK: '?' - QUESTION: '?' - RBKT: {t: ']', s: '}'} - RBRC: '}' - RIGHT_BRACE: '}' - RIGHT_BRACKET: ']' - RIGHT_PARENTHESIS: ) - RPAR: ) - SEMI: {t: ';', s: ':'} - SEMICOLON: {t: ';', s: ':'} - SINGLE_QUOTE: {t: '''', s: '"'} - SLASH: {t: '/', s: '?'} - SQT: '''' - STAR: '*' - TILDE: '~' - TILDE2: '~' - UNDER: _ - UNDERSCORE: _ - LCTRL: ⌃ - LALT: ⎇ - LGUI: ⌘ - LSHFT: ⇧ - RCTRL: ⌃ - LEFT_CONTROL: ⌃ - LEFT_ALT: ⎇ - LEFT_GUI: ⌘ - LEFT_SHFT: ⇧ - RALT: ⎇ - RGUI: ⌘ - RSHFT: ⇧ - RIGHT_CONTROL: ⌃ - RIGHT_ALT: ⎇ - RIGHT_GUI: ⌘ - RIGHT_SHFT: ⇧ - LEFT: ← - RIGHT: → - UP: ↑ - DOWN: ↓ - TAB: ↹ - RETURN: '⏎' - ESCAPE: '⎋' - C_REWIND: '⏮' - C_FAST_FORWARD: '⏭' - C_PAUSE: '⏯' - C_MUTE: "VOL\nMUTE" - C_VOLUME_DOWN: "VOL\nDOWN" - C_VOLUME_UP: "VOL\nUP" - C_BRIGHTNESS_DEC: '☀↓' - C_BRIGHTNESS_INC: '☀↑' - LA(LEFT): ↞ - LA(RIGHT): ↠ - LG(LEFT): ⇤ - LG(RIGHT): ⇥ - 'LS(LC(LG(LALT)))': 'HYPER' - 'RS(RC(RG(RALT)))': 'HYPER' - 'LC(LG(LALT))': 'MEH' - 'RC(RG(RALT))': 'MEH' - 'LG(Q)': '⌘Q' - 'LG(W)': '⌘W' - 'LG(GRAVE)': '⌘`' - 'LG(Z)': '⌘Z' - 'LG(X)': '⌘X' - 'LG(C)': '⌘C' - 'LG(V)': '⌘V' - 'LC(TAB)': '⌃↹' - 'LS(LC(TAB))': '⌃⇧↹' -# zmk_combos: -# combo_tog_nav_word: {'a': 'bottom', 'o': -0.25} -# combo_tog_num_word: {'a': 'bottom', 'o': 0.0} -# combo_return: {'a': 'bottom', 'o': 0.3} -# combo_capsword: {'k': "Caps\nWord"} diff --git a/keymap_img/temper.svg b/keymap_img/temper.svg deleted file mode 100644 index 591ac8de..00000000 --- a/keymap_img/temper.svg +++ /dev/null @@ -1,698 +0,0 @@ - - - -default: - - - -Q - - - -W - - - -F - - - -P - - - -B - - - -J - - - -L - - - -U - - - -Y - - - -' -" - - - -A - - - -R - - - -S - - - -T - - - -G - - - -M - - - -N - - - -E - - - -I - - - -O - - - -Z - - - -X - - - -C - - - -D - - - -V - - - -K - - - -H - - - -, -; - - - -. -: - - - -? -! - - - -⌘ - - - -num - - - -⇧ -⇪ - - - -SPACE - - - -nav - - - -BACKSPACE -Alt+ BACKS… - - - - -num: - - - -~ - - - -@ - - - -{ - - - -} - - - -% - - - -* - - - -7 - - - -8 - - - -9 - - - -- -_ - - - -^ - - - -# - - - -( - - - -) - - - -$ - - - -_ - - - -4 - - - -5 - - - -6 - - - -+ - - - -& -| - - - -< - - - -[ -{ - - - -] -} - - - -> - - - -/ -\ - - - -1 - - - -2 - - - -3 - - - -= -+ - - - -▽ - - - - - - -▽ - - - -0 - - - -▽ - - - -▽ - - - - -nav: - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -HOME - - - -END - - - -↹ - - - -BACKSPACE -Alt+ BACKS… - - - -⇧ -sticky - - - -⌃ -sticky - - - -⎇ -sticky - - - -⌘ -sticky - - - -↹ - - - -← - - - -↓ - - - -↑ - - - -→ - - - -ESC -` - - - -▽ - - - -DEL - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -RET - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - -▽ - - - - - - -▽ - - - - -fun: - - - -qwerty -toggle - - - -MUTE - - - - -VOLDN - - - - - -VOLUP - - - - - -OUTTOG - - - - -▽ - - - -F7 - - - -F8 - - - -F9 - - - -F12 - - - -BT -0 - - - -BT -1 - - - -BT -2 - - - -BT -3 - - - -BT -4 - - - -▽ - - - -F4 - - - -F5 - - - -F6 - - - -F11 - - - - -BTCLR - - - - -PREV - - - -PP - - - -NEXT - - - -▽ - - - -▽ - - - -F1 - - - -F2 - - - -F3 - - - -F10 - - - -▽ - - - - - - -▽ - - - -▽ - - - - - - -▽ - - - - diff --git a/keymap_img/temper.yaml b/keymap_img/temper.yaml deleted file mode 100644 index 6df0156e..00000000 --- a/keymap_img/temper.yaml +++ /dev/null @@ -1,159 +0,0 @@ -layers: - default: - - - Q - - W - - F - - P - - B - - J - - L - - U - - Y - - {t: '''', s: '"'} - - [A, R, S, T, G, M, N, E, I, O] - - - Z - - X - - C - - D - - V - - K - - H - - {t: ',', s: ;} - - {t: ., s: ':'} - - {t: '?', s: '!'} - - - ⌘ - - num - - {t: ⇧, s: ⇪} - - SPACE - - nav - - {t: BACKSPACE, s: Alt+ BACKSPACE} - qwerty: - - [Q, W, E, R, T, Y, U, I, O, P] - - - A - - S - - D - - F - - G - - H - - J - - K - - L - - {t: ;, s: ':'} - - - Z - - X - - C - - V - - B - - N - - M - - {t: ',', s: <} - - {t: ., s: '>'} - - / - - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - num: - - - '~' - - '@' - - '{' - - '}' - - '%' - - '*' - - '7' - - '8' - - '9' - - {t: '-', s: _} - - [^, '#', (, ), $, _, '4', '5', '6', +] - - - {t: '&', s: '|'} - - < - - {t: '[', s: '{'} - - {t: ']', s: '}'} - - '>' - - {t: /, s: \} - - '1' - - '2' - - '3' - - {t: '=', s: +} - - - {t: ▽, type: trans} - - {type: held} - - {t: ▽, type: trans} - - '0' - - {t: ▽, type: trans} - - {t: ▽, type: trans} - nav: - - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - HOME - - END - - ↹ - - {t: BACKSPACE, s: Alt+ BACKSPACE} - - - {t: ⇧, h: sticky} - - {t: ⌃, h: sticky} - - {t: ⎇, h: sticky} - - {t: ⌘, h: sticky} - - ↹ - - ← - - ↓ - - ↑ - - → - - {t: ESC, s: '`'} - - - {t: ▽, type: trans} - - DEL - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - RET - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {type: held} - - {t: ▽, type: trans} - fun: - - - {t: qwerty, h: toggle} - - MUTE - - VOL DN - - VOL UP - - OUT TOG - - {t: ▽, type: trans} - - F7 - - F8 - - F9 - - F12 - - - {t: BT, h: '0'} - - {t: BT, h: '1'} - - {t: BT, h: '2'} - - {t: BT, h: '3'} - - {t: BT, h: '4'} - - {t: ▽, type: trans} - - F4 - - F5 - - F6 - - F11 - - - BT CLR - - PREV - - PP - - NEXT - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - F1 - - F2 - - F3 - - F10 - - - {t: ▽, type: trans} - - {type: held} - - {t: ▽, type: trans} - - {t: ▽, type: trans} - - {type: held} - - {t: ▽, type: trans} From cc93a9d4f83d27cf1cae1d25f6a6db1c9efe2b4c Mon Sep 17 00:00:00 2001 From: Zeljko Bekcic Date: Sat, 13 Jul 2024 15:49:10 +0200 Subject: [PATCH 8/8] doc: update comment about this repo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d52f0cf7..bed49d92 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Temper ZMK Config -This is my personal ZMK config for the [temper](https://github.com/raeedcho/temper). +This is my personal ZMK config for the [temper](https://github.com/raeedcho/temper). This repository contains zmk configuration for the Temper keyboard using two microcontrollers and additionally on configuration using a dongle which is connected to your computer via cable. ## How to build locally