kemonine/keyboard
kemonine/keyboard
1
0
Fork 0
Code Issues Pull requests Releases 2 Activity

Add ARTSEY dtsi, implement on right half of a lily58 for testing

Browse source
This commit is contained in:
KemoNine 2021-02-02 17:53:20 +00:00
parent 27af3dbe09
commit 250185547b
7 changed files with 445 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

218
zmk-config/config/artsey.dtsi Normal file
View file

@ -0,0 +1,218 @@
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
/*****************************************
* ARTSEY website : https://www.artsey.io
* Primary reference : https://www.artsey.io/_FILES/images/ARTSEY.jpg
*****************************************/
/*****************************************
* Setting up ARTSEY chording
* - Please note: A/E key positions should be on your INDEX finger
* - The online reference is for right handed use
* - When using the ARTSEY layout left handed you'll want to ensure your keypositions are flipped along the Y axis
* - Update/adjust the key positions using your boards keymap
* - See below for additional details
* - Adjust your boards keymap layers...
* - To have the SAME layers defined as this keymap
* - Take the commented layers from below and place the values into your boards keymap in 'the right spots'
*****************************************/
/*****************************************
* Define key positions used for chording
* These definitions are used to define the various ARTSEY chords (combos)
*
* Please see the documentation on "combos" for details on how to find the proper key positions
*
* Default key positions are for a generic 4x2 keyboard and should NOT be used outright
* DEFINE these definitions in your boards keymap BEFORE including artsey.dtsi
*****************************************/
// ARTS Row
// #define KEY_A 4
// #define KEY_R 5
// #define KEY_T 6
// #define KEY_S 7
// EYIO Row
// #define KEY_E 0
// #define KEY_Y 1
// #define KEY_I 2
// #define KEY_O 3
/*****************************************
* Layer IDs used by the ARTSEY keymap
* Do NOT change these and do NOT change the order of the layers as shown below
*****************************************/
#define LAYER_ID_BASE 0
#define LAYER_ID_NUMBERS 1
#define LAYER_ID_SYMBOLS 2
#define LAYER_ID_PARENTHETICALS 3
#define LAYER_ID_NAVIGATION 4
#define LAYER_ID_MOUSE 5
/*****************************************
* Define how long it takes for the chords to 'time out'
* See documentation on "combos" for more detail
*****************************************/
#define TIMEOUT_CHORD 75
/*****************************************
* Standard ARTSEY chord definitions
* These should NOT be changed and are global in scope
*****************************************/
/ {
combos {
compatible = "zmk,combos";
chord_b { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_O>; bindings = <&kp B>; };
chord_m { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_Y KEY_I KEY_O>; bindings = <&kp M>; };
chord_c { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_Y>; bindings = <&kp C>; };
chord_n { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_I KEY_O>; bindings = <&kp N>; };
chord_d { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R KEY_T>; bindings = <&kp D>; };
chord_p { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_I KEY_O>; bindings = <&kp P>; };
chord_f { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R>; bindings = <&kp F>; };
chord_q { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_T KEY_S>; bindings = <&kp Q>; };
chord_g { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_R KEY_T>; bindings = <&kp G>; };
chord_u { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_Y KEY_I>; bindings = <&kp U>; };
chord_h { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_I>; bindings = <&kp H>; };
chord_v { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_R KEY_S>; bindings = <&kp V>; };
chord_j { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_T KEY_S>; bindings = <&kp J>; };
chord_w { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_S>; bindings = <&kp W>; };
chord_k { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_Y KEY_O>; bindings = <&kp K>; };
chord_x { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_R KEY_T KEY_S>; bindings = <&kp X>; };
chord_l { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_Y KEY_I>; bindings = <&kp L>; };
chord_z { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R KEY_T KEY_S>; bindings = <&kp Z>; };
chord_enter { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_E>; bindings = <&kp ENTER>; };
chord_esc { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R KEY_O>; bindings = <&kp ESC>; };
chord_single_quote { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_Y KEY_I>; bindings = <&kp SQT>; };
chord_tab { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R KEY_T KEY_O>; bindings = <&kp TAB>; };
chord_dot { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_Y>; bindings = <&kp PERIOD>; };
chord_control { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_S>; bindings = <&kp LCTRL>; };
chord_comma { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_I>; bindings = <&kp COMMA>; };
chord_gui { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_Y KEY_S>; bindings = <&kp LGUI>; };
chord_slash { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_O>; bindings = <&kp SLASH>; };
chord_alt { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_I KEY_S>; bindings = <&kp LALT>; };
chord_backspace { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_R>; bindings = <&kp BACKSPACE>; };
chord_shift { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_R KEY_T KEY_S>; bindings = <&kp LSHFT>; };
chord_space { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_Y KEY_I KEY_O>; bindings = <&kp SPACE>; };
/* Needs to be fixed */
chord_shift_lock { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_Y KEY_I KEY_O>; bindings = <&none>; };
/* Only on number layer */
/* TODO: Needs to be fixed */
chord_seven { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_R>; bindings = <&none>; };
/* Only on number layer */
/* TODO: Needs to be fixed */
chord_eight { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_R KEY_T>; bindings = <&none>; };
/* Only on number layer */
/* TODO: Needs to be fixed */
chord_nine { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_E KEY_Y>; bindings = <&none>; };
/* Only on number layer */
/* TODO: Needs to be fixed */
chord_zero { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_Y KEY_I>; bindings = <&none>; };
/* TODO: Setup/Enable once Mouse Keys feature(s) are added to ZMK */
chord_mouse { timeout-ms = <TIMEOUT_CHORD>; key-positions = <KEY_A KEY_T KEY_Y>; bindings = <&none>; };
};
};
/*****************************************
* Standard ARTSEY layer activation definitions
* These should NOT be changed and are global in scope
*****************************************/
/ {
behaviors {
layer_base_none: layer_base_none { compatible = "zmk,behavior-hold-tap"; label = "layer_base_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&to>, <&none>; };
layer_base_kp: layer_base_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_base_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&to>, <&kp>; };
layer_numbers_none: layer_numbers_none { compatible = "zmk,behavior-hold-tap"; label = "layer_numbers_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&to>, <&none>; };
layer_numbers_kp: layer_numbers_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_numbers_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&to>, <&kp>; };
layer_symbols_none: layer_symbols_none { compatible = "zmk,behavior-hold-tap"; label = "layer_symbols_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&to>, <&none>; };
layer_symbols_kp: layer_symbols_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_symbols_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&to>, <&kp>; };
layer_parentheticals_none: layer_parentheticals_none { compatible = "zmk,behavior-hold-tap"; label = "layer_parentheticals_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&to>, <&none>; };
layer_parentheticals_kp: layer_parentheticals_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_parentheticals_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&to>, <&kp>; };
layer_navigation_none: layer_navigation_none { compatible = "zmk,behavior-hold-tap"; label = "layer_navigation_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&to>, <&none>; };
layer_navigation_kp: layer_navigation_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_navigation_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&to>, <&kp>; };
layer_mouse_none: layer_mouse_none { compatible = "zmk,behavior-hold-tap"; label = "layer_mouse_none";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "hold-preferred";
bindings = <&tog>, <&none>; };
layer_mouse_kp: layer_mouse_kp { compatible = "zmk,behavior-hold-tap"; label = "layer_mouse_kp";
#binding-cells = <2>; tapping_term_ms = <150>; flavor = "tap-preferred";
bindings = <&tog>, <&kp>; };
};
};
/*****************************************
* Standard ARTSEY layer definitions
* These SHOULD BE CHANGED and adjusted according to your boards transform
* Use "&none" to fill in gaps
* This section is commented to avoid conflicts with downstream board definitions
*****************************************/
// / {
// keymap {
// compatible = "zmk,keymap";
// base {
// label = "Base";
// bindings = <
// &layer_parentheticals_kp LAYER_ID_PARENTHETICALS A &kp R &kp T &layer_numbers_kp LAYER_ID_NUMBERS S
// &layer_symbols_kp LAYER_ID_SYMBOLS E &kp Y &kp I &layer_navigation_kp LAYER_ID_NAVIGATION O
// >;
// };
// numbers {
// label = "Numbers";
// bindings = < /* TODO: NEED TO SETUP Fn LEADER KEY(S) */
// &layer_parentheticals_kp LAYER_ID_PARENTHETICALS N1 &kp N2 &kp N3 &layer_base_none LAYER_ID_BASE 0
// &layer_symbols_kp LAYER_ID_SYMBOLS N4 &kp N5 &kp N6 &layer_navigation_none LAYER_ID_NAVIGATION 0
// >;
// };
// symbols {
// label = "Symbols";
// bindings = <
// &layer_parentheticals_none LAYER_ID_PARENTHETICALS 0 &kp BSLH &kp SEMI &layer_numbers_kp LAYER_ID_NUMBERS GRAVE
// &layer_base_none LAYER_ID_BASE 0 &kp MINUS &kp EQUAL &layer_navigation_none LAYER_ID_NAVIGATION 0
// >;
// };
// parentheticals {
// label = "Paren";
// bindings = <
// &layer_base_none LAYER_ID_BASE 0 &kp LPAR &kp RPAR &layer_numbers_kp LAYER_ID_NUMBERS LBRC
// &layer_symbols_none LAYER_ID_SYMBOLS 0 &kp LBKT &kp RBKT &layer_navigation_kp LAYER_ID_NAVIGATION RBRC
// >;
// };
// navigation {
// label = "Nav";
// bindings = <
// &layer_parentheticals_kp LAYER_ID_PARENTHETICALS HOME &kp UP &kp END &layer_numbers_none LAYER_ID_NUMBERS 0
// &layer_symbols_kp LAYER_ID_SYMBOLS LEFT &kp DOWN &kp RIGHT &layer_base_none LAYER_ID_BASE 0
// >;
// };
// mouse { /* TODO: Not implemented yet, needs mouse keys in upstream */
// label = "Mouse";
// bindings = <
// &none &none &none &none
// &none &none &none &none
// >;
// };
// };

37
zmk-config/config/boards/shields/steno_right_lily58/Kconfig.defconfig Normal file
View file

@ -0,0 +1,37 @@
# Copyright (c) 2020 The ZMK Contributors
# SPDX-License-Identifier: MIT
if SHIELD_STENO_RIGHT_LILY58
config ZMK_KEYBOARD_NAME
default "ARTSEY LILY58 R"
config I2C
default y
config SSD1306
default y
config SSD1306_REVERSE_MODE
default y
config LVGL_HOR_RES_MAX
default 128
config LVGL_VER_RES_MAX
default 32
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

5
zmk-config/config/boards/shields/steno_right_lily58/Kconfig.shield Executable file
View file

@ -0,0 +1,5 @@
# Copyright (c) 2020 The ZMK Contributors
# SPDX-License-Identifier: MIT
config SHIELD_STENO_RIGHT_LILY58
def_bool $(shields_list_contains,steno_right_lily58)

34
zmk-config/config/boards/shields/steno_right_lily58/boards/nice_nano.overlay Normal file
View file

@ -0,0 +1,34 @@
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
&spi1 {
compatible = "nordic,nrf-spim";
status = "okay";
mosi-pin = <6>;
// Unused pins, needed for SPI definition, but not used by the ws2812 driver itself.
sck-pin = <5>;
miso-pin = <7>;
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 = <5>; /* number of LEDs */
spi-one-frame = <0x70>;
spi-zero-frame = <0x40>;
};
};
/ {
chosen {
zmk,underglow = &led_strip;
};
};

4
zmk-config/config/boards/shields/steno_right_lily58/steno_right_lily58.conf Executable file
View file

@ -0,0 +1,4 @@
# Copyright (c) 2020 The ZMK Contributors
# SPDX-License-Identifier: MIT
CONFIG_ZMK_DISPLAY=y

72
zmk-config/config/boards/shields/steno_right_lily58/steno_right_lily58.keymap Normal file
View file

@ -0,0 +1,72 @@
/*
* Copyright (c) 2020 The ZMK Contributors
*
* SPDX-License-Identifier: MIT
*/
#include <behaviors.dtsi>
#include <dt-bindings/zmk/keys.h>
// ARTS Row
#define KEY_A 13
#define KEY_R 14
#define KEY_T 15
#define KEY_S 16
// EYIO Row
#define KEY_E 7
#define KEY_Y 8
#define KEY_I 9
#define KEY_O 10
#include "../../../artsey.dtsi"
/ {
keymap {
compatible = "zmk,keymap";
base {
label = "Base";
bindings = <
&none &none &none &none &none &none &none
&layer_parentheticals_kp LAYER_ID_PARENTHETICALS A &kp R &kp T &layer_numbers_kp LAYER_ID_NUMBERS S
&layer_symbols_kp LAYER_ID_SYMBOLS E &kp Y &kp I &layer_navigation_kp LAYER_ID_NAVIGATION O
&none &none &none &none &none &none &none &none &none &none &none &none &none
>;
};
numbers {
label = "Numbers";
bindings = < /* TODO: NEED TO SETUP Fn LEADER KEY(S) */
&none &none &none &none &none &none &none
&layer_parentheticals_kp LAYER_ID_PARENTHETICALS N1 &kp N2 &kp N3 &layer_base_none LAYER_ID_BASE 0
&layer_symbols_kp LAYER_ID_SYMBOLS N4 &kp N5 &kp N6 &layer_navigation_none LAYER_ID_NAVIGATION 0
&none &none &none &none &none &none &none &none &none &none &none &none &none
>;
};
symbols {
label = "Symbols";
bindings = <
&none &none &none &none &none &none &none
&layer_parentheticals_none LAYER_ID_PARENTHETICALS 0 &kp BSLH &kp SEMI &layer_numbers_kp LAYER_ID_NUMBERS GRAVE
&layer_base_none LAYER_ID_BASE 0 &kp MINUS &kp EQUAL &layer_navigation_none LAYER_ID_NAVIGATION 0
&none &none &none &none &none &none &none &none &none &none &none &none &none
>;
};
parentheticals {
label = "Paren";
bindings = <
&none &none &none &none &none &none &none
&layer_base_none LAYER_ID_BASE 0 &kp LPAR &kp RPAR &layer_numbers_kp LAYER_ID_NUMBERS LBRC
&layer_symbols_none LAYER_ID_SYMBOLS 0 &kp LBKT &kp RBKT &layer_navigation_kp LAYER_ID_NAVIGATION RBRC
&none &none &none &none &none &none &none &none &none &none &none &none &none
>;
};
navigation {
label = "Nav";
bindings = <
&none &none &none &none &none &none &none
&layer_parentheticals_kp LAYER_ID_PARENTHETICALS HOME &kp UP &kp END &layer_numbers_none LAYER_ID_NUMBERS 0
&layer_symbols_kp LAYER_ID_SYMBOLS LEFT &kp DOWN &kp RIGHT &layer_base_none LAYER_ID_BASE 0
&none &none &none &none &none &none &none &none &none &none &none &none &none
>;
};
};
};

75
zmk-config/config/boards/shields/steno_right_lily58/steno_right_lily58.overlay Normal file
View file

@ -0,0 +1,75 @@
/*
* 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;
};
default_transform: keymap_transform_0 {
compatible = "zmk,matrix-transform";
columns = <7>;
rows = <5>;
// | SW1 | SW2 | SW3 | SW4 | SW5 | SW6 |
// | SW7 | SW8 | SW9 | SW10 | SW11 | SW12 |
// | SW13 | SW14 | SW15 | SW16 | SW17 | SW18 |
// | SW25 | SW19 | SW20 | SW21 | SW22 | SW23 | SW24 |
// | SW26 | SW27 | SW28 | SW29 |
map = <
RC(0,0) RC(0,1) RC(0,2) RC(0,3) RC(0,4) RC(0,5)
RC(1,0) RC(1,1) RC(1,2) RC(1,3) RC(1,4) RC(1,5)
RC(2,0) RC(2,1) RC(2,2) RC(2,3) RC(2,4) RC(2,5)
RC(4,0) RC(3,0) RC(3,1) RC(3,2) RC(3,3) RC(3,4) RC(3,5)
RC(4,1) RC(4,2) RC(4,3) RC(4,4)
>;
};
kscan0: kscan {
compatible = "zmk,kscan-gpio-matrix";
label = "KSCAN";
diode-direction = "col2row";
row-gpios
= <&pro_micro_d 5 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&pro_micro_d 6 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&pro_micro_d 7 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&pro_micro_d 8 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
, <&pro_micro_d 9 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)>
;
col-gpios
= <&pro_micro_d 10 GPIO_ACTIVE_HIGH>
, <&pro_micro_d 16 GPIO_ACTIVE_HIGH>
, <&pro_micro_d 14 GPIO_ACTIVE_HIGH>
, <&pro_micro_d 15 GPIO_ACTIVE_HIGH>
, <&pro_micro_a 0 GPIO_ACTIVE_HIGH>
, <&pro_micro_a 1 GPIO_ACTIVE_HIGH>
;
};
};
&pro_micro_i2c {
status = "okay";
oled: ssd1306@3c {
compatible = "solomon,ssd1306fb";
reg = <0x3c>;
label = "DISPLAY";
width = <128>;
height = <32>;
segment-offset = <0>;
page-offset = <0>;
display-offset = <0>;
multiplex-ratio = <31>;
segment-remap;
com-invdir;
com-sequential;
prechargep = <0x22>;
};
};