Add support for the Jiran (#1048)

* initial files to get stuff working

* Keymap by Ladniy

* Format update to new standards

* keymap update

* header

* Fixed transform, removed left and right .conf files

* Apply suggestions from code review

Formatting

Co-authored-by: Nick Winans <nick@winans.codes>

Co-authored-by: Nick Winans <nick@winans.codes>

8 files changed, 196 insertions, 0 deletions

diff --git a/app/boards/shields/jiran/Kconfig.defconfig b/app/boards/shields/jiran/Kconfig.defconfig
new file mode 100644
index 0000000..1742197
--- /dev/null
+++ b/app/boards/shields/jiran/Kconfig.defconfig
@@ -0,0 +1,19 @@
+# Copyright (c) 2021 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+if SHIELD_JIRAN_LEFT
+
+config ZMK_KEYBOARD_NAME
+	default "Jiran"
+
+config ZMK_SPLIT_BLE_ROLE_CENTRAL
+	default y
+
+endif
+
+if SHIELD_JIRAN_LEFT || SHIELD_JIRAN_RIGHT
+
+config ZMK_SPLIT
+	default y
+
+endif
diff --git a/app/boards/shields/jiran/Kconfig.shield b/app/boards/shields/jiran/Kconfig.shield
new file mode 100644
index 0000000..8a24ace
--- /dev/null
+++ b/app/boards/shields/jiran/Kconfig.shield
@@ -0,0 +1,8 @@
+# Copyright (c) 2021 The ZMK Contributors
+# SPDX-License-Identifier: MIT
+
+config SHIELD_JIRAN_LEFT
+	def_bool $(shields_list_contains,jiran_left)
+
+config SHIELD_JIRAN_RIGHT
+	def_bool $(shields_list_contains,jiran_right)
diff --git a/app/boards/shields/jiran/jiran.conf b/app/boards/shields/jiran/jiran.conf
new file mode 100644
index 0000000..406f9a4
--- /dev/null
+++ b/app/boards/shields/jiran/jiran.conf
@@ -0,0 +1 @@
+# CONFIG_ZMK_SLEEP=y
\ No newline at end of file
diff --git a/app/boards/shields/jiran/jiran.dtsi b/app/boards/shields/jiran/jiran.dtsi
new file mode 100644
index 0000000..5dfaa46
--- /dev/null
+++ b/app/boards/shields/jiran/jiran.dtsi
@@ -0,0 +1,82 @@
+/*
+ * 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 = <12>;
+		rows = <5>;
+
+//        | SW1  | SW2  | SW3  | SW4  | SW5  | SW6  |   | SW6  | SW5  | SW4  | SW3  | SW2  | SW1  |
+// | SW0  | SW7  | SW8  | SW9  | SW10 | SW11 | SW12 |   | SW12 | SW11 | SW10 | SW9  | SW8  | SW7  | SW0  |
+//        | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 | SW15 | SW14 | SW13 |
+//        | SW19 | SW20 | SW21 | SW22 | SW23 | SW24 |   | SW24 | SW23 | SW22 | SW21 | SW20 | SW19 |
+//                             | SW25 | SW26 | SW27 |   | SW27 | SW26 | SW25 |
+		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(4,0) 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(4,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,0) RC(3,1) 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,11)
+                                    RC(4,3) RC(4,4) RC(4,5)  RC(4,6) RC(4,7) RC(4,8)
+		>;
+	};
+
+	jian_transform: keymap_transform_1 {
+		compatible = "zmk,matrix-transform";
+		columns = <12>;
+		rows = <5>;
+
+// | SW0  | SW7  | SW8  | SW9  | SW10 | SW11 | SW12 |   | SW12 | SW11 | SW10 | SW9  | SW8  | SW7  | SW0  |
+//        | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 |   | SW18 | SW17 | SW16 | SW15 | SW14 | SW13 |
+//        | SW19 | SW20 | SW21 | SW22 | SW23 | SW24 |   | SW24 | SW23 | SW22 | SW21 | SW20 | SW19 |
+//                             | SW25 | SW26 | SW27 |   | SW27 | SW26 | SW25 |
+		map = <
+    RC(4,0) 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(4,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,0) RC(3,1) 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,11)
+                                    RC(4,3) RC(4,4) RC(4,5)  RC(4,6) RC(4,7) RC(4,8)
+		>;
+	};
+
+	crkbd_transform: keymap_transform_2 {
+		compatible = "zmk,matrix-transform";
+		columns = <12>;
+		rows = <5>;
+
+//        | 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 | SW22 | SW23 | SW24 |   | SW24 | SW23 | SW22 | SW21 | SW20 | SW19 |
+//                             | SW25 | SW26 | SW27 |   | SW27 | SW26 | SW25 |
+		map = <
+            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,0) RC(3,1) 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,11)
+                                    RC(4,3) RC(4,4) RC(4,5)  RC(4,6) RC(4,7) RC(4,8)
+		>;
+	};
+
+	kscan0: kscan {
+		compatible = "zmk,kscan-gpio-matrix";
+		label = "KSCAN";
+
+		diode-direction = "col2row";
+		row-gpios
+			= <&pro_micro   8 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+			, <&pro_micro   9 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+			, <&pro_micro  21 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+			, <&pro_micro  20 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+			, <&pro_micro  19 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
+			;
+		
+	};
+};
diff --git a/app/boards/shields/jiran/jiran.keymap b/app/boards/shields/jiran/jiran.keymap
new file mode 100644
index 0000000..e6c073c
--- /dev/null
+++ b/app/boards/shields/jiran/jiran.keymap
@@ -0,0 +1,35 @@
+/*
+ * Copyright (c) 2021 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 {
+                        bindings = <
+           &kp ESC    &kp N1 &kp N2 &kp N3 &kp N4 &kp N5    &kp N6 &kp N7  &kp N8    &kp N9  &kp N0   &kp MINUS
+  &kp LGUI &kp TAB    &kp Q  &kp W  &kp E  &kp R  &kp T     &kp Y  &kp U   &kp I     &kp O   &kp P    &kp LBKT      &mt RGUI RBKT
+           &kp LSHIFT &kp A  &kp S  &kp D  &kp F  &kp G     &kp H  &kp J   &kp K     &kp L   &kp SEMI &mt RSHIFT SQT
+           &kp LCTRL  &kp Z  &kp X  &kp C  &kp V  &kp B     &kp N  &kp M   &kp COMMA &kp DOT &kp FSLH &mt RCTRL BSLH
+                                 &mo 1 &kp SPACE  &kp LALT  &mt RALT RET &kp BSPC &mo 1
+                        >;
+                };
+
+                lower_layer {
+                       bindings = <
+          &kp GRAVE   &kp F1      &kp F2   &kp F3   &kp F4    &kp F5        &kp F6       &kp F7    &kp F8   &kp F9    &kp F10         &kp EQUAL
+ &kp F11  &kp TAB     &bt BT_CLR  &kp HOME &reset   &kp PG_UP &kp C_VOL_UP  &kp C_VOL_UP &kp PG_UP &reset   &kp HOME  &kp INS         &kp DEL       &kp F12
+          &kp LSHIFT  &bt BT_NXT  &kp LEFT &kp UP   &kp RIGHT &kp C_MUTE    &kp C_MUTE   &kp LEFT  &kp UP   &kp RIGHT &kp PSCRN       &mt RSHIFT SLCK
+          &kp LCTRL   &bt BT_PRV  &kp END  &kp DOWN &kp PG_DN &kp C_VOL_DN  &kp C_VOL_DN &kp PG_DN &kp DOWN &kp END   &kp PAUSE_BREAK &mt RCTRL KP_NUM
+                                         &trans   &kp SPACE   &kp LALT      &mt RALT RET &kp BSPC  &trans
+                       >;
+               };
+        };
+};
\ No newline at end of file
diff --git a/app/boards/shields/jiran/jiran.zmk.yml b/app/boards/shields/jiran/jiran.zmk.yml
new file mode 100644
index 0000000..1e21df7
--- /dev/null
+++ b/app/boards/shields/jiran/jiran.zmk.yml
@@ -0,0 +1,11 @@
+file_format: "1"
+id: jiran
+name: Jiran
+type: shield
+url: https://github.com/Ladniy/jiran
+requires: [pro_micro]
+features:
+  - keys
+siblings:
+  - jiran_left
+  - jiran_right
diff --git a/app/boards/shields/jiran/jiran_left.overlay b/app/boards/shields/jiran/jiran_left.overlay
new file mode 100644
index 0000000..4466202
--- /dev/null
+++ b/app/boards/shields/jiran/jiran_left.overlay
@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "jiran.dtsi"
+
+&kscan0 {
+	col-gpios
+		= <&pro_micro  1 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  0 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  4 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  5 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  6 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  7 GPIO_ACTIVE_HIGH>
+		;
+};
diff --git a/app/boards/shields/jiran/jiran_right.overlay b/app/boards/shields/jiran/jiran_right.overlay
new file mode 100644
index 0000000..75b9fb5
--- /dev/null
+++ b/app/boards/shields/jiran/jiran_right.overlay
@@ -0,0 +1,22 @@
+/*
+ * Copyright (c) 2021 The ZMK Contributors
+ *
+ * SPDX-License-Identifier: MIT
+ */
+
+#include "jiran.dtsi"
+
+&default_transform {
+	col-offset = <6>;
+};
+
+&kscan0 {
+	col-gpios
+		= <&pro_micro  7 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  6 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  5 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  4 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  0 GPIO_ACTIVE_HIGH>
+		, <&pro_micro  1 GPIO_ACTIVE_HIGH>
+		;
+};