feat(shields): Add ZMK Uno split setup

* Make it easier to test split code with ZMK Uno
  hardware by adding a split left/right setup as well.
This commit is contained in:
Peter Johanson 2023-12-06 20:05:29 +00:00 committed by Pete Johanson
parent 291bbc2257
commit 88338a9b3c
10 changed files with 382 additions and 160 deletions

View File

@ -1,7 +1,7 @@
# Copyright (c) 2022 The ZMK Contributors
# SPDX-License-Identifier: MIT
if SHIELD_ZMK_UNO
if SHIELD_ZMK_UNO_BASE
config ZMK_KEYBOARD_NAME
default "ZMK Uno"

View File

@ -1,5 +1,20 @@
# Copyright (c) 2022 The ZMK Contributors
# SPDX-License-Identifier: MIT
config SHIELD_ZMK_UNO_BASE
bool
config SHIELD_ZMK_UNO
def_bool $(shields_list_contains,zmk_uno)
select SHIELD_ZMK_UNO_BASE
config SHIELD_ZMK_UNO_SPLIT_LEFT
def_bool $(shields_list_contains,zmk_uno_split_left)
select SHIELD_ZMK_UNO_BASE
select ZMK_SPLIT
select ZMK_SPLIT_ROLE_CENTRAL
config SHIELD_ZMK_UNO_SPLIT_RIGHT
def_bool $(shields_list_contains,zmk_uno_split_right)
select SHIELD_ZMK_UNO_BASE
select ZMK_SPLIT

View File

@ -0,0 +1,172 @@
/*
* Copyright (c) 2022 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include <dt-bindings/led/led.h>
#include <dt-bindings/zmk/matrix_transform.h>
&arduino_i2c {
status = "okay";
};
nice_view_spi: &arduino_spi {
status = "okay";
cs-gpios = <&arduino_header 16 GPIO_ACTIVE_HIGH>;
// Needed so the nice_view shield will enhance the existing node which falls *first*
// on the bus, properly picking up the first `cs-gpios` specifier.
ls0xx@0 {
reg = <0>;
};
led_strip: ws2812@0 {
compatible = "worldsemi,ws2812-spi";
/* SPI */
reg = <0>; /* ignored, but necessary for SPI bindings */
spi-max-frequency = <4000000>;
/* WS2812 */
chain-length = <7>; /* 4 underglow + 3 per-key LEDs */
spi-one-frame = <0x70>;
spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
};
};
/ {
chosen {
zmk,kscan = &kscan_matrix_comp;
zmk,backlight = &backlight;
zmk,underglow = &led_strip;
zmk,matrix-transform = &matrix_transform;
};
// Commented out until we add more powerful power domain support
// external_power {
// compatible = "zmk,ext-power-generic";
// init-delay-ms = <200>;
// control-gpios = <&arduino_header 1 GPIO_ACTIVE_LOW>;
// };
rgb_power {
compatible = "zmk,ext-power-generic";
init-delay-ms = <200>;
control-gpios = <&arduino_header 1 GPIO_ACTIVE_LOW>;
};
backlight: gpioleds {
compatible = "gpio-leds";
gpio_led_0 {
gpios = <&arduino_header 12 GPIO_ACTIVE_HIGH>;
};
};
matrix_transform: matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(1,0) RC(1,1)
RC(2,0) RC(2,1) RC(2,2)
>;
};
direct_matrix_transform: direct_matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(0,2) RC(0,3)
RC(1,0) RC(1,1) RC(1,2)
>;
};
kscan_matrix_comp: kscan_matrix_comp {
compatible = "zmk,kscan-composite";
rows = <1>;
columns = <7>;
matrix {
kscan = <&kscan_matrix>;
};
toggle {
kscan = <&kscan_sp3t_toggle>;
row-offset = <2>;
};
};
kscan_direct_comp: kscan_direct_comp {
compatible = "zmk,kscan-composite";
status = "disabled";
matrix {
kscan = <&kscan_direct>;
};
toggle {
kscan = <&kscan_sp3t_toggle>;
row-offset = <1>;
};
};
kscan_matrix: kscan_matrix {
compatible = "zmk,kscan-gpio-matrix";
diode-direction = "col2row";
col-gpios
= <&arduino_header 10 GPIO_ACTIVE_HIGH>
, <&arduino_header 9 GPIO_ACTIVE_HIGH>
;
row-gpios
= <&arduino_header 13 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&arduino_header 11 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
;
};
kscan_direct: kscan_direct {
compatible = "zmk,kscan-gpio-direct";
status = "disabled";
input-gpios
= <&arduino_header 10 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 11 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
kscan_sp3t_toggle: kscan_sp3t_toggle {
compatible = "zmk,kscan-gpio-direct";
toggle-mode;
input-gpios
= <&arduino_header 4 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 3 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 2 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
encoder: encoder {
steps = <80>;
compatible = "alps,ec11";
a-gpios = <&arduino_header 15 GPIO_PULL_UP>;
b-gpios = <&arduino_header 14 GPIO_PULL_UP>;
};
};

View File

@ -4,170 +4,12 @@
* SPDX-License-Identifier: MIT
*/
#include <dt-bindings/led/led.h>
#include <dt-bindings/zmk/matrix_transform.h>
&arduino_i2c {
status = "okay";
};
nice_view_spi: &arduino_spi {
status = "okay";
cs-gpios = <&arduino_header 16 GPIO_ACTIVE_HIGH>;
// Needed so the nice_view shield will enhance the existing node which falls *first*
// on the bus, properly picking up the first `cs-gpios` specifier.
ls0xx@0 {
reg = <0>;
};
led_strip: ws2812@0 {
compatible = "worldsemi,ws2812-spi";
/* SPI */
reg = <0>; /* ignored, but necessary for SPI bindings */
spi-max-frequency = <4000000>;
/* WS2812 */
chain-length = <7>; /* 4 underglow + 3 per-key LEDs */
spi-one-frame = <0x70>;
spi-zero-frame = <0x40>;
color-mapping = <LED_COLOR_ID_GREEN LED_COLOR_ID_RED LED_COLOR_ID_BLUE>;
};
};
#include "zmk_uno.dtsi"
/ {
chosen {
zmk,kscan = &kscan_matrix_comp;
zmk,backlight = &backlight;
zmk,underglow = &led_strip;
zmk,matrix-transform = &matrix_transform;
};
// Commented out until we add more powerful power domain support
// external_power {
// compatible = "zmk,ext-power-generic";
// init-delay-ms = <200>;
// control-gpios = <&arduino_header 1 GPIO_ACTIVE_LOW>;
// };
rgb_power {
compatible = "zmk,ext-power-generic";
init-delay-ms = <200>;
control-gpios = <&arduino_header 1 GPIO_ACTIVE_LOW>;
};
backlight: gpioleds {
compatible = "gpio-leds";
gpio_led_0 {
gpios = <&arduino_header 12 GPIO_ACTIVE_HIGH>;
};
};
matrix_transform: matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(1,0) RC(1,1)
RC(2,0) RC(2,1) RC(2,2)
>;
};
direct_matrix_transform: direct_matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(0,2) RC(0,3)
RC(1,0) RC(1,1) RC(1,2)
>;
};
kscan_matrix_comp: kscan_matrix_comp {
compatible = "zmk,kscan-composite";
rows = <1>;
columns = <7>;
matrix {
kscan = <&kscan_matrix>;
};
toggle {
kscan = <&kscan_sp3t_toggle>;
row-offset = <2>;
};
};
kscan_direct_comp: kscan_direct_comp {
compatible = "zmk,kscan-composite";
status = "disabled";
matrix {
kscan = <&kscan_direct>;
};
toggle {
kscan = <&kscan_sp3t_toggle>;
row-offset = <1>;
};
};
kscan_matrix: kscan_matrix {
compatible = "zmk,kscan-gpio-matrix";
diode-direction = "col2row";
col-gpios
= <&arduino_header 10 GPIO_ACTIVE_HIGH>
, <&arduino_header 9 GPIO_ACTIVE_HIGH>
;
row-gpios
= <&arduino_header 13 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&arduino_header 11 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
;
};
kscan_direct: kscan_direct {
compatible = "zmk,kscan-gpio-direct";
status = "disabled";
input-gpios
= <&arduino_header 10 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 9 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 13 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 11 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
kscan_sp3t_toggle: kscan_sp3t_toggle {
compatible = "zmk,kscan-gpio-direct";
toggle-mode;
input-gpios
= <&arduino_header 4 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 3 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
, <&arduino_header 2 (GPIO_ACTIVE_LOW | GPIO_PULL_UP)>
;
};
encoder: encoder {
steps = <80>;
compatible = "alps,ec11";
a-gpios = <&arduino_header 15 GPIO_PULL_UP>;
b-gpios = <&arduino_header 14 GPIO_PULL_UP>;
};
sensors {
compatible = "zmk,keymap-sensors";
sensors = <&encoder>;

View File

@ -0,0 +1,61 @@
/*
* Copyright (c) 2022 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include "zmk_uno.dtsi"
left_encoder: &encoder {
status = "disabled";
};
/ {
chosen {
zmk,matrix-transform = &split_matrix_transform;
};
split_matrix_transform: split_matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(1,0) RC(1,1)
RC(2,0) RC(2,1) RC(2,2)
RC(3,0) RC(3,1)
RC(4,0) RC(4,1)
RC(5,0) RC(5,1) RC(5,2)
>;
};
split_direct_matrix_transform: split_direct_matrix_transform {
compatible = "zmk,matrix-transform";
rows = <3>;
columns = <4>;
map = <
RC(0,0) RC(0,1)
RC(0,2) RC(0,3)
RC(1,0) RC(1,1) RC(1,2)
RC(2,0) RC(2,1)
RC(2,2) RC(2,3)
RC(3,0) RC(3,1) RC(3,2)
>;
};
right_encoder: right_encoder {
steps = <80>;
status = "disabled";
compatible = "alps,ec11";
a-gpios = <&arduino_header 15 GPIO_PULL_UP>;
b-gpios = <&arduino_header 14 GPIO_PULL_UP>;
};
sensors {
compatible = "zmk,keymap-sensors";
sensors = <&encoder &right_encoder>;
triggers-per-rotation = <20>;
};
};

View File

@ -0,0 +1,66 @@
/*
* Copyright (c) 2022 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
#include <dt-bindings/zmk/backlight.h>
#include <dt-bindings/zmk/bt.h>
#include <dt-bindings/zmk/ext_power.h>
#include <dt-bindings/zmk/outputs.h>
#include <dt-bindings/zmk/rgb.h>
// Uncomment the following block if using the "Direct Wire" jumper to switch the matrix to a direct wire.
/* :REMOVE ME
&kscan_direct_comp { status = "okay"; };
&kscan_direct { status = "okay"; };
&kscan_matrix_comp { status = "disabled"; };
&kscan_matrix { status = "disabled"; };
/ {
chosen {
zmk,matrix-transform = &split_direct_matrix_transform;
zmk,kscan = &kscan_direct_comp;
};
};
REMOVE ME: */
/ {
macros {
ZMK_MACRO(ble_zero,
wait-ms = <1>;
tap-ms = <1>;
bindings = <&out OUT_BLE &bt BT_SEL 0>;
)
ZMK_MACRO(ble_one,
wait-ms = <1>;
tap-ms = <1>;
bindings = <&out OUT_BLE &bt BT_SEL 1>;
)
};
keymap {
compatible = "zmk,keymap";
default_layer {
bindings = <
&kp A &bl BL_TOG
&rgb_ug RGB_EFF &bt BT_CLR
&out OUT_USB &ble_zero &ble_one
&kp C &kp D
&kp E &kp F
&none &none &none
>;
sensor-bindings = <&inc_dec_kp C_VOL_UP C_VOL_DN &inc_dec_kp PG_UP PG_DN>;
};
};
};

View File

@ -0,0 +1,18 @@
# Copyright (c) 2022 The ZMK Contributors
# SPDX-License-Identifier: MIT
CONFIG_LOG=y
CONFIG_ZMK_LOG_LEVEL_DBG=y
# Uncomment for Single color backlight
# CONFIG_ZMK_BACKLIGHT=y
# Uncomment for RGB
# CONFIG_ZMK_RGB_UNDERGLOW=y
# Uncomment for Display
# CONFIG_ZMK_DISPLAY=y
# Uncomment these two lines to enable encoder support
# CONFIG_EC11=y
# CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y

View File

@ -0,0 +1,11 @@
/*
* Copyright (c) 2022 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include "zmk_uno_split.dtsi"
&left_encoder {
status = "okay";
};

View File

@ -0,0 +1,18 @@
# Copyright (c) 2022 The ZMK Contributors
# SPDX-License-Identifier: MIT
CONFIG_LOG=y
CONFIG_ZMK_LOG_LEVEL_DBG=y
# Uncomment for Single color backlight
# CONFIG_ZMK_BACKLIGHT=y
# Uncomment for RGB
# CONFIG_ZMK_RGB_UNDERGLOW=y
# Uncomment for Display
# CONFIG_ZMK_DISPLAY=y
# Uncomment these two lines to enable encoder support
# CONFIG_EC11=y
# CONFIG_EC11_TRIGGER_GLOBAL_THREAD=y

View File

@ -0,0 +1,19 @@
/*
* Copyright (c) 2022 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include "zmk_uno_split.dtsi"
&split_matrix_transform {
row-offset = <3>;
};
&split_direct_matrix_transform {
row-offset = <2>;
};
&right_encoder {
status = "okay";
};