add-keymap-drawer

Add keymap drawer

Author: thrly

.github/workflows/draw-keymap.yml

@@ -0,0 +1,30 @@
+# Use the keymap-drawer ZMK user config workflow
+# https://github.com/caksoylar/keymap-drawer#setting-up-an-automated-drawing-workflow
+name: Draw ZMK keymaps
+on:
+  workflow_dispatch: # can be triggered manually
+  push: # automatically run on changes to following paths
+    paths:
+      - "config/*.keymap"
+      - "config/*.dtsi"
+      - "keymap_drawer.config.yaml"
+      - ".github/workflows/draw-keymaps.yml"
+      - "img/keymap-img/keymap_drawer.config.yaml"
+      # - 'boards/*/*/*.keymap'
+
+jobs:
+  draw:
+    uses: caksoylar/keymap-drawer/.github/workflows/draw-zmk.yml@main
+    permissions:
+      contents: write # allow workflow to commit to the repo
+    with:
+      keymap_patterns: "config/*.keymap" # path to the keymaps to parse
+      config_path: "img/keymap-img/keymap_drawer.config.yaml" # config file, ignored if not exists
+      output_folder: "img/keymap-img" # path to save produced SVG and keymap YAML files
+      json_path: "config"
+      # extra_keymap_yaml: "${keyboard}: 'images/keymap-img/combos.yaml'"
+      parse_args: "" # map of extra args to pass to `keymap parse`, e.g. "corne:'-l Def Lwr Rse' cradio:''"
+      draw_args: "" # map of extra args to pass to `keymap draw`, e.g. "corne:'-k corne_rotated' cradio:'-k paroxysm'"
+      amend_commit: true # amend generated files to commit that produces them
+      fail_on_error: true
+      debug_mode: false

README.md

@@ -2,12 +2,9 @@
 
 ![](https://github.com/thrly/thrly-corne-zmk/actions/workflows/build.yml/badge.svg)
 
-> This config is for a 6-col corne (wireless version from [Typeractive](https://typeractive.xyz/)), but I'm gradually trying to wittle it down to a smaller custom 36-key 5-col that I'm designing myself...
+This config is for a 6-col corne (wireless version from [Typeractive](https://typeractive.xyz/)), but I've consolidated to a 36-key 5col board I designed myself: [TEMPEST](https://github.com/thrly/tempest). This layout makes that transition very easy.
 
-For more explanations and reflections on this customization, see [my blog post](https://thrly.com/blog/thoughts-on-customising-a-split-keyboard-layout/) on this keymap.
-
-> [!WARNING]
-> This is my personal daily driver keyboard config, it is under active development. Expect tweaking and occasional breaking changes. Documentation may be missing or out of sync with the latest commits. Proceed with caution.
+> For more explanations and reflections on this customization, see [my blog post](https://thrly.com/blog/thoughts-on-customising-a-split-keyboard-layout/) on this keymap.
 
 ![cat paws and keyboard closeup](./img/cat-corne.jpg)
 
@@ -19,12 +16,14 @@ For more explanations and reflections on this customization, see [my blog post](
 - Mouse behavior on Nav layer
 - Horizontal Num layer
 - Thumb keys transparent on layers (for `Ctrl` and `Shift`)
+- `Shift` morphs `Space` to `_`. Useful for `TYPING_CAPS_VARIABLES`
 - Combos:
   - volume up / down (outer right top + middle / middle + bottom)
   - caps word / caps lock (`G`+`J` / `T`+`Y`)
   - escape (`Q`+`W`)
   - delete (`O`+`P`)
   - dash, underscore (`E`+`R`, `U`+`I`) 
+  - single quotes, double quotes (`U`+`J`, `I`+`J`) 
 - Macros:
   - double-tap `>` for `=>` arrow
   - en-dash (` -- `) combo (`W`+`E`+`R`)
@@ -34,25 +33,9 @@ For more explanations and reflections on this customization, see [my blog post](
 
 ## Layers
 
-### Base layer
-
-![Base keymap diagram](./img/corne-base-layer.png)
-
-### Symbol layer
-
-![Symbol keymap diagram](./img/corne-symbol-layer.png)
-
-### Nav layer
-
-![Nav keymap diagram](./img/corne-nav-layer.png)
-
-### Num layer
-
-![Num keymap diagram](./img/corne-num-layer.png)
-
-### Layer 4
+![keymap diagram](./img/keymap-img/corne.svg)
 
-Nothing special here, left side features bluetooth connection profiles, right side has mouse controls with more room for buttons than on the Nav layer. \[TODO: add image]
+Drawn with [Keymap-Drawer](https://github.com/caksoylar/keymap-drawer)
 
 ## Other
 

config/corne.dtsi

@@ -0,0 +1,94 @@
+/*
+ * Copyright (c) 2020 Pete Johanson
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <dt-bindings/zmk/matrix_transform.h>
+
+#include <layouts/foostan/corne/5column.dtsi>
+#include <layouts/foostan/corne/6column.dtsi>
+
+&foostan_corne_6col_layout {
+    transform = <&default_transform>;
+};
+
+&foostan_corne_5col_layout {
+    transform = <&five_column_transform>;
+};
+
+/ {
+    chosen {
+        zephyr,display = &oled;
+        zmk,kscan = &kscan0;
+        zmk,physical-layout = &foostan_corne_6col_layout;
+    };
+
+    default_transform: keymap_transform_0 {
+        compatible = "zmk,matrix-transform";
+        columns = <12>;
+        rows = <4>;
+// | SW1  | SW2  | SW3  | SW4  | SW5  | SW6  |   | SW6  | SW5  | SW4  | SW3  | SW2  | SW1  |
+// | SW7  | SW8  | SW9  | SW10 | SW11 | SW12 |   | SW12 | SW11 | SW10 | SW9  | SW8  | SW7  |
+// | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 | SW15 | SW14 | SW13 |
+//                      | SW19 | SW20 | SW21 |   | SW21 | SW20 | SW19 |
+        map = <
+RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)  RC(0,6) RC(0,7) RC(0,8) RC(0,9) RC(0,10) RC(0,11)
+RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)  RC(1,6) RC(1,7) RC(1,8) RC(1,9) RC(1,10) RC(1,11)
+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) RC(2,10) RC(2,11)
+                        RC(3,3) RC(3,4) RC(3,5)  RC(3,6) RC(3,7) RC(3,8)
+        >;
+    };
+
+    five_column_transform: keymap_transform_1 {
+        compatible = "zmk,matrix-transform";
+        columns = <10>;
+        rows = <4>;
+// | SW2  | SW3  | SW4  | SW5  | SW6  |   | SW6  | SW5  | SW4  | SW3  | SW2  |
+// | SW8  | SW9  | SW10 | SW11 | SW12 |   | SW12 | SW11 | SW10 | SW9  | SW8  |
+// | SW14 | SW15 | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 | SW15 | SW14 |
+//               | SW19 | SW20 | SW21 |   | SW21 | SW20 | SW19 |
+        map = <
+RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)  RC(0,6) RC(0,7) RC(0,8) RC(0,9) RC(0,10)
+RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)  RC(1,6) RC(1,7) RC(1,8) RC(1,9) RC(1,10)
+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) RC(2,10)
+                        RC(3,3) RC(3,4) RC(3,5)  RC(3,6) RC(3,7) RC(3,8)
+        >;
+    };
+
+    kscan0: kscan {
+        compatible = "zmk,kscan-gpio-matrix";
+        wakeup-source;
+
+        diode-direction = "col2row";
+        row-gpios
+            = <&pro_micro 4 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro 5 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            ;
+
+    };
+
+    // TODO: per-key RGB node(s)?
+};
+
+&pro_micro_i2c {
+    status = "okay";
+
+    oled: ssd1306@3c {
+        compatible = "solomon,ssd1306fb";
+        reg = <0x3c>;
+        width = <128>;
+        height = <32>;
+        segment-offset = <0>;
+        page-offset = <0>;
+        display-offset = <0>;
+        multiplex-ratio = <31>;
+        segment-remap;
+        com-invdir;
+        com-sequential;
+        inversion-on;
+        prechargep = <0x22>;
+    };
+};

config/corne.keymap

@@ -4,11 +4,9 @@
  * SPDX-License-Identifier: MIT
  */
 
+
 #define ZMK_POINTING_DEFAULT_MOVE_VAL 800  // default: 600
 #define ZMK_POINTING_DEFAULT_SCRL_VAL 20    // default: 10
-#define KEYS_L LT0 LT1 LT2 LT3 LT4 LT5 LM0 LM1 LM2 LM3 LM4 LM5 LB0 LB1 LB2 LB3 LB4 LB5  // Left-hand keys.
-#define KEYS_R RT0 RT1 RT2 RT3 RT4 RT5 RM0 RM1 RM2 RM3 RM4 RM5 RB0 RB1 RB2 RB3 RB4 RB5  // Right-hand keys.
-#define THUMBS LH2 LH1 LH0 RH0 RH1 RH2
 
 #include <zmk-helpers/key-labels/42.h>
 #include <behaviors.dtsi>
@@ -42,51 +40,73 @@
         caps_word {
             bindings = <&caps_word>;
             key-positions = <17 18>;
+            layers = <0>;
         };
 
         esc {
             bindings = <&kp ESCAPE>;
             key-positions = <1 2>;
+            layers = <0>;
         };
 
         vol_up {
             bindings = <&kp C_VOLUME_UP>;
             key-positions = <11 23>;
+            layers = <0>;
         };
 
-        vol_down {
+        combo_vol_down {
             bindings = <&kp C_VOLUME_DOWN>;
             key-positions = <23 35>;
+            layers = <0>;
         };
 
-        CAPS_LOCK {
+        combo_CAPS_LOCK {
             bindings = <&kp CAPSLOCK>;
             key-positions = <5 6>;
+            layers = <0>;
         };
 
-        Delete {
+        combo_Delete {
             bindings = <&kp DELETE>;
             key-positions = <10 9>;
+            layers = <0>;
         };
 
-        underscore {
+        combo_underscore {
             bindings = <&kp UNDER>;
             key-positions = <7 8>;
+            layers = <0>;
         };
 
-        dash {
+        combo_dash {
             bindings = <&kp MINUS>;
             key-positions = <4 3>;
+            layers = <0>;
         };
 
-        em-dash {
+        combo_em-dash {
             bindings = <&emdsh>;
             key-positions = <2 3 4>;
+            layers = <0>;
         };
 
-        f19 {
+        combo_f19 {
             bindings = <&kp F19>;
             key-positions = <1 4 7 10>;
+            layers = <0>;
+        };
+
+        combo_single-quote {
+            bindings = <&kp SINGLE_QUOTE>;
+            key-positions = <7 19>;
+            layers = <0>;
+        };
+
+        combo_double-quote {
+            bindings = <&kp AT_SIGN>;
+            key-positions = <8 20>;
+            layers = <0>;
         };
     };
 
@@ -126,6 +146,15 @@
             #binding-cells = <0>;
             bindings = <&kp GREATER_THAN>, <&arrow_func>;
         };
+
+        underspace: underspace {
+            compatible = "zmk,behavior-mod-morph";
+            label = "UNDERSPACE";
+            bindings = <&lt 1 SPACE>, <&kp UNDER>;
+
+            #binding-cells = <0>;
+            mods = <(MOD_RSFT)>;
+        };
     };
 
     keymap {
@@ -142,7 +171,7 @@
 &kp LMETA  &kp Q         &kp W            &kp E              &kp R         &kp T        &kp Y      &kp U            &kp I               &kp O            &kp P                 &kp DELETE
 &kp LCTRL  &bhm LMETA A  &bhm LEFT_ALT S  &bhm LEFT_SHIFT D  &bhm LCTRL F  &kp G        &kp H      &bhm RCTRL J     &bhm RIGHT_SHIFT K  &bhm LEFT_ALT L  &bhm LMETA SEMICOLON  &kp SQT
 &sk LSHFT  &kp Z         &kp X            &kp C              &kp V         &kp B        &kp N      &kp M            &kp COMMA           &kp DOT          &kp FSLH              &kp RIGHT_ALT
-                                          &kp LCTRL          &lt 1 SPACE   &lt 4 TAB    &lt 3 RET  &lt 2 BACKSPACE  &sk RIGHT_SHIFT
+                                          &kp LCTRL          &underspace   &lt 4 TAB    &lt 3 RET  &lt 2 BACKSPACE  &sk RIGHT_SHIFT
             >;
         };