diff options
Diffstat (limited to 'docs/feature_debounce_algo.md')
| -rw-r--r-- | docs/feature_debounce_algo.md | 17 |
1 files changed, 7 insertions, 10 deletions
diff --git a/docs/feature_debounce_algo.md b/docs/feature_debounce_algo.md index 2c694cdfb..e4489662e 100644 --- a/docs/feature_debounce_algo.md +++ b/docs/feature_debounce_algo.md | |||
| @@ -7,18 +7,16 @@ The underlying debounce algorithm is determined by which matrix.c file you are u | |||
| 7 | The logic for which debounce method called is below. It checks various defines that you have set in rules.mk | 7 | The logic for which debounce method called is below. It checks various defines that you have set in rules.mk |
| 8 | 8 | ||
| 9 | ``` | 9 | ``` |
| 10 | ifeq ($(strip $(SPLIT_KEYBOARD)), yes) | 10 | ifeq ($(strip $(DEBOUNCE_ALGO)), manual) |
| 11 | # Do nothing, debouncing is inside matrix.c inside split_common | ||
| 12 | else ifeq ($(strip $(DEBOUNCE_ALGO)), manual) | ||
| 13 | # Do nothing. do your debouncing in matrix.c | 11 | # Do nothing. do your debouncing in matrix.c |
| 14 | else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g) | 12 | else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g) |
| 15 | TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c | 13 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c |
| 16 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) | 14 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) |
| 17 | TMK_COMMON_SRC += $(DEBOUNCE)/debounce_eager_pk.c | 15 | QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c |
| 18 | else ifeq ($(strip $(CUSTOM_MATRIX)), yes) | 16 | else ifeq ($(strip $(CUSTOM_MATRIX)), yes) |
| 19 | # Do nothing. Custom matrix code. | 17 | # Do nothing. Custom matrix code. |
| 20 | else # default algorithm | 18 | else # default algorithm |
| 21 | TMK_COMMON_SRC += $(DEBOUNCE)/debounce_sym_g.c | 19 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c |
| 22 | endif | 20 | endif |
| 23 | ``` | 21 | ``` |
| 24 | 22 | ||
| @@ -32,11 +30,10 @@ The following is for keyboards where ```SPLIT_KEYBOARD``` is **not** defined as | |||
| 32 | | sym_g / eager_pk | Not defined | You are using the included matrix.c and debounce.c | Nothing. Chosen debounce method used. | | 30 | | sym_g / eager_pk | Not defined | You are using the included matrix.c and debounce.c | Nothing. Chosen debounce method used. | |
| 33 | | Not defined | YES | You have your own matrix.c, and your own debounce | Write the fully debounced matrix into matrix.c's matrix | | 31 | | Not defined | YES | You have your own matrix.c, and your own debounce | Write the fully debounced matrix into matrix.c's matrix | |
| 34 | | manual | YES | Same as above | same as above | | 32 | | manual | YES | Same as above | same as above | |
| 35 | | 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 | | 33 | | 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 | |
| 36 | 34 | ||
| 37 | **Note**: | 35 | **Regarding split keyboards**: |
| 38 | If ```SPLIT_KEYBOARD = YES``` is defined, the algorithm inside split_common will be used. | 36 | The debounce code is compatible with split keyboards. |
| 39 | A future pull request will fix this to use the debounce.c code. | ||
| 40 | 37 | ||
| 41 | # Use your own debouncing code | 38 | # Use your own debouncing code |
| 42 | * Set ```DEBOUNCE_ALGO = manual```. | 39 | * Set ```DEBOUNCE_ALGO = manual```. |
