From b4f03413a46dedbb372d57ff92f1b97e880c5bd4 Mon Sep 17 00:00:00 2001 From: Kyle McCreery Date: Fri, 17 Mar 2023 15:17:17 -0400 Subject: [PATCH 1/5] Prepping for PR --- app/boards/shields/obe/Kconfig.defconfig | 26 +++++ app/boards/shields/obe/Kconfig.shield | 5 + app/boards/shields/obe/boards/pillbug.conf | 3 + app/boards/shields/obe/boards/pillbug.overlay | 38 ++++++++ app/boards/shields/obe/obe.conf | 6 ++ app/boards/shields/obe/obe.keymap | 95 +++++++++++++++++++ app/boards/shields/obe/obe.overlay | 65 +++++++++++++ app/boards/shields/obe/obe.yml | 10 ++ 8 files changed, 248 insertions(+) create mode 100644 app/boards/shields/obe/Kconfig.defconfig create mode 100644 app/boards/shields/obe/Kconfig.shield create mode 100644 app/boards/shields/obe/boards/pillbug.conf create mode 100644 app/boards/shields/obe/boards/pillbug.overlay create mode 100644 app/boards/shields/obe/obe.conf create mode 100644 app/boards/shields/obe/obe.keymap create mode 100644 app/boards/shields/obe/obe.overlay create mode 100644 app/boards/shields/obe/obe.yml diff --git a/app/boards/shields/obe/Kconfig.defconfig b/app/boards/shields/obe/Kconfig.defconfig new file mode 100644 index 00000000..7a910aca --- /dev/null +++ b/app/boards/shields/obe/Kconfig.defconfig @@ -0,0 +1,26 @@ +# Copyright (c) 2023 The ZMK Contributors +# SPDX-License-Identifier: MIT + +if SHIELD_OBE + +config ZMK_KEYBOARD_NAME + default "OrangeBoyErgo" + +if LVGL + +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/obe/Kconfig.shield b/app/boards/shields/obe/Kconfig.shield new file mode 100644 index 00000000..5428f21d --- /dev/null +++ b/app/boards/shields/obe/Kconfig.shield @@ -0,0 +1,5 @@ +# Copyright (c) 2023 The ZMK Contributors +# SPDX-License-Identifier: MIT + +config SHIELD_OBE + def_bool $(shields_list_contains,obe) diff --git a/app/boards/shields/obe/boards/pillbug.conf b/app/boards/shields/obe/boards/pillbug.conf new file mode 100644 index 00000000..dda71c13 --- /dev/null +++ b/app/boards/shields/obe/boards/pillbug.conf @@ -0,0 +1,3 @@ +# Uncomment both to enable underglow +CONFIG_ZMK_RGB_UNDERGLOW=y +CONFIG_WS2812_STRIP=y diff --git a/app/boards/shields/obe/boards/pillbug.overlay b/app/boards/shields/obe/boards/pillbug.overlay new file mode 100644 index 00000000..64311597 --- /dev/null +++ b/app/boards/shields/obe/boards/pillbug.overlay @@ -0,0 +1,38 @@ +/* + * Copyright (c) 2023 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + + #include + +&spi1 { + compatible = "nordic,nrf-spim"; + status = "okay"; + mosi-pin = <25>; + // Unused pins, needed for SPI definition, but not used by the ws2812 driver itself. + sck-pin = <27>; + miso-pin = <28>; + + led_strip: ws2812@0 { + compatible = "worldsemi,ws2812-spi"; + label = "WS2812"; + + /* SPI */ + reg = <0>; /* ignored, but necessary for SPI bindings */ + spi-max-frequency = <4000000>; + + /* WS2812 */ + chain-length = <10>; /* number of LEDs */ + spi-one-frame = <0x70>; + spi-zero-frame = <0x40>; + + color-mapping = ; + }; +}; + +/ { + chosen { + zmk,underglow = &led_strip; + }; +}; \ No newline at end of file diff --git a/app/boards/shields/obe/obe.conf b/app/boards/shields/obe/obe.conf new file mode 100644 index 00000000..ccf77e61 --- /dev/null +++ b/app/boards/shields/obe/obe.conf @@ -0,0 +1,6 @@ +# Uncomment to turn on logging, and set ZMK logging to debug output +# CONFIG_ZMK_USB_LOGGING=y + +# Uncomment both to enable encoder +CONFIG_EC11=y +CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y diff --git a/app/boards/shields/obe/obe.keymap b/app/boards/shields/obe/obe.keymap new file mode 100644 index 00000000..d545f4dd --- /dev/null +++ b/app/boards/shields/obe/obe.keymap @@ -0,0 +1,95 @@ +/* + * Copyright (c) 2023 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#include +#include +#include +#include +#include + + +#define TIMEOUT 300 + +&encoder_1 { + status = "okay"; +}; + +/ { + combos { + compatible = "zmk,combos"; + combo_btclr { + timeout-ms = ; + key-positions = <1 6>; + bindings = <&bt BT_CLR>; + }; + combo_lock { + timeout-ms = ; + key-positions = <1 7>; + bindings = <&tog 2>; + }; + combo_reset { + timeout-ms = ; + key-positions = <1 3>; + bindings = <&reset>; + }; + combo_bootloader { + timeout-ms = ; + key-positions = <1 15>; + bindings = <&bootloader>; + }; + combo_bt_nxt { + timeout-ms = ; + key-positions = <1 4>; + bindings = <&bt BT_NXT>; + }; + }; + + sensors { + compatible = "zmk,keymap-sensors"; + sensors = <&encoder_1>; + }; + + + keymap0: keymap { + compatible = "zmk,keymap"; + + default_layer { + label = "default layer"; + bindings = < + &kp C_MUTE &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 EQUAL &trans &kp BSPC + &kp PG_UP &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 PG_DN &mo 1 &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp APOS &kp ENTER + &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp UP &kp RSHFT + &kp LCTRL &kp LGUI &kp LALT &kp SPACE &mo 1 &kp SPACE &kp RALT &mo 1 &kp LEFT &kp DOWN &kp RIGHT + >; + sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN>; + }; + + fn_layer { + label = "fn layer"; + bindings = < + &tog 2 &trans &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 &kp DEL + &bootloader &trans &bt BT_SEL 0 &bt BT_SEL 1 &bt BT_SEL 2 &bt BT_SEL 3 &trans &trans &trans &trans &trans &trans &trans &trans &trans + &bt BT_NXT &kp CAPS &kp KP_NUM &kp SLCK &trans &trans &trans &trans &trans &trans &trans &trans &trans &trans + &trans &trans &bt BT_CLR &trans &trans &trans &trans &trans &trans &trans &trans &trans &kp PG_UP &trans + &trans &trans &rgb_ug RGB_BRD &rgb_ug RGB_EFR &ext_power EP_TOG &rgb_ug RGB_EFF &rgb_ug RGB_BRI &trans &kp HOME &kp PG_DN &kp END + >; + sensor-bindings = <&inc_dec_kp PG_UP PG_DN>; + }; + + lock_layer { + label = "fn layer"; + bindings = < + &none &none &none &none &none &none &none &none &none &none &none &none &none &none &none &none + &none &none &none &none &none &none &none &none &none &none &none &none &none &none &none + &none &none &none &none &none &none &none &none &none &none &none &none &none &none + &none &none &none &none &none &none &none &none &none &none &none &none &none &none + &none &none &none &none &none &none &none &none &none &none &none + >; + sensor-bindings = <&inc_dec_kp PG_UP PG_DN>; + }; + }; +}; diff --git a/app/boards/shields/obe/obe.overlay b/app/boards/shields/obe/obe.overlay new file mode 100644 index 00000000..0fbf4da6 --- /dev/null +++ b/app/boards/shields/obe/obe.overlay @@ -0,0 +1,65 @@ +/* + * Copyright (c) 2023 The ZMK Contributors + * + * SPDX-License-Identifier: MIT + */ + +#include + +/ { + chosen { + zmk,kscan = &kscan0; + zmk,matrix_transform = &default_transform; + }; + + kscan0: kscan { + compatible = "zmk,kscan-gpio-matrix"; + label = "KSCAN"; + + diode-direction = "col2row"; + row-gpios + = <&blackpill 29 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 28 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 27 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 26 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 25 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 38 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + , <&blackpill 39 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> + ; + col-gpios + = <&blackpill 21 GPIO_ACTIVE_HIGH> + , <&blackpill 19 GPIO_ACTIVE_HIGH> + , <&blackpill 18 GPIO_ACTIVE_HIGH> + , <&blackpill 17 GPIO_ACTIVE_HIGH> + , <&blackpill 16 GPIO_ACTIVE_HIGH> + , <&blackpill 15 GPIO_ACTIVE_HIGH> + , <&blackpill 14 GPIO_ACTIVE_HIGH> + , <&blackpill 13 GPIO_ACTIVE_HIGH> + , <&blackpill 12 GPIO_ACTIVE_HIGH> + , <&blackpill 11 GPIO_ACTIVE_HIGH> + ; + }; + + default_transform: keymap_transform_0 { + compatible = "zmk,matrix-transform"; + columns = <12>; + rows = <4>; + map = < + RC(5,5) RC(5,4) RC(5,3) RC(5,2) RC(5,1) RC(5,0) 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(6,5) RC(5,9) RC(5,8) RC(5,7) RC(5,6) 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(6,4) RC(6,9) RC(6,8) RC(6,3) 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(6,2) RC(6,0) RC(6,7) RC(6,6) 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(6,1) 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) + >; + }; + + encoder_1: encoder_1 { + compatible = "alps,ec11"; + label = "Encoder 1"; + a-gpios = <&blackpill 40 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; + b-gpios = <&blackpill 41 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>; + resolution = <4>; + status = "disabled"; + }; + +}; diff --git a/app/boards/shields/obe/obe.yml b/app/boards/shields/obe/obe.yml new file mode 100644 index 00000000..b84e8c16 --- /dev/null +++ b/app/boards/shields/obe/obe.yml @@ -0,0 +1,10 @@ +file_format: "1" +id: obe +name: OrangeBoyErgo +type: shield +url: https://mechwild.com/product/orange-boy-ergo/ +requires: [blackpill] +features: + - keys + - encoder + - underglow From d8c84650132cbf7db5c730ea66641a22df537f31 Mon Sep 17 00:00:00 2001 From: Kyle McCreery Date: Fri, 17 Mar 2023 15:29:55 -0400 Subject: [PATCH 2/5] Commenting out the encoder despite the fact that it makes my skin itchy to disable it by default. --- app/boards/shields/obe/obe.conf | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/app/boards/shields/obe/obe.conf b/app/boards/shields/obe/obe.conf index ccf77e61..3faf0d7c 100644 --- a/app/boards/shields/obe/obe.conf +++ b/app/boards/shields/obe/obe.conf @@ -2,5 +2,5 @@ # CONFIG_ZMK_USB_LOGGING=y # Uncomment both to enable encoder -CONFIG_EC11=y -CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y +# CONFIG_EC11=y +# CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y From 9b8a2d38a055d7026896f4a91bac8a347261ac0f Mon Sep 17 00:00:00 2001 From: Kyle McCreery Date: Fri, 17 Mar 2023 17:41:56 -0400 Subject: [PATCH 3/5] Style formatting change on zmk.yml file extension --- app/boards/shields/obe/boards/pillbug.overlay | 2 +- app/boards/shields/obe/{obe.yml => obe.zmk.yml} | 0 2 files changed, 1 insertion(+), 1 deletion(-) rename app/boards/shields/obe/{obe.yml => obe.zmk.yml} (100%) diff --git a/app/boards/shields/obe/boards/pillbug.overlay b/app/boards/shields/obe/boards/pillbug.overlay index 64311597..83307834 100644 --- a/app/boards/shields/obe/boards/pillbug.overlay +++ b/app/boards/shields/obe/boards/pillbug.overlay @@ -35,4 +35,4 @@ chosen { zmk,underglow = &led_strip; }; -}; \ No newline at end of file +}; diff --git a/app/boards/shields/obe/obe.yml b/app/boards/shields/obe/obe.zmk.yml similarity index 100% rename from app/boards/shields/obe/obe.yml rename to app/boards/shields/obe/obe.zmk.yml From 77b2ad15f7f7f4e76742bdcfb204c2ca1b08fe7b Mon Sep 17 00:00:00 2001 From: Kyle McCreery Date: Fri, 17 Mar 2023 17:57:05 -0400 Subject: [PATCH 4/5] Defaulting to RGB off and keeping as much as I can in the main shield config --- app/boards/shields/obe/boards/pillbug.conf | 3 --- app/boards/shields/obe/obe.conf | 8 ++++++++ 2 files changed, 8 insertions(+), 3 deletions(-) delete mode 100644 app/boards/shields/obe/boards/pillbug.conf diff --git a/app/boards/shields/obe/boards/pillbug.conf b/app/boards/shields/obe/boards/pillbug.conf deleted file mode 100644 index dda71c13..00000000 --- a/app/boards/shields/obe/boards/pillbug.conf +++ /dev/null @@ -1,3 +0,0 @@ -# Uncomment both to enable underglow -CONFIG_ZMK_RGB_UNDERGLOW=y -CONFIG_WS2812_STRIP=y diff --git a/app/boards/shields/obe/obe.conf b/app/boards/shields/obe/obe.conf index 3faf0d7c..9778bc95 100644 --- a/app/boards/shields/obe/obe.conf +++ b/app/boards/shields/obe/obe.conf @@ -1,6 +1,14 @@ # Uncomment to turn on logging, and set ZMK logging to debug output # CONFIG_ZMK_USB_LOGGING=y +# Uncomment both to enable underglow +# CONFIG_ZMK_RGB_UNDERGLOW=y +# CONFIG_WS2812_STRIP=y + # Uncomment both to enable encoder # CONFIG_EC11=y # CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y + +# Quality of life settings +# CONFIG_ZMK_IDLE_TIMEOUT=300000 +# CONFIG_BT_CTLR_TX_PWR_PLUS_8=y From 727045e1e163bf3482d1b27062047c01754cc96c Mon Sep 17 00:00:00 2001 From: Kyle McCreery Date: Sat, 18 Mar 2023 03:20:17 -0400 Subject: [PATCH 5/5] Added conf for blackpill to help with the matrix scanning --- .../shields/obe/boards/blackpill_f401ce.conf | 3 +++ app/boards/shields/obe/boards/pillbug.overlay | 2 +- app/boards/shields/obe/obe.conf | 16 ++++++++-------- app/boards/shields/obe/obe.keymap | 4 +--- app/boards/shields/obe/obe.overlay | 2 -- 5 files changed, 13 insertions(+), 14 deletions(-) create mode 100644 app/boards/shields/obe/boards/blackpill_f401ce.conf diff --git a/app/boards/shields/obe/boards/blackpill_f401ce.conf b/app/boards/shields/obe/boards/blackpill_f401ce.conf new file mode 100644 index 00000000..2a8d16df --- /dev/null +++ b/app/boards/shields/obe/boards/blackpill_f401ce.conf @@ -0,0 +1,3 @@ +# Necessary to stop double matrix reads on first row +CONFIG_ZMK_KSCAN_MATRIX_WAIT_BEFORE_INPUTS=150 +CONFIG_ZMK_KSCAN_MATRIX_WAIT_BETWEEN_OUTPUTS=150 diff --git a/app/boards/shields/obe/boards/pillbug.overlay b/app/boards/shields/obe/boards/pillbug.overlay index 83307834..5890c669 100644 --- a/app/boards/shields/obe/boards/pillbug.overlay +++ b/app/boards/shields/obe/boards/pillbug.overlay @@ -4,7 +4,7 @@ * SPDX-License-Identifier: MIT */ - #include +#include &spi1 { compatible = "nordic,nrf-spim"; diff --git a/app/boards/shields/obe/obe.conf b/app/boards/shields/obe/obe.conf index 9778bc95..81a3fad6 100644 --- a/app/boards/shields/obe/obe.conf +++ b/app/boards/shields/obe/obe.conf @@ -1,14 +1,14 @@ # Uncomment to turn on logging, and set ZMK logging to debug output -# CONFIG_ZMK_USB_LOGGING=y +#CONFIG_ZMK_USB_LOGGING=y -# Uncomment both to enable underglow -# CONFIG_ZMK_RGB_UNDERGLOW=y -# CONFIG_WS2812_STRIP=y +# Uncomment both to enable underglow, will not work with blackpill (currently) +#CONFIG_ZMK_RGB_UNDERGLOW=y +#CONFIG_WS2812_STRIP=y # Uncomment both to enable encoder -# CONFIG_EC11=y -# CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y +#CONFIG_EC11=y +#CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y # Quality of life settings -# CONFIG_ZMK_IDLE_TIMEOUT=300000 -# CONFIG_BT_CTLR_TX_PWR_PLUS_8=y +#CONFIG_ZMK_IDLE_TIMEOUT=300000 +#CONFIG_BT_CTLR_TX_PWR_PLUS_8=y diff --git a/app/boards/shields/obe/obe.keymap b/app/boards/shields/obe/obe.keymap index d545f4dd..7e20072b 100644 --- a/app/boards/shields/obe/obe.keymap +++ b/app/boards/shields/obe/obe.keymap @@ -10,7 +10,6 @@ #include #include - #define TIMEOUT 300 &encoder_1 { @@ -52,14 +51,13 @@ sensors = <&encoder_1>; }; - keymap0: keymap { compatible = "zmk,keymap"; default_layer { label = "default layer"; bindings = < - &kp C_MUTE &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 EQUAL &trans &kp BSPC + &kp C_MUTE &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 EQUAL &kp BSLH &kp BSPC &kp PG_UP &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 PG_DN &mo 1 &kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI &kp APOS &kp ENTER &kp LSHFT &kp Z &kp X &kp C &kp V &kp B &kp B &kp N &kp M &kp COMMA &kp DOT &kp FSLH &kp UP &kp RSHFT diff --git a/app/boards/shields/obe/obe.overlay b/app/boards/shields/obe/obe.overlay index 0fbf4da6..74f56e38 100644 --- a/app/boards/shields/obe/obe.overlay +++ b/app/boards/shields/obe/obe.overlay @@ -15,7 +15,6 @@ kscan0: kscan { compatible = "zmk,kscan-gpio-matrix"; label = "KSCAN"; - diode-direction = "col2row"; row-gpios = <&blackpill 29 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)> @@ -61,5 +60,4 @@ resolution = <4>; status = "disabled"; }; - };