qmk-firmware/layouts/community/60_tsangan_hhkb/bcat/readme.md
Jonathan Rascher 93bc737a8f
[Keymap] Update bcat's keymaps/userspace to share logic, add OLED functionality, and set up one of my macropads for WFH (#14702)
* Add script to build all bcat keymaps at once

* Move userspace RGB to separate source file

* Move layer handling logic into userspace

* Move keycap aliases into userspace

* Add OLED userspace library and Lily58 OLED setup

* Add Luna keyboard pet, generic OLED pet framework

Luna artwork and original implementation by HellSingCoder, licensed
under GPL v2.0.

See also: 6dfe915e26/keyboards/sofle/keymaps/helltm/keymap.c

* Use OLED on bcat's Crkbd

I had to turn off a few unused features to address firmware size limits.

* Remove vestigial NK_TOGG keybindings

* Add post-render hook to OLED pet API

This enables OLED pets to draw custom widgets (e.g., LED indicator
status) on top of their animation frames.

* Add Isda keyboard pet

For future use on my Unicorne keyboard. Unicorn artwork by sparrow666,
licensed under GPL v2.0.

See also: https://opengameart.org/content/unicorn-2

* Replace OLED timeout implementation with custom

The default implementation never lets the OLED turn off if a continuous
animation is in progress. The custom one does.

* Move keyboard state for OLED functions into struct

No change in firmware size, but makes keymaps read a little nicer and
enables more functionality in OLED pets.

* Enable continuously running OLED pet (for Luna)

* Sync OLED state; enable Bootmagic only when needed

The new extensible split transport for Split Common finally allows OLED
on/off status to be synced between halves of the keyboard. :)

Unfortunately, this required disabling Bootmagic Lite to keep my Crkbd
under the firmware size limit. (I now after 28 bytes free on avr-gcc
version 8.5.0.) So now I'll enable Bootmagic only on keyboards that
actually require it, i.e., ones lacking an accessible reset button.

* Update 9-Key macropad keymap for working from home

* Remove includes redundant with quantum.h

Co-authored-by: Drashna Jaelre <drashna@live.com>

* Simplify BCAT_OLED_PET makefile logic

* Swap some keys on my 9-Key macropad around

* Inline spurious variable in OLED code

* Remove max brightness that's now set by default

The default max brightness is only 120 rather than 150, but that might
actually fix some weirdness I've seen with bright white LED settings.

* Enable specific RGBLIGHT modes instead of default

The general trend these days seems to be enabling only the modes you
want, so I'm manually expanding the ones currently enabled by
RGBLIGHT_ANIMATIONS.

I'd like to try out the TWINKLE mode too, but it seems not to work at
all on ARM right now, and all my usable RGBLIGHT keebs are ARM boards.

* Reenable RGB_MATRIX animations after #15018

My Crkbd still has a reasonable amount of free space with these:
27974/28672 (97%, 698 bytes free). The RGB_MATRIX_KEYPRESSES effects
would put it over the firmware size limit, but I really don't ever use
those anyway.

* Use new get_u8_str function for WPM display

Co-authored-by: Drashna Jaelre <drashna@live.com>
2021-12-27 14:46:00 +11:00

1.7 KiB

bcat's 60% Tsangan HHKB layout

This is a Tsangan/HHKB (split backspace, split right shift) layout following the traditional HHKB layout with a few changes:

  • The Delete key is mapped as Backspace (HHKB DIP switch 3).

  • The Alt and Super keys are swapped to put Alt directly adjacent to the spacebar (HHKB DIP switch 5).

  • The left Super key is replaced with another Function key (HHKB DIP switch 2). Unlike on the real HHKB, this key triggers a different Function 2 layer. (This also helps prevent accidental Super key presses while gaming.)

  • The Function 2 layer contains reset keys, RGB underglow and backlight controls (in place of the arrow and navigation keys), and media controls (centered around the ESDF cluster).

  • The Function 2 layer also has the F1-F12 keys mapped just like the Function 1 layer. This is a concession to gaming because it enables these keys to be easily typed with the left hand, without taking the right hand off the mouse.

  • The leftmost and rightmost bottom row keys are mapped to Ctrl rather than anything more useful because most of my Tsangan PCBs actually have HHKB plates and/or blockers, so there aren't switches installed in those positions.

Default layer

Default layer layout

(KLE)

Function 1 layer

Function l 1ayer layout

(KLE)

Function 2 layer

Function 2 layer layout

(KLE)