Merge pull request #216 from noar-t/main

Add quefrency shield

.github/workflows/build.yml

@@ -21,6 +21,8 @@ jobs:
           - romac
           - romac_plus
           - settings_reset
+          - quefrency_left
+          - quefrency_right
         include:
           - board: proton_c
             shield: clueboard_california

app/boards/shields/quefrency/Kconfig.defconfig

@@ -0,0 +1,17 @@
+#Copyright (c) 2020 The ZMK Contributors
+#SPDX-License-Identifier: MIT
+ 
+ 
+if SHIELD_QUEFRENCY_LEFT
+
+config ZMK_KEYBOARD_NAME
+	default "Quefrency Left"
+
+endif
+
+if SHIELD_QUEFRENCY_RIGHT
+
+config ZMK_KEYBOARD_NAME
+	default "Quefrency Right"
+
+endif

app/boards/shields/quefrency/Kconfig.shield

@@ -0,0 +1,8 @@
+# Copyright (c) 2020 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config SHIELD_QUEFRENCY_LEFT
+	def_bool $(shields_list_contains,quefrency_left)
+
+config SHIELD_QUEFRENCY_RIGHT
+	def_bool $(shields_list_contains,quefrency_right)

app/boards/shields/quefrency/quefrency.dtsi

@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <dt-bindings/zmk/matrix-transform.h>
+
+/ {
+	chosen {
+	    zmk,kscan = &kscan0;
+
+	    zmk,matrix_transform = &default_transform;
+	};
+
+	/* 
+	 * This transform correspondsto the 60% left without macro keypad and 65% right, even this
+	 * combination of PCBs can have keys in different locations based on configuration.
+	 */
+	default_transform: keymap_transform_0 {
+		compatible = "zmk,matrix-transform";
+		columns = <15>;
+		rows = <6>;
+		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(0,12)   RC(0,14)     RC(5,13)     
+RC(1,0)     RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)       /**/RC(1,7) RC(1,8) RC(1,9) RC(1,10) RC(1,11) RC(1,12) RC(1,13)   RC(1,14)  RC(5,14)
+RC(2,0)       RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)     /**/ RC(2,7) RC(2,8) RC(2,9) RC(2,10) RC(2,11) RC(2,12)     RC(2,14)       RC(2,13) 
+RC(3,0)          RC(3,2) RC(3,3) RC(3,4) RC(3,5) RC(3,6)  /**/   RC(3,7) RC(3,8) RC(3,9) RC(3,10) RC(3,12)     RC(3,13)     RC(3,14) RC(3,11) 
+RC(4,0)  RC(4,1)  RC(4,2)         RC(4,4)         RC(4,6) /**/   RC(4,7)                 RC(4,10) RC(4,11) RC(4,12) RC(4,13) RC(4,14) RC(4,9) 
+		>;
+	};
+};

app/boards/shields/quefrency/quefrency.keymap

@@ -0,0 +1,51 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <behaviors.dtsi>
+#include <dt-bindings/zmk/bt.h>
+#include <dt-bindings/zmk/keys.h>
+
+/ {
+    keymap {
+        compatible = "zmk,keymap";
+
+// ----------------------------------------------      -----------------------------------------------------
+// | ESC  |  1   |  2  |  3   |  4  |  5  |  6  |      |  7  |  8  |  9  |  0  |  -  |  =  |  BKSPC |  `   |
+// | TAB   |  Q   |  W  |  E   |  R  |  T  |        |  Y  |  U  |  I  |  O  |  P  |  [  |  ]  |  \  | DEL  |
+// | LCTRL  |  A   |  S  |  D   |  F  |  G  |        |  H  |  J  |  K  |  L  |  ;  |  '  |   ENTER  | PGUP |
+// | SHIFT   |  Z   |  X  |  C  |  V   |  B  |        |  N  |  M  |  ,  |  .  |  /  |  RSHFT  |  UP | PGDN |
+// | LCTRL   | LGUI | LALT |   SPACE   | FN  |        |    SPACE    | RALT | FN | RCTRL | LFT | DWN | RGHT |
+// -------------------------------------------        ------------------------------------------------------
+
+        default_layer {
+            bindings = <
+    &kp ESC  &kp NUM_1 &kp NUM_2 &kp NUM_3 &kp NUM_4 &kp NUM_5 &kp NUM_6 /**/ &kp NUM_7 &kp NUM_8 &kp NUM_9 &kp NUM_0 &kp MINUS &kp EQL  &kp BKSP &kp GRAV
+    &kp TAB  &kp Q     &kp W     &kp E     &kp R     &kp T               /**/ &kp Y     &kp U     &kp I     &kp O     &kp P     &kp LBKT &kp RBKT &kp BSLH &kp HOME
+    &kp LCTL &kp A     &kp S     &kp D     &kp F     &kp G               /**/ &kp H     &kp J     &kp K     &kp L     &kp SCLN  &kp QUOT &kp RET  &kp PGUP 
+    &kp LSFT &kp Z     &kp X     &kp C     &kp V     &kp B               /**/ &kp N     &kp M     &kp CMMA  &kp DOT   &kp FSLH  &kp RSFT &kp UARW &kp PGDN 
+    &kp LCTL &kp LGUI  &kp LALT  &kp SPC   &mo 1                         /**/ &kp SPC   &kp RALT  &mo 1     &kp RCTL  &kp LARW  &kp DARW &kp RARW
+            >;
+        };
+
+// ----------------------------------------------     -----------------------------------------------------
+// |BT_CLR|  F1  |  F2 |  F3  |  F4 |  F5 |  F6 |     |  F7 |  F8 |  F9 | F10 | F11 | F12 |        |BT_CLR| 
+// |       | BT-0 | BT-1| BT-2 |     |     |       |     |     |     |     |     |     |     |     |      |
+// |        |      |     |      |     |     |       |     |     |     |     |     |     |          |      |
+// |         |      |     |     |      |     |       |     |     |     |     |     |         |     |      |
+// |         |      |      |           |     |       |             |      |    |       |     |     |      |
+// -------------------------------------------       ------------------------------------------------------
+
+        fn_layer {
+            bindings = <
+    &bt BT_CLR &kp F1       &kp F2       &kp F3       &kp F4 &kp F5 &kp F6 /**/ &kp F7 &kp F8 &kp F9 &kp F10 &kp F11 &kp F12 &trans &bt BT_CLR
+    &trans     &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &trans &trans        /**/ &trans &trans &trans &trans  &trans  &trans  &trans &trans &trans
+    &trans     &trans       &trans       &trans       &trans &trans        /**/ &trans &trans &trans &trans  &trans  &trans  &trans &trans
+    &trans     &trans       &trans       &trans       &trans &trans        /**/ &trans &trans &trans &trans  &trans  &trans  &trans &trans
+    &trans     &trans       &trans       &trans       &trans               /**/ &trans &trans &trans &trans  &trans  &trans  &trans       
+            >;
+        };
+    };
+};

app/boards/shields/quefrency/quefrency_left.conf

@@ -0,0 +1,2 @@
+CONFIG_ZMK_SPLIT=y
+CONFIG_ZMK_SPLIT_BLE_ROLE_CENTRAL=y

app/boards/shields/quefrency/quefrency_left.overlay

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "quefrency.dtsi"
+
+/ {
+    /* This kscan is for the 60% left half without macro keys the
+     * macro pad layout may require different column and row pins
+     */
+    kscan0: kscan {
+        compatible = "zmk,kscan-gpio-matrix";
+        label = "KSCAN";
+        diode-direction = "col2row";
+
+
+        col-gpios
+            = <&pro_micro_a  2 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_a  1 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_a  0 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 15 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 14 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 16 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 10 GPIO_ACTIVE_HIGH>
+            ;
+
+        row-gpios
+            = <&pro_micro_a 3 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_d 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 8 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            ;
+    };
+};

app/boards/shields/quefrency/quefrency_right.conf

@@ -0,0 +1,2 @@
+CONFIG_ZMK_SPLIT=y
+CONFIG_ZMK_SPLIT_BLE_ROLE_PERIPHERAL=y

app/boards/shields/quefrency/quefrency_right.overlay

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2020 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "quefrency.dtsi"
+
+&default_transform {
+    col-offset = <7>;
+};
+
+/ {
+
+    /* This kscan is for the 65% right half the 60% right half 
+     * may require different column and row pins
+     */
+    kscan0: kscan {
+        compatible = "zmk,kscan-gpio-matrix";
+        label = "KSCAN";
+        diode-direction = "col2row";
+
+
+
+        col-gpios
+            = <&pro_micro_a  2 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_a  1 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_a  0 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 15 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 14 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 16 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d 10 GPIO_ACTIVE_HIGH>
+            , <&pro_micro_d  5 GPIO_ACTIVE_HIGH>
+            ;
+
+        row-gpios
+            = <&pro_micro_a 3 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_d 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 8 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro_a 9 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            ;
+    };
+};