1f9a63b6ec
Some checks failed
Automatic Approve / automatic_approve (push) Has been cancelled
Update API Data / api_data (push) Has been cancelled
CI Builds / CI Build (default) (push) Has been cancelled
CI Builds / CI Build (via) (push) Has been cancelled
CLI CI / test (push) Has been cancelled
Update develop after master merge / develop_update (push) Has been cancelled
Lint Format / lint (push) Has been cancelled
Regenerate Files / regen (push) Has been cancelled
Unit Tests / test (push) Has been cancelled
Close stale issues and PRs / stale (push) Has been cancelled
Modern rewrite of the old planck/keymaps/audax (which used the removed fn_actions/action_get_macro API) as the Planck counterpart of the ergodox audax_osx layout. The base layer and Mod3 send positional NE_* scancodes that the OS neo2 layout translates; numbers, function keys and the cursor block stay on firmware layers (_RS/_LW) so they auto-repeat. Mod3 is held on '#', the right Mod3 key taps the neo2 sharp-s, and '@' is Mod3 + y. Built and verified for planck/rev4.
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# audax_osx (Planck) - neo2 for macOS via the software neo2 layout
|
|
|
|
Planck counterpart of the ergodox `audax_osx` layout, and a modern rewrite of
|
|
the old `planck/keymaps/audax` (which used the long-removed `fn_actions` /
|
|
`action_get_macro` API and no longer builds).
|
|
|
|
Like the ergodox layout, it expects the **software neo2 keyboard layout** to be
|
|
installed on the Mac (see the full setup in
|
|
`layouts/community/ergodox/audax_osx/readme.md`):
|
|
|
|
- Install [neo2-layout-osx](https://github.com/jgosmann/neo2-layout-osx) and
|
|
select it as the active input source.
|
|
- The base layer and Mod3 send positional `NE_*` scancodes; the OS neo2 layout
|
|
produces the characters.
|
|
|
|
## Layers
|
|
|
|
- **`_NE`** - neo2 base. Left/right Mod3 keys both hold `#` (`NE_L3R` /
|
|
`KC_NUHS`); macOS intercepts CapsLock, so the canonical Mod3-left (`NE_L3L`)
|
|
is not used. The right Mod3 key **taps to `ß`**; `@` (on `_LW`) is Mod3 + y.
|
|
- **`_RS`** (hold bottom-right) - number row, F-keys, media, `QK_BOOT`, and
|
|
`DF(_NE)` to reset the default layer.
|
|
- **`_LW`** (hold bottom-left) - cursor block on the left, numbers on the right,
|
|
`ß`, `@`, and a few macOS shortcuts. These are firmware keycodes, so the
|
|
cursor keys and numbers auto-repeat when held.
|
|
|
|
## Building and flashing
|
|
|
|
Built for a Massdrop/OLKB Planck **rev4** (atmega32u4, mini-USB, USB device
|
|
version 0.0.4, `atmel-dfu` bootloader):
|
|
|
|
```
|
|
qmk flash -kb planck/rev4 -km audax_osx
|
|
```
|
|
|
|
Put the board in the bootloader when prompted (physical RESET button on the
|
|
PCB; after this layout is flashed, `QK_BOOT` also lives on the `_RS` layer). The
|
|
keymap is revision-independent - substitute another target (`rev5`, `rev6`,
|
|
`rev6_drop`, ...) if you use a different Planck.
|
|
|
|
## Notes
|
|
|
|
- The right Mod3 tap emits `ß` (matching the ergodox `audax_osx`). The original
|
|
Planck `audax` tapped `y` here; `ß` was chosen instead since `y` already sits
|
|
on the base layer's top-right.
|
|
- The old `keyboards/planck/keymaps/audax` is left untouched.
|