History

Ryan d09a06a1b3 Update GPIO API usage in keyboard code (#23361 )		2024-05-03 15:21:29 +10:00
..
keymaps/default	Remove userspace keymaps (#22544 )	2023-11-27 05:36:45 +11:00
chconf.h
config.h	WS2812 PWM: prefix for DMA defines (#23111 )	2024-03-02 17:16:47 +00:00
halconf.h
keyboard.json	Migrate build target markers to keyboard.json - P (#23565 )	2024-04-22 02:06:41 +01:00
matrix.c	Update GPIO API usage in keyboard code (#23361 )	2024-05-03 15:21:29 +10:00
mcuconf.h
readme.md
rev7.c
rules.mk	Migrate build target markers to keyboard.json - P (#23565 )	2024-04-22 02:06:41 +01:00

readme.md

Planck

A compact 40% (12x4) ortholinear keyboard kit designed by OLKB and sold by Drop. A complete hardware rework of the rev6 Planck PCB, with support for up to 8 rotary encoders. More info on qmk.fm

Keyboard Maintainer: Jack Humbert
Hardware Supported: Planck PCB rev7
Hardware Availability: Drop

Make example for this keyboard (after setting up your build environment):

make planck/rev7:default

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Encoders

Encoders must have matching pulse & detent resolutions (e.g. 24/24) for the scanning to work properly. Multiple encoders can be used at the same time, and are zero-indexed (compared to being one-indexed on the PCB's silkscreen) in the encoder_update_user(uint8_t index, bool clockwise) function:

,-----------------------------------------------------------------------------------.
|   0  |      |      |      |      |      |      |      |      |      |      |   4  |
|------+------+------+------+------+------+------+------+------+------+------+------|
|   1  |      |      |      |      |      |      |      |      |      |      |   5  |
|------+------+------+------+------+------+------+------+------+------+------+------|
|   2  |      |      |      |      |      |      |      |      |      |      |   6  |
|------+------+------+------+------+------+------+------+------+------+------+------|
|   3  |      |      |      |      |             |      |      |      |      |   7  |
`-----------------------------------------------------------------------------------'

If an encoder has a switch built-in, it's connected to the key at that location. On the default keymap, each encoder will play its own rising/falling tone sequence when rotated, and will reset the pitch after one second of inactivity. The encoder map feature is not currently supported.

Some Planck-specific config.h options:

// sets the length (in seconds) of the watchdog timer, which will reset the keyboard due to hang/crash in the code
#define PLANCK_WATCHDOG_TIMEOUT 1.0
// disables the watchdog timer - you may want to disable the watchdog timer if you use longer macros
#define PLANCK_WATCHDOG_DISABLE
// the resolution of the encoders used in the encoder matrix
#define PLANCK_ENCODER_RESOLUTION 4