diff options
| author | Jack Humbert <jack.humb@gmail.com> | 2023-06-20 20:32:32 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-20 20:32:32 -0400 |
| commit | 42cd55e08d5ba1b7b5bbbedaee1737c9febdcd64 (patch) | |
| tree | 8596d8e39e286ea5c31a0fe0c258d207db2ba1a1 /keyboards/planck/rev7/readme.md | |
| parent | ac14fce06da3b73b6b150af97d956fe573b7882a (diff) | |
Planck Matrix Fixes (#21196)
* fix non-default keymap compiling, initial matrix state, watchdog options
* fix: allow planck/rev7 to be used with ENCODER_ENABLE = no
* chore: update function name on all cases.
* remove old midi tone option
Co-authored-by: Ryan <fauxpark@gmail.com>
* fixes abhixec's planck keymap
* add audio enable condition to abhixec's planck keymap
* add audio enable condition to all muse includes
* Revert "add audio enable condition to all muse includes"
This reverts commit 9779e908970dbf7cf81b1a3f968ef2e85ae2b76f.
* Revert "add audio enable condition to abhixec's planck keymap"
This reverts commit 24c742a5e8ddd55c45ce9f1917b0cb237d4bf721.
* Revert "fixes abhixec's planck keymap"
This reverts commit 4bb085d1ff00febc92ff6211da4fb776c6379fad.
---------
Co-authored-by: Peter.Falken <luis@bitjester.com>
Co-authored-by: Ryan <fauxpark@gmail.com>
Diffstat (limited to 'keyboards/planck/rev7/readme.md')
| -rw-r--r-- | keyboards/planck/rev7/readme.md | 15 |
1 files changed, 13 insertions, 2 deletions
diff --git a/keyboards/planck/rev7/readme.md b/keyboards/planck/rev7/readme.md index 9b531a4e09..6a4df37704 100644 --- a/keyboards/planck/rev7/readme.md +++ b/keyboards/planck/rev7/readme.md @@ -14,7 +14,7 @@ See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_to ## 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(index, clockwise)` function: +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: ``` ,-----------------------------------------------------------------------------------. @@ -28,4 +28,15 @@ Encoders must have matching pulse & detent resolutions (e.g. 24/24) for the scan `-----------------------------------------------------------------------------------' ``` -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. +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: + +```c +// 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 +``` |