generated from moergo-sc/glove80-zmk-config
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit bb80b9c
Showing
13 changed files
with
397 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| *.keymap linguist-language=C |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| name: Build | ||
|
|
||
| on: [push, pull_request, workflow_dispatch] | ||
|
|
||
| jobs: | ||
| build: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| submodules: recursive | ||
| - uses: actions/checkout@v4 | ||
| with: | ||
| repository: moergo-sc/zmk | ||
| ref: main | ||
| path: src | ||
| - uses: cachix/install-nix-action@v25 | ||
| with: | ||
| nix_path: nixpkgs=channel:nixos-22.05 | ||
| - uses: cachix/cachix-action@v14 | ||
| with: | ||
| name: moergo-glove80-zmk-dev | ||
| skipPush: true | ||
| - name: Build Glove80 combined firmware | ||
| run: nix-build config -o combined | ||
| - name: Copy result out of nix store | ||
| run: cp combined/glove80.uf2 glove80.uf2 | ||
| - name: Upload result | ||
| uses: actions/upload-artifact@v4 | ||
| with: | ||
| name: glove80.uf2 | ||
| path: glove80.uf2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| *~ | ||
| *.uf2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| FROM nixpkgs/nix:nixos-23.11 | ||
|
|
||
| ENV PATH=/root/.nix-profile/bin:/usr/bin:/bin | ||
|
|
||
| RUN <<EOF | ||
| set -euo pipefail | ||
| nix-env -iA cachix -f https://cachix.org/api/v1/install | ||
| cachix use moergo-glove80-zmk-dev | ||
| mkdir /config | ||
| # Mirror ZMK repository to make it easier to reference both branches and | ||
| # tags without remote namespacing | ||
| git clone --mirror https://github.com/moergo-sc/zmk /zmk | ||
| GIT_DIR=/zmk git worktree add --detach /src | ||
| EOF | ||
|
|
||
| # Prepopulate the container's nix store with the build dependencies for the main | ||
| # branch and the most recent three tags | ||
| RUN <<EOF | ||
| cd /src | ||
| for tag in main $(git tag -l --sort=committerdate | tail -n 3); do | ||
| git checkout -q --detach $tag | ||
| nix-shell --run true -A zmk ./default.nix | ||
| done | ||
| EOF | ||
|
|
||
| COPY --chmod=755 <<EOF /bin/entrypoint.sh | ||
| #!/usr/bin/env bash | ||
| set -euo pipefail | ||
| : "\${BRANCH:=main}" | ||
|
|
||
| echo "Checking out \$BRANCH from moergo-sc/zmk" >&2 | ||
| cd /src | ||
| git fetch origin | ||
| git checkout -q --detach "\$BRANCH" | ||
|
|
||
| echo 'Building Glove80 firmware' >&2 | ||
| cd /config | ||
| nix-build ./config --arg firmware 'import /src/default.nix {}' -j2 -o /tmp/combined --show-trace | ||
| install -o "\$UID" -g "\$GID" /tmp/combined/glove80.uf2 ./glove80.uf2 | ||
| EOF | ||
|
|
||
| ENTRYPOINT ["/bin/entrypoint.sh"] | ||
|
|
||
| # Run build.sh to use this file |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2022 MoErgo | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # MoErgo Glove80 Custom Configuration for ZMK | ||
|
|
||
|  | ||
|
|
||
| This repo is the official ZMK configuration of the MoErgo Glove80 wireless split contoured keyboard. Use it to develop your own keymap and easily build your own ZMK firmware to run on your Glove80. | ||
|
|
||
| **NOTE: You can also customize the layout of your Glove80 keyboard with the Glove80 Layout Editor webapp. For most users Glove80 Layout Editor is the recommended and simpler option. More information is available at the official MoErgo Glove80 Support site (see resources below).** | ||
|
|
||
| These steps will get you using your keymap on your keyboard in the fastest time possible. It uses the GitHub Actions feature to build your firmware online. | ||
|
|
||
| If you are looking to dig deeper into ZMK and develop new functionality, it is recommended to follow the steps of installing ZMK as found on the official ZMK documentation site (linked below). | ||
|
|
||
| ## Resources | ||
| - The [official MoErgo Glove80 Support](https://moergo.com/glove80-support) web site. Glove80 documentation and other technical resources. | ||
| - The [official MoErgo Discord Server](https://moergo.com/discord). Instant conversations with other Glove80 users. | ||
|
|
||
| - The [official ZMK Documentation](https://zmk.dev/docs) web site. Find the answers to many of your questions about ZMK Firmware. | ||
| - The [official ZMK Discord Server](https://discord.gg/8cfMkQksSB). Instant conversations with other ZMK developers and users. Great technical resource! | ||
|
|
||
| - The [official Glove80 ZMK Distribution](https://github.com/moergo-sc/zmk). Repositiory for ZMK firmware customized for Glove80. | ||
|
|
||
| ## Instructions | ||
| 1. Log into, or sign up for, your personal GitHub account. | ||
| 2. Create your own repository using this repository as a template ([instructions](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-repository-from-a-template)) and check it out on your local computer. | ||
| 3. Edit the keymap file(s) to suit your needs | ||
| 4. Commit and push your changes to your personal repo. Upon pushing it, GitHub Actions will start building a new version of your firmware with the updated keymap. | ||
|
|
||
| ## Firmware Files | ||
| To locate your firmware files and reflash your Glove80... | ||
| 1. log into GitHub and navigate to your personal config repository you just uploaded your keymap changes to. | ||
| 2. Click "Actions" in the main navigation, and in the left navigation click the "Build" link. | ||
| 3. Select the desired workflow run in the centre area of the page (based on date and time of the build you wish to use). You can also start a new build from this page by clicking the "Run workflow" button. | ||
| 4. After clicking the desired workflow run, you should be presented with a section at the bottom of the page called "Artifacts". This section contains the results of your build, in a file called "glove80.uf2" | ||
| 5. Download the glove80.uf2 | ||
| 6. Flash the firmware to Glove80 according to the user documentation on the official Glove80 Glove80 Support website (linked above) | ||
|
|
||
| Your keyboard is now ready to use. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -euo pipefail | ||
|
|
||
| IMAGE=glove80-zmk-config-docker | ||
| BRANCH="${1:-main}" | ||
|
|
||
| docker build -t "$IMAGE" . | ||
| docker run --rm -v "$PWD:/config" -e UID="$(id -u)" -e GID="$(id -g)" -e BRANCH="$BRANCH" "$IMAGE" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| { pkgs ? import <nixpkgs> {} | ||
| , firmware ? import ../src {} | ||
| }: | ||
|
|
||
| let | ||
| config = ./.; | ||
|
|
||
| glove80_left = firmware.zmk.override { board = "glove80_lh"; keymap = "${config}/glove80.keymap"; kconfig = "${config}/glove80.conf"; }; | ||
| glove80_right = firmware.zmk.override { board = "glove80_rh"; keymap = "${config}/glove80.keymap"; kconfig = "${config}/glove80.conf"; }; | ||
|
|
||
| in firmware.combine_uf2 glove80_left glove80_right |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| /* | ||
| * Copyright (c) 2020 The ZMK Contributors | ||
| * | ||
| * SPDX-License-Identifier: MIT | ||
| */ | ||
|
|
||
| #include <behaviors.dtsi> | ||
| #include <dt-bindings/zmk/keys.h> | ||
| #include <dt-bindings/zmk/bt.h> | ||
| #include <dt-bindings/zmk/ext_power.h> | ||
| #include <dt-bindings/zmk/outputs.h> | ||
| #include <dt-bindings/zmk/rgb.h> | ||
|
|
||
| #define HYPER LC(LS(LG(LALT))) | ||
|
|
||
| // layers | ||
| #define DEFAULT 0 | ||
| #define LOWER 1 | ||
| #define MAGIC 2 | ||
| #define FACTORY_TEST 3 | ||
|
|
||
| / { | ||
| behaviors { | ||
| // For the "layer" key, it'd nice to be able to use it as either a shift or a toggle. | ||
| // Configure it as a tap dance, so the first tap (or hold) is a &mo and the second tap is a &to | ||
| layer_td: tap_dance_0 { | ||
| compatible = "zmk,behavior-tap-dance"; | ||
| label = "LAYER_TAP_DANCE"; | ||
| #binding-cells = <0>; | ||
| tapping-term-ms = <200>; | ||
| bindings = <&mo LOWER>, <&to LOWER>; | ||
| }; | ||
|
|
||
| magic: magic_hold_tap { | ||
| compatible = "zmk,behavior-hold-tap"; | ||
| label = "MAGIC_HOLD_TAP"; | ||
| #binding-cells = <2>; | ||
| flavor = "tap-preferred"; | ||
| tapping-term-ms = <200>; | ||
| bindings = <&mo>, <&rgb_ug_status_macro>; | ||
| }; | ||
| }; | ||
|
|
||
| macros { | ||
| rgb_ug_status_macro: rgb_ug_status_macro_0 { | ||
| label = "RGB_UG_STATUS"; | ||
| compatible = "zmk,behavior-macro"; | ||
| #binding-cells = <0>; | ||
| bindings | ||
| = <&rgb_ug RGB_STATUS>; | ||
| }; | ||
|
|
||
| bt_0: bt_profile_macro_0 { | ||
| label = "BT_0"; | ||
| compatible = "zmk,behavior-macro"; | ||
| #binding-cells = <0>; | ||
| bindings | ||
| = <&out OUT_BLE>, | ||
| <&bt BT_SEL 0>; | ||
| }; | ||
|
|
||
| bt_1: bt_profile_macro_1 { | ||
| label = "BT_1"; | ||
| compatible = "zmk,behavior-macro"; | ||
| #binding-cells = <0>; | ||
| bindings | ||
| = <&out OUT_BLE>, | ||
| <&bt BT_SEL 1>; | ||
| }; | ||
|
|
||
| bt_2: bt_profile_macro_2 { | ||
| label = "BT_2"; | ||
| compatible = "zmk,behavior-macro"; | ||
| #binding-cells = <0>; | ||
| bindings | ||
| = <&out OUT_BLE>, | ||
| <&bt BT_SEL 2>; | ||
| }; | ||
|
|
||
| bt_3: bt_profile_macro_3 { | ||
| label = "BT_3"; | ||
| compatible = "zmk,behavior-macro"; | ||
| #binding-cells = <0>; | ||
| bindings | ||
| = <&out OUT_BLE>, | ||
| <&bt BT_SEL 3>; | ||
| }; | ||
| }; | ||
|
|
||
| keymap { | ||
| compatible = "zmk,keymap"; | ||
|
|
||
| default_layer { | ||
| // --------------------------------------------------------------------------------------------------------------------------------- | ||
| // | F1 | F2 | F3 | F4 | F5 | | F6 | F7 | F8 | F9 | F10 | | ||
| // | = | 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 | - | | ||
| // | TAB | Q | W | E | R | T | | Y | U | I | O | P | \ | | ||
| // | ESC | A | S | D | F | G | | H | J | K | L | ; | ' | | ||
| // | ` | Z | X | C | V | B | LSHFT | LCTRL | LOWER | | LGUI | RCTRL | RSHFT | N | M | , | . | / | PGUP | | ||
| // | MAGIC | HOME| END | LEFT | RIGHT| | BSPC | DEL | LALT | | RALT | RET | SPACE | | UP | DOWN | [ | ] | PGDN | | ||
|
|
||
| bindings = < | ||
| &kp F1 &kp F2 &kp F3 &kp F4 &kp F5 &kp F6 &kp F7 &kp F8 &kp F9 &kp F10 | ||
| &kp EQUAL &kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0 &kp MINUS | ||
| &kp TAB &kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P &kp BSLH | ||
| &kp ESC &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp SQT | ||
| &kp GRAVE &kp Z &kp X &kp C &kp V &kp B &kp LSHFT &kp LCTRL &layer_td &kp LGUI &kp RCTRL &kp RSHFT &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp PG_UP | ||
| &magic MAGIC 0 &kp HOME &kp END &kp LEFT &kp RIGHT &kp BSPC &kp DEL &kp LALT &kp RALT &kp RET &kp SPACE &kp UP &kp DOWN &kp LBKT &kp RBKT &kp PG_DN | ||
| >; | ||
| }; | ||
|
|
||
| lower_layer { | ||
| bindings = < | ||
| &kp C_BRI_DN &kp C_BRI_UP &kp C_PREV &kp C_NEXT &kp C_PP &kp C_MUTE &kp C_VOL_DN &kp C_VOL_UP &none &kp PAUSE_BREAK | ||
| &trans &none &none &none &none &kp HOME &kp LPAR &kp KP_NUM &kp KP_EQUAL &kp KP_DIVIDE &kp KP_MULTIPLY &kp PSCRN | ||
| &trans &none &none &kp UP &none &kp END &kp RPAR &kp KP_N7 &kp KP_N8 &kp KP_N9 &kp KP_MINUS &kp SLCK | ||
| &trans &none &kp LEFT &kp DOWN &kp RIGHT &kp PG_UP &kp PRCNT &kp KP_N4 &kp KP_N5 &kp KP_N6 &kp KP_PLUS &none | ||
| &trans &kp K_CMENU &none &kp F11 &kp F12 &kp PG_DN &trans &trans &to DEFAULT &trans &trans &trans &kp COMMA &kp KP_N1 &kp KP_N2 &kp KP_N3 &kp KP_ENTER &trans | ||
| &trans &kp CAPS &kp INS &kp F11 &kp F12 &trans &trans &trans &trans &trans &trans &kp KP_N0 &kp KP_N0 &kp KP_DOT &kp KP_ENTER &trans | ||
| >; | ||
| }; | ||
|
|
||
| magic_layer { | ||
| bindings = < | ||
| &bt BT_CLR &none &none &none &none &none &none &none &none &bt BT_CLR_ALL | ||
| &none &none &none &none &none &none &none &none &none &none &none &none | ||
| &none &rgb_ug RGB_SPI &rgb_ug RGB_SAI &rgb_ug RGB_HUI &rgb_ug RGB_BRI &rgb_ug RGB_TOG &none &none &none &none &none &none | ||
| &bootloader &rgb_ug RGB_SPD &rgb_ug RGB_SAD &rgb_ug RGB_HUD &rgb_ug RGB_BRD &rgb_ug RGB_EFF &none &none &none &none &none &bootloader | ||
| &sys_reset &none &none &none &none &none &bt_2 &bt_3 &none &none &none &none &none &none &none &none &none &sys_reset | ||
| &none &none &none &none &none &bt_0 &bt_1 &out OUT_USB &none &none &none &none &none &none &none &to FACTORY_TEST | ||
| >; | ||
| }; | ||
|
|
||
| factory_test_layer { | ||
| bindings = < | ||
| &kp N0 &kp N6 &kp N2 &kp N8 &kp N4 &kp N4 &kp N8 &kp N2 &kp N6 &kp N0 | ||
| &kp N1 &kp N7 &kp N3 &kp N9 &kp N5 &kp N0 &kp N0 &kp N5 &kp N9 &kp N3 &kp N7 &kp N1 | ||
| &kp N2 &kp N8 &kp N4 &kp N0 &kp N6 &kp N1 &kp N1 &kp N6 &kp N0 &kp N4 &kp N8 &kp N2 | ||
| &kp N3 &kp N9 &kp N5 &kp N1 &kp N7 &kp N2 &kp N2 &kp N7 &kp N1 &kp N5 &kp N9 &kp N3 | ||
| &kp N4 &kp N0 &kp N6 &kp N2 &kp N8 &kp N3 &kp N4 &kp N5 &kp N6 &kp N6 &kp N5 &kp N4 &kp N3 &kp N8 &kp N2 &kp N6 &kp N0 &kp N4 | ||
| &kp N5 &kp N1 &kp N7 &kp N3 &kp N9 &kp N7 &kp N8 &kp N9 &kp N9 &kp N8 &kp N7 &kp N9 &kp N3 &kp N7 &kp N1 &kp N5 | ||
| >; | ||
| }; | ||
| }; | ||
| }; |
Oops, something went wrong.