feat(boards): Add Zodiark shield

8 files changed, 291 insertions, 0 deletions

diff --git a/app/boards/shields/zodiark/Kconfig.defconfig b/app/boards/shields/zodiark/Kconfig.defconfig
new file mode 100644
index 0000000000..cdad43f6e7
--- /dev/null
+++ b/app/boards/shields/zodiark/Kconfig.defconfig
@@ -0,0 +1,55 @@
+# Copyright (c) 2021 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+if SHIELD_ZODIARK_LEFT
+
+config ZMK_KEYBOARD_NAME
+	default "Zodiark"
+
+config ZMK_SPLIT_BLE_ROLE_CENTRAL
+	default y
+	
+endif
+
+if SHIELD_ZODIARK_LEFT || SHIELD_ZODIARK_RIGHT
+
+config ZMK_SPLIT
+	default y
+
+if ZMK_DISPLAY
+
+config I2C
+	default y
+
+config SSD1306
+	default y
+
+config SSD1306_REVERSE_MODE
+	default y
+
+endif # ZMK_DISPLAY
+
+if LVGL
+
+config LVGL_HOR_RES_MAX
+	default 128
+
+config LVGL_VER_RES_MAX
+	default 64
+
+config LVGL_VDB_SIZE
+	default 64
+
+config LVGL_DPI
+	default 148
+
+config LVGL_BITS_PER_PIXEL
+	default 1
+
+choice LVGL_COLOR_DEPTH
+	default LVGL_COLOR_DEPTH_1
+endchoice
+
+endif # LVGL
+
+endif
diff --git a/app/boards/shields/zodiark/Kconfig.shield b/app/boards/shields/zodiark/Kconfig.shield
new file mode 100644
index 0000000000..25e23a1441
--- /dev/null
+++ b/app/boards/shields/zodiark/Kconfig.shield
@@ -0,0 +1,8 @@
+# Copyright (c) 2021 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config SHIELD_ZODIARK_LEFT
+	def_bool $(shields_list_contains,zodiark_left)
+
+config SHIELD_ZODIARK_RIGHT
+	def_bool $(shields_list_contains,zodiark_right)
diff --git a/app/boards/shields/zodiark/zodiark.conf b/app/boards/shields/zodiark/zodiark.conf
new file mode 100644
index 0000000000..6478485000
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark.conf
@@ -0,0 +1,9 @@
+# Copyright (c) 2021 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+# Uncomment the following line to enable the Zodiark OLED Display
+# CONFIG_ZMK_DISPLAY=y
+
+# Uncomment these two lines to add support for encoders
+# CONFIG_EC11=y
+# CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y
diff --git a/app/boards/shields/zodiark/zodiark.dtsi b/app/boards/shields/zodiark/zodiark.dtsi
new file mode 100644
index 0000000000..0adb7f672b
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark.dtsi
@@ -0,0 +1,86 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include <dt-bindings/zmk/matrix_transform.h>
+
+/ {
+    chosen {
+        zmk,kscan = &kscan0;
+        zmk,matrix_transform = &default_transform;
+    };
+
+    default_transform: keymap_transform_0 {
+        compatible = "zmk,matrix-transform";
+        columns = <18>;
+        rows = <4>;
+// | SW6  | SW5  | SW4  | SW3  | SW2  | SW1  |                               | SW1  | SW2  | SW3  | SW4  | SW5  | SW6  |
+// | SW13 | SW12 | SW11 | SW10 | SW9  | SW8  | SW7  |                 | SW7  | SW8  | SW9  | SW10 | SW11 | SW12 | SW13 |
+// | SW20 | SW19 | SW18 | SW17 | SW16 | SW15 | SW14 |                 | SW14 | SW15 | SW16 | SW17 | SW18 | SW19 | SW20 |
+// | SW28 | SW27 | SW26 | SW25 | SW24 | SW23 | SW22 | SW21 |   | SW21 | SW22 | SW23 | SW24 | SW25 | SW26 | SW27 | SW28 |
+// | SW35 | SW34 | SW33 | SW32 | SW31 |     SW30    | SW29 |   | SW29 |     SW30    | SW31 | SW32 | SW33 | SW34 | SW35 |
+        map = <
+RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)                                   RC(0,8) RC(0,9) RC(0,10) RC(0,11) RC(0,12) RC(0,13)
+RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5) RC(0,6)                   RC(0,7) RC(1,8) RC(1,9) RC(1,10) RC(1,11) RC(1,12) RC(1,13)
+RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5) RC(1,6)                   RC(1,7) RC(2,8) RC(2,9) RC(2,10) RC(2,11) RC(2,12) RC(2,13)
+RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5) RC(2,6) RC(3,6)   RC(3,7) RC(2,7) RC(3,8) RC(3,9) RC(3,10) RC(3,11) RC(3,12) RC(3,13)
+RC(4,0) RC(4,1) RC(4,2) RC(4,3) RC(4,4)      RC(4,5)    RC(4,6)   RC(4,7)      RC(4,8)    RC(4,9) RC(4,10) RC(4,11) RC(4,12) RC(4,13)
+        >;
+    };
+
+    kscan0: kscan {
+        compatible = "zmk,kscan-gpio-matrix";
+        label = "KSCAN";
+
+        diode-direction = "col2row";
+        row-gpios
+            = <&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)>
+            , <&pro_micro 8 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            , <&pro_micro 3 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+            ;
+    };
+
+    left_encoder: encoder_left {
+        compatible = "alps,ec11";
+        label = "LEFT_ENCODER";
+        a-gpios = <&pro_micro 2 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        b-gpios = <&pro_micro 4 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        resolution = <4>;
+        status = "disabled";
+    };
+
+    right_encoder: encoder_right {
+        compatible = "alps,ec11";
+        label = "RIGHT_ENCODER";
+        a-gpios = <&pro_micro 4 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        b-gpios = <&pro_micro 2 (GPIO_ACTIVE_HIGH | GPIO_PULL_UP)>;
+        resolution = <4>;
+        status = "disabled";
+    };
+
+    sensors {
+        compatible = "zmk,keymap-sensors";
+        sensors = <&left_encoder &right_encoder>;
+    };
+};
+
+&pro_micro_i2c {
+    status = "okay";
+
+    ssd1306@3c {
+        compatible = "solomon,ssd1306fb";
+        reg = <0x3c>;
+        label = "DISPLAY";
+        width = <128>;
+        height = <64>;
+        segment-offset = <0>;
+        page-offset = <0>;
+        display-offset = <0>;
+        multiplex-ratio = <31>;
+        prechargep = <0x22>;
+    };
+};
diff --git a/app/boards/shields/zodiark/zodiark.keymap b/app/boards/shields/zodiark/zodiark.keymap
new file mode 100644
index 0000000000..21fdef10c9
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark.keymap
@@ -0,0 +1,69 @@
+/*
+ * 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>
+
+/ {
+    keymap {
+        compatible = "zmk,keymap";
+
+        default_layer {
+// ------------------------------------------------------------------------------------------------------------
+// |  ESC  |  1  |  2  |  3   |  4   |  5   |                                  |  6   |  7    |  8    |  9   |   0   | BKSPC |
+// |  TAB  |  Q  |  W  |  E   |  R   |  T   |   [    |                 |   ]   |  Y   |  U    |  I    |  O   |   P   |   \   |
+// |  CAPS |  A  |  S  |  D   |  F   |  G   |   -    |                 |   =   |  H   |  J    |  K    |  L   |   ;   |   '   |
+// | SHIFT |  Z  |  X  |  C   |  V   |  B   |   `    | MUTE  | | PRNT  |  DEL  |  N   |  M    |  ,    |  .   |   /   | ENTER |
+// | CTRL  | ALT | GUI | MENU | LOWER|     SPACE     | ENTER | | ENTER |    SPACE     | RAISE| LEFT  | DOWN  |  UP   | RIGHT |
+            bindings = <
+&kp ESC   &kp N1 &kp N2   &kp N3   &kp N4    &kp N5                                           &kp N6 &kp N7 &kp N8    &kp N9   &kp N0   &kp BSPC
+&kp TAB   &kp Q  &kp W    &kp E    &kp R     &kp T &kp LBKT                         &kp RBKT  &kp Y  &kp U  &kp I     &kp O    &kp P    &kp BSLH
+&kp TAB   &kp A  &kp S    &kp D    &kp F     &kp G &kp MINUS                        &kp EQUAL &kp H  &kp J  &kp K     &kp L    &kp SEMI &kp SQT
+&kp LSHFT &kp Z  &kp X    &kp C    &kp V     &kp B &kp GRAVE &kp C_MUTE  &kp PSCRN  &kp DEL   &kp N  &kp M  &kp COMMA &kp DOT  &kp FSLH &kp RET
+&kp LCTRL &kp LALT &kp LGUI &kp K_CMENU &mo 1   &kp SPACE    &kp RET     &kp RET      &kp SPACE      &mo 2  &kp LEFT  &kp DOWN &kp UP   &kp RIGHT
+            >;
+
+            sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN &inc_dec_kp PG_UP PG_DN>;
+        };
+
+        lower_layer {
+// ------------------------------------------------------------------------------------------------------------
+// |       | F1  | F2  |  F3  |  F4  |  F5  |                                  |  F6  |  F7   |  F8   |  F9  |  F10  |  F11  |
+// | N.LC  |  7  |  8  |   9  |PRTSC | SCRLK|        |                 |       | PAUSE|       |   7   |   8  |   9   |  F12  |
+// |       |  4  |  5  |   6  | INS  | HOME |        |                 |       |  PGUP|       |   4   |   5  |   6   |       |
+// |       |  1  |  2  |   3  | DEL  |  END |        |       | |       |       |  PGDN|       |   1   |   2  |   3   |       |
+// |       |  0  |  .  | Enter|      |               |       | |       |              |       |   0   |   .  | Enter |       |
+            bindings = <
+&trans    &kp F1   &kp F2   &kp F3   &kp F4    &kp F5                                     &kp F6          &kp F7  &kp F8    &kp F9   &kp F10  &kp F11
+&kp KP_NUM &kp KP_N7 &kp KP_N8 &kp KP_N9  &kp PSCRN &kp SLCK &trans                &trans &kp PAUSE_BREAK &trans  &kp KP_N7 &kp KP_N8 &kp KP_N9   &kp F12 
+&trans     &kp KP_N4 &kp KP_N5 &kp KP_N6  &kp INS   &kp HOME &trans                &trans &kp PG_UP       &trans  &kp KP_N4 &kp KP_N5 &kp KP_N6   &trans
+&trans     &kp KP_N1 &kp KP_N2 &kp KP_N3  &kp DEL   &kp END &trans &trans  &trans  &trans &kp PG_DN       &trans  &kp KP_N1 &kp KP_N2 &kp KP_N3   &trans
+&trans     &kp KP_N0 &kp KP_DOT  &kp KP_ENTER &trans &trans &trans         &trans     &trans              &trans  &kp KP_N0 &kp KP_DOT  &kp KP_ENTER &trans
+            >;
+
+            sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN &inc_dec_kp PG_UP PG_DN>;
+        };
+
+        raise_layer {
+// ------------------------------------------------------------------------------------------------------------
+// |BTCLR  | BT1 | BT2 |  BT3 |  BT4 |  BT5 |                                  |      |       |       |      |       | RESET |
+// |       |     |     |      |      |      |        |                 |       |      |       |       |      |       |BLOADER|
+// |       |     |     |      |      |      |        |                 |       |      |       |       |      |       |       |
+// |       |     |     |      |      |      |        |       | |       |       |      |       |       |      |       |       |
+// |       |     |     |      |      |               |       | |       |              |       |       |      |       |       |
+            bindings = <
+&bt BT_CLR &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &bt BT_SEL 4                          &trans &trans &trans &trans &trans &reset
+&trans   &trans        &trans        &trans       &trans      &trans  &trans                 &trans  &trans &trans &trans &trans &trans &bootloader
+&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
+            >;
+
+            sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN &inc_dec_kp PG_UP PG_DN>;
+        };
+    };
+};
diff --git a/app/boards/shields/zodiark/zodiark.zmk.yml b/app/boards/shields/zodiark/zodiark.zmk.yml
new file mode 100644
index 0000000000..fc68588152
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark.zmk.yml
@@ -0,0 +1,14 @@
+file_format: "1"
+id: zodiark
+name: Zodiark
+type: shield
+url: https://www.splitlogic.xyz/buildguides/zodiark-build-guide
+requires: [pro_micro]
+exposes: [i2c_oled]
+features:
+  - keys
+  - display
+  - encoder
+siblings:
+  - zodiark_left
+  - zodiark_right
diff --git a/app/boards/shields/zodiark/zodiark_left.overlay b/app/boards/shields/zodiark/zodiark_left.overlay
new file mode 100644
index 0000000000..fe55edc6bb
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark_left.overlay
@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "zodiark.dtsi"
+
+&kscan0 {
+	col-gpios
+		= <&pro_micro  2 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  1 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  0 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 15 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 14 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 16 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 10 GPIO_ACTIVE_HIGH>
+		;
+};
+
+&left_encoder {
+	status = "okay";
+};
diff --git a/app/boards/shields/zodiark/zodiark_right.overlay b/app/boards/shields/zodiark/zodiark_right.overlay
new file mode 100644
index 0000000000..3405f59bd0
--- /dev/null
+++ b/app/boards/shields/zodiark/zodiark_right.overlay
@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "zodiark.dtsi"
+
+&default_transform {
+	col-offset = <7>;
+};
+
+&kscan0 {
+	col-gpios
+		= <&pro_micro 10 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 16 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 14 GPIO_ACTIVE_HIGH>
+		, <&pro_micro 15 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  0 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  1 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  2 GPIO_ACTIVE_HIGH>
+		;
+};
+
+&right_encoder {
+	status = "okay";
+};