drashna/qmk_firmware
1
0
Fork 0
Code Activity Actions

Whitespace cleanup.

Browse source
This commit is contained in:
alex-ong 2019-01-26 17:38:52 +11:00
parent 4d8733591f
commit 574fc6444b
5 changed files with 12 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/feature_debounce_algo.md
View file

@ -7,18 +7,16 @@ The underlying debounce algorithm is determined by which matrix.c file you are u
The logic for which debounce method called is below. It checks various defines that you have set in rules.mk
```
ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
# Do nothing, debouncing is inside matrix.c inside split_common
else ifeq ($(strip $(DEBOUNCE_ALGO)), manual)
ifeq ($(strip $(DEBOUNCE_ALGO)), manual)
# Do nothing. do your debouncing in matrix.c
else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g)
TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c
QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk)
TMK_COMMON_SRC += $(DEBOUNCE)/debounce_eager_pk.c
QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c
else ifeq ($(strip $(CUSTOM_MATRIX)), yes)
# Do nothing. Custom matrix code.
else # default algorithm
TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c
QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
endif
```
@ -32,11 +30,10 @@ The following is for keyboards where ```SPLIT_KEYBOARD``` is **not** defined as
| sym_g / eager_pk | Not defined | You are using the included matrix.c and debounce.c | Nothing. Chosen debounce method used. |
| Not defined | YES | You have your own matrix.c, and your own debounce | Write the fully debounced matrix into matrix.c's matrix |
| manual | YES | Same as above | same as above |
| sym_g/ eager_pk | YES | You are using your own matrix.c, but included debounce | Write the raw matrix values into matrix.c's matrix |
| sym_g / eager_pk | YES | You are using your own matrix.c, but included debounce | Write the raw matrix values into matrix.c's matrix |
**Note**:
If ```SPLIT_KEYBOARD = YES``` is defined, the algorithm inside split_common will be used.
A future pull request will fix this to use the debounce.c code.
**Regarding split keyboards**:
The debounce code is compatible with split keyboards.
# Use your own debouncing code
* Set ```DEBOUNCE_ALGO = manual```.