kb01/zmk
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge https://github.com/zmkfirmware/zmk into main

Browse source
This commit is contained in:
Jack Hartstein 2021-01-01 14:12:14 -08:00
commit fd85ef19f6
12 changed files with 180 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
.github/workflows/build.yml vendored
View file

@ -29,6 +29,7 @@ jobs:
- cradio_left
- cradio_right
- crbn
- eek
- iris_left
- iris_right
- jian_left

12
app/boards/shields/eek/Kconfig.defconfig Normal file
View file

@ -0,0 +1,12 @@
#
# Copyright (c) 2020 The ZMK Contributors
#
# SPDX-License-Identifier: MIT
#
if SHIELD_EEK
config ZMK_KEYBOARD_NAME
default "eek! ~ Keyboard"
endif

8
app/boards/shields/eek/Kconfig.shield Normal file
View file

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

0
app/boards/shields/eek/eek.conf Normal file
View file

56
app/boards/shields/eek/eek.keymap Normal file
View file

@ -0,0 +1,56 @@
/*
* 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>
#include <dt-bindings/zmk/outputs.h>
/ {
keymap {
compatible = "zmk,keymap";
default {
// --------------------------------------------------------------------------------------------------------------------------------------------------------------------
// Q | W | E | R | T | | Y | U | I | O | P |
// A | S | D | F | G | | H | J | K | L | ; |
// Lsft/Z| X | C | V | B | | N | M | , | . |Rsft//|
// | LCTL | Bspc/LMOD | SPC | | Del/Num | Ent | Sym |
bindings = <
&kp Q &kp W &kp E &kp R &kp T &kp Y &kp U &kp I &kp O &kp P
&kp A &kp S &kp D &kp F &kp G &kp H &kp J &kp K &kp L &kp SEMI
&mt LSHFT Z &kp X &kp C &kp V &kp B &kp N &kp M &kp COMMA &kp DOT &mt RSHFT FSLH
&kp LCTRL &mt LGUI BSPC &kp SPACE &lt 1 DEL &kp RET &mo 2
>;
};
numbers {
// --------------------------------------------------------------------------------------------------------------------------------------------------------------------
// 1 | 2 | 3 | 4 | 5 | | 6 | 7 | 8 | 9 | 0 |
// TAB | BT_PRV | BT_NXT | VOL-| VOL+| | < | v | ∧ | > | ' |
// Lsft| BT_SEL0| BT_CLR | MUTE| | | HOME| END | PGUP| PGDN| Rsft|
// | LCTL | LMOD| LALT | | Num | | BL-reset |
bindings = <
&kp N1 &kp N2 &kp N3 &kp N4 &kp N5 &kp N6 &kp N7 &kp N8 &kp N9 &kp N0
&kp TAB &bt BT_PRV &bt BT_NXT &kp C_VOL_DN &kp C_VOL_UP &kp LEFT &kp DOWN &kp UP &kp RIGHT &kp SQT
&kp LSHFT &bt BT_SEL 0 &bt BT_CLR &kp C_MUTE &none &kp HOME &kp END &kp PG_UP &kp PG_DN &kp RSHFT
&kp LCTRL &kp LGUI &kp LALT &trans &none &bootloader
>;
};
symbols {
// --------------------------------------------------------------------------------------------------------------------------------------------------------------------
// ESC | F1 | F2 | F3 | F4 | | OUT_USB | OUT_BLE | | = | - |
// CAPS| F5 | F6 | F7 | F8 | | [ | ] | | ` | \ |
// LSFT| F9 | F10 | F11 | F12 | | | | | | RSFT |
// | LCTL | LMOD| LALT | | RESET | | SYM |
bindings = <
&kp ESC &kp F1 &kp F2 &kp F3 &kp F4 &out OUT_USB &out OUT_BLE &none &kp EQUAL &kp MINUS
&kp CAPS &kp F5 &kp F6 &kp F7 &kp F8 &kp LBKT &kp RBKT &none &kp GRAVE &kp BSLH
&kp LSHFT &kp F9 &kp F10 &kp F11 &kp F12 &none &none &none &kp RSHFT
&kp LCTRL &kp LGUI &kp LALT &reset &none &trans
>;
};
};
};

52
app/boards/shields/eek/eek.overlay Normal file
View file

@ -0,0 +1,52 @@
/*
* 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 = <10>;
rows = <4>;
map = <
RC(0,9) RC(0,8) RC(0,7) RC(0,6) RC(0,5) RC(0,4) RC(0,3) RC(0,2) RC(0,1) RC(0,0)
RC(1,9) RC(1,8) RC(1,7) RC(1,6) RC(1,5) RC(1,4) RC(1,3) RC(1,2) RC(1,1) RC(1,0)
RC(2,9) RC(2,8) RC(2,7) RC(2,6) RC(2,5) RC(2,4) RC(2,3) RC(2,2) RC(2,1) RC(2,0)
RC(3,7) RC(3,6) RC(3,5) RC(3,4) RC(3,3) RC(3,2)
>;
};
kscan0: kscan_0 {
compatible = "zmk,kscan-gpio-matrix";
label = "KSCAN";
diode-direction = "col2row";
col-gpios
= <&pro_micro_d 4 GPIO_ACTIVE_HIGH>
, <&pro_micro_d 5 GPIO_ACTIVE_HIGH>
, <&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_a 2 GPIO_ACTIVE_HIGH>
, <&pro_micro_a 3 GPIO_ACTIVE_HIGH>
;
row-gpios
= <&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)>
;
};
};

1
app/boards/shields/eek/readme.md Normal file
View file

@ -0,0 +1 @@
A fixed split 36key-board with a typing angle of 90 degrees distributed by cbkbd

34
app/boards/shields/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;
};
};

1
docs/docs/hardware.md
View file

@ -37,6 +37,7 @@ That being said, there are currently only a few specific [boards](/docs/faq#what
- [QAZ](https://www.cbkbd.com/product/qaz-keyboard-kit) (`qaz`)
- [CRBN](https://keygem.store/collections/group-buys/products/group-buy-featherlight-40-kit) (`crbn`)
- [tidbit](https://nullbits.co/tidbit/) (`tidbit`)
- [Eek!](https://www.cbkbd.com/product/eek-keyboard) (`eek`)
## Other Hardware

20
docs/src/data/hid.js
View file

@ -3218,7 +3218,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -3239,7 +3239,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: false,
ios: null,
},
footnotes: {},
@ -3260,7 +3260,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: false,
ios: null,
},
footnotes: {},
@ -5172,7 +5172,7 @@ export default [
windows: null,
linux: true,
android: null,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -5193,7 +5193,7 @@ export default [
windows: null,
linux: true,
android: null,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -5886,7 +5886,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -5907,7 +5907,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -6054,7 +6054,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -6138,7 +6138,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},
@ -6159,7 +6159,7 @@ export default [
windows: null,
linux: true,
android: true,
macos: null,
macos: true,
ios: null,
},
footnotes: {},

6
docs/static/setup.ps1 vendored
View file

@ -91,9 +91,9 @@ Write-Host "Keyboard Shield Selection:"
$prompt = "Pick a keyboard"
# TODO: Add support for "Other" and linking to docs on adding custom shields in user config repos.
$options = "Kyria", "Lily58", "Corne", "Splitreus62", "Sofle", "Iris", "Reviung41", "RoMac", "RoMac+", "makerdiary M60", "Microdox", "TG4X", "QAZ", "NIBBLE", "Jorne", "Jian", "CRBN", "Tidbit"
$names = "kyria", "lily58", "corne", "splitreus62", "sofle", "iris", "reviung41", "romac", "romac_plus", "m60", "microdox", "tg4x", "qaz", "nibble", "jorne", "jian", "crbn", "tidbit"
$splits = "y", "y", "y", "y", "y", "y", "n", "n", "n", "n", "y", "n", "n", "n", "y", "y", "n", "n"
$options = "Kyria", "Lily58", "Corne", "Splitreus62", "Sofle", "Iris", "Reviung41", "RoMac", "RoMac+", "makerdiary M60", "Microdox", "TG4X", "QAZ", "NIBBLE", "Jorne", "Jian", "CRBN", "Tidbit", "Eek!"
$names = "kyria", "lily58", "corne", "splitreus62", "sofle", "iris", "reviung41", "romac", "romac_plus", "m60", "microdox", "tg4x", "qaz", "nibble", "jorne", "jian", "crbn", "tidbit", "eek"
$splits = "y", "y", "y", "y", "y", "y", "n", "n", "n", "n", "y", "n", "n", "n", "y", "y", "n", "n", "n"
$choice = Get-Choice-From-Options -Options $options -Prompt $prompt
$shield_title = $($options[$choice])

3
docs/static/setup.sh vendored
View file

@ -92,7 +92,7 @@ echo ""
echo "Keyboard Shield Selection:"
prompt="Pick an keyboard:"
options=("Kyria" "Lily58" "Corne" "Splitreus62" "Sofle" "Iris" "Reviung41" "RoMac" "RoMac+" "makerdiary M60" "Microdox" "TG4X" "QAZ" "Jorne" "Jian" "CRBN" "Tidbit")
options=("Kyria" "Lily58" "Corne" "Splitreus62" "Sofle" "Iris" "Reviung41" "RoMac" "RoMac+" "makerdiary M60" "Microdox" "TG4X" "QAZ" "Jorne" "Jian" "CRBN" "Tidbit" "Eek!")
PS3="$prompt "
# TODO: Add support for "Other" and linking to docs on adding custom shields in user config repos.
@ -119,6 +119,7 @@ select opt in "${options[@]}" "Quit"; do
16 ) shield_title="Jian" shield="jian"; split="y"; break;;
17 ) shield_title="CRBN" shield="crbn"; split="n"; break;;
18 ) shield_title="Tidbit" shield="tidbit"; split="n" break;;
19 ) shield_title="Eek!" shield="eek"; split="n" break;;
# Add link to docs on adding your own custom shield in your ZMK config!
# $(( ${#options[@]}+1 )) ) echo "Other!"; break;;