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

Update readme to include additional build ; update notes

This commit is contained in:
KemoNine 2020-12-31 03:47:50 +00:00
parent 71cff3297e
commit 4bab811ea0
2 changed files with 13 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
keyboards/zmk-config/README.md
View File

@ -8,18 +8,16 @@ Need to have the `zmk-config` directory mounted at `/workspaces/zmk-config` in D
``` sh
west build --board nrf52840_mdk_dongle -d build/mdk_dongle -- -DSHIELD=mdk_dongle -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/tidbit -- -DSHIELD=tidbit -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/pockettype/default -- -DSHIELD=pockettype -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nrf52840_mdk -d build/pockettype/mdk -- -DSHIELD=pockettype_mdk -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/pockettype/peripheral -- -DSHIELD=pockettype_peripheral -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/tg4x/default -- -DSHIELD=tg4x -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nrf52840_mdk -d build/tg4x/mdk -- -DSHIELD=tg4x_mdk -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/tg4x/peripheral -- -DSHIELD=tg4x_peripheral -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config
west build --board nice_nano -d build/lily58/left -- -DSHIELD=lily58_left -DZMK_CONFIG=/workspaces/zmk-config/keyboards/zmk-config/config

25
keyboards/zmk-config/notes.md
View File

@ -1,17 +1,3 @@
# Split Keyboard FAQ / Notes
- TRRS IS DANGEROUS IF BOTH HALVES HAVE BATTERIES
- TRRS will provide power to peripheral half and that can cause battery overheats, failures, fires
- BOTH HALVES SHOULD BE POWERED INDEPENDENTLY
- Halves communicate via ble
- Both halves should be powered independently of each other
- ONLY the central half should be paired to a computer via BT
- Central half is the only half that has to be plugged into usb for usb hid support
# Generating settings reset images
west build --board nice_nano -d build/settings_reset -- -DSHIELD=settings_reset
# User Behaviors
Needs documentation, see pockettype and mdk dongle for ideas -- specifically the LED code and CMakeLists.txt
@ -20,6 +6,12 @@ Needs documentation, see pockettype and mdk dongle for ideas -- specifically the
Generic behavior for led on/off via gpio (see pocket type / mdk personal sources for ideas)
# Peripheral Over USB
Figure out how to setup the code to allow the peripheral half of a board to work over USB
Per Pete Johnson : Mostly build tweaks
# Dyanmic Layer Actions
- look at hold tap implementation for inspiration (keymap file poprtion)
@ -41,8 +33,13 @@ Generic behavior for led on/off via gpio (see pocket type / mdk personal sources
# Hardware To Do / Notes
## MDK Dongle
Submit to upstream zephyr
## Dongles
- Remove need to have kscan defined for the dongle portion of a build
- Setup user buttons via user code to trip boot loader / other things
- Can do `zmk-config/config/boards/shields/CMakeLists.txt`
- Setup dedicated mdk dongle shield