keyboard/zmk/app/boards/shields/tidbit
2020-11-25 16:33:09 -05:00
..
boards Finalize initial bring up of tidbit on zmk 2020-11-21 19:54:26 -05:00
Kconfig.defconfig Further readme updates for zmk tidbit ; prep work for oled/lvgl based on corne code 2020-11-25 01:32:04 -05:00
Kconfig.shield Add readme for tidbit bring up (mainly notes) ; finalize 19keys keymap 2020-11-25 00:58:34 -05:00
README.md Cleanup 19keys tidbit zmk build so it's easier to work with 2020-11-25 16:33:09 -05:00
tidbit.conf Finalize initial bring up of tidbit on zmk 2020-11-21 19:54:26 -05:00
tidbit.dtsi Further readme updates for zmk tidbit ; prep work for oled/lvgl based on corne code 2020-11-25 01:32:04 -05:00
tidbit.keymap Add readme for tidbit bring up (mainly notes) ; finalize 19keys keymap 2020-11-25 00:58:34 -05:00
tidbit.overlay Add readme for tidbit bring up (mainly notes) ; finalize 19keys keymap 2020-11-25 00:58:34 -05:00
tidbit_19key.keymap Add readme for tidbit bring up (mainly notes) ; finalize 19keys keymap 2020-11-25 00:58:34 -05:00
tidbit_19key.overlay Cleanup 19keys tidbit zmk build so it's easier to work with 2020-11-25 16:33:09 -05:00

Building ZMK for the Tidbit

Some general notes/commands for building standard Tidbit layouts from the assembly documentation.

Standard "Non Dense" Build


west build -p --board nice_nano -d build/tidbit/default -- -DSHIELD=tidbit

Dense "19 keys" Build


west build -p --board nice_nano -d build/tidbit/19_key -- -DSHIELD=tidbit_19key

Underglow / LEDs

If you built your tidbit without the underglow leds, you'll need to add the following to one of the above commands.


-DCONFIG_ZMK_RGB_UNDERGLOW=n -DCONFIG_WS2812_STRIP=n

Encoder Notes

If you built your tidbit without encoders, you'll need to add the following to one of the above commands.


-DCONFIG_EC11=n -DCONFIG_EC11_TRIGGER_GLOBAL_THREAD=n

OLED Builds

If using an OLED screen you'll need to include the following at the end of one of the above commands to build support for the OLED into the firmware.

-DZMK_DISPLAY=yes

You'll also need to add the following to your keymap file.


&pro_micro_i2c {
	status = "okay";
};

Graphcs Library

If you'd like to use lvgl with an OLED please append BOTH the above OLED parameter and the below to one of the above commands.


-DLVGL=yes