1
0
Fork 0
qmk_firmware/layouts/community/split_3x6_3/bcat
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
..
config.h [Keymap] Update bcat's keymaps/userspace to share logic, add OLED functionality, and set up one of my macropads for WFH (#14702) 2021-12-27 14:46:00 +11:00
keymap.c [Keymap] Update bcat's keymaps/userspace to share logic, add OLED functionality, and set up one of my macropads for WFH (#14702) 2021-12-27 14:46:00 +11:00
readme.md [Keymap] Update bcat's keymaps/userspace to share logic, add OLED functionality, and set up one of my macropads for WFH (#14702) 2021-12-27 14:46:00 +11:00
rules.mk [Keymap] Update bcat's keymaps/userspace to share logic, add OLED functionality, and set up one of my macropads for WFH (#14702) 2021-12-27 14:46:00 +11:00

bcat's split 3x6 + 3 thumb keys layout

(See also the BlueMicro and ZMK versions of this keymap.)

This is my favorite split ergo layout for typing, featuring the traditional four ortho/ergo layers (Default, Lower, Raise, Adjust). It is loosely inspired by the default Planck (numbers on Lower, symbols on Raise) and Crkbd (Space on left, Enter on right) layouts, but has since been redesigned heavily according to the principles described below.

  • Since my most-frequently-used keyboard shortcuts involve Ctrl, which lives on the left half of the keyboard, keys frequently used with it (numbers, function keys, etc.) are on the Raise layer activated by the right thumb.

  • Navigation can be done on the right half alone, to enable simultaneous left-handed mousing. Additionally, Web pages can be scrolled with Space or Shift+Space on the left half alone, to enable taking notes with the right hand at the same time.

  • Other than Right Shift (which I seldom use), mods aren't rebound on layers.

  • Likewise, Backspace is not rebound on layers to avoid having to let go of layer-switch keys to correct mistakes.

Default layer

Default layer layout

(KLE)

  • The alpha keys are a standard QWERTY layout, no funny business there.

  • Tab and Backspace are in familiar locations from my row-staggered boards (almost all of which use HHKB-style split backspace).

  • The Esc key is next to the home row for convenience in Vim.

  • There are two Shift keys, although I generally use Left Shift. (I've considered replacing Right Shift with another key, but haven't chosen one.)

  • Lower and Raise layer-switch keys are in the resting position of my left and right thumbs, respectively.

  • Space and Enter are on the big thumb keys so they're easy to press.

  • Ctrl is on the left for ease of chording, especially one-handed use of common shortcuts like Ctrl+T and Ctrl+W. This puts Alt on the right by the process of elimination. (I would really like one more 1U thumb key on each half to allow for a redundant Alt key on the left and a dedicated Super key on the right.)

Lower layer

Lower layer layout

(KLE)

  • This could also be called the "symbol layer".

  • Shifted numbers are bound in their usual positions on the top row.

  • Hyphen/Underscore and Equals/Plus are in the right index- and middle-finger columns for easy reach. They share the same relative position as on a row-staggered keyboard, and the shifted versions are physically above the unshifted versions as a mnemonic device.

  • Brackets and braces are placed below the parens for easy recall. Once again, the shifted versions are on the home row and the unshifted versions are on the bottom row.

  • Forward Slash/Pipe and Backtick/Tilde fill out the remaining positions on the right half, with the same relative positions as on a row-staggered HHKB layout. And yup, the shifted versions are above the unshifted versions.

  • Remaining keys from a TKL are placed out of the way on the bottom row of the left half.

  • The home row on the left half contains handy shortcuts for zooming and browser navigation.

  • Lower+Esc is bound to Ctrl+Space because the Ctrl and Space keys are both on the left thumb, so this key combination (which I use for tmux prefix and editor autocomplete) is hard to press in its natural location.

  • Lower+Tab is bound to a custom Alt+Tab macro that keeps the Alt modifier held as long as the Lower key is held down. This means that window switching is on Lower+Tab immediately next to browser tab switching (Ctrl+Tab).

Raise layer

Raise layer layout

(KLE)

  • This could also be called the "number layer".

  • Unshifted numbers are bound in their usual positions on the top row.

  • Arrow keys are on VIM-style HJKL keys.

  • Home/End and Page Up/Page Down are in the same column as the arrow keys, but translated down one row. (This means that the comma and period keys are not bound on the number layer, which makes data entry a bit funky. I might add a dedicated numpad layer to compensate.)

  • Function keys F1F10 take up most of remaining space on the left half, with F11 and F12 spilling over to the right half. (This puts the most used function keys (F1F5) on the home row.)

  • Insert and Delete are on the rightmost column, because there didn't seem to be a better place to put them.

  • Caps Lock is bound in the same position as on an HHKB, for lack of an obvious better location.

Adjust layer

Adjust layer layout

(KLE)

  • Media keys are centered around the ESDF cluster, just like I arrange them on row-staggered keyboards. (It's even more sensible with columnar stagger.)

  • The navigation keys are replaced by RGB controls. Again, this mirrors the positioning I use on my row-staggered keyboards.

  • Finally, reset keys live at the top-left corner of the right half where it's reasonably hard to press them by accident.