aboutsummaryrefslogtreecommitdiffstats
path: root/docs/feature_debounce_type.md
diff options
context:
space:
mode:
authorDrashna Jaelre <drashna@live.com>2019-11-14 10:54:34 -0800
committerJoel Challis <git@zvecr.com>2019-11-14 18:54:34 +0000
commit872744f5ab515c2169ac43e54148d845f483ebaf (patch)
tree0a508cb2661a9a2df96751790b9d1c3bbe9a170a /docs/feature_debounce_type.md
parent44df08746a97d7177a9ad918e4d5da3a5cf437d3 (diff)
downloadfirmware-872744f5ab515c2169ac43e54148d845f483ebaf.tar.gz
firmware-872744f5ab515c2169ac43e54148d845f483ebaf.tar.bz2
firmware-872744f5ab515c2169ac43e54148d845f483ebaf.zip
Update debounce docs (#7355)
Diffstat (limited to 'docs/feature_debounce_type.md')
-rw-r--r--docs/feature_debounce_type.md10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/feature_debounce_type.md b/docs/feature_debounce_type.md
index 38eca3f37..b5e5b61bb 100644
--- a/docs/feature_debounce_type.md
+++ b/docs/feature_debounce_type.md
@@ -17,14 +17,14 @@ endif
| DEBOUNCE_TYPE | Description | What else is needed |
| ------------- | --------------------------------------------------- | ----------------------------- |
| Not defined | Use the default algorithm, currently sym_g | Nothing |
-| custom | Use your own debounce.c | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions |
+| custom | Use your own debounce code | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions |
| anything_else | Use another algorithm from quantum/debounce/* | Nothing |
**Regarding split keyboards**:
The debounce code is compatible with split keyboards.
# Use your own debouncing code
-* Set ```DEBOUNCE_TYPE = custom ```.
+* Set ```DEBOUNCE_TYPE = custom```.
* Add ```SRC += debounce.c```
* Add your own ```debounce.c```. Look at current implementations in ```quantum/debounce``` for examples.
* Debouncing occurs after every raw matrix scan.
@@ -33,10 +33,10 @@ The debounce code is compatible with split keyboards.
# Changing between included debouncing methods
You can either use your own code, by including your own debounce.c, or switch to another included one.
Included debounce methods are:
-* eager_pr - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE_DELAY``` milliseconds of no further input for that row.
+* eager_pr - debouncing per row. On any state change, response is immediate, followed by locking the row ```DEBOUNCE``` milliseconds of no further input for that row.
For use in keyboards where refreshing ```NUM_KEYS``` 8-bit counters is computationally expensive / low scan rate, and fingers usually only hit one row at a time. This could be
appropriate for the ErgoDox models; the matrix is rotated 90°, and hence its "rows" are really columns, and each finger only hits a single "row" at a time in normal use.
-* eager_pk - debouncing per key. On any state change, response is immediate, followed by ```DEBOUNCE_DELAY``` milliseconds of no further input for that key
-* sym_g - debouncing per keyboard. On any state change, a global timer is set. When ```DEBOUNCE_DELAY``` milliseconds of no changes has occured, all input changes are pushed.
+* eager_pk - debouncing per key. On any state change, response is immediate, followed by ```DEBOUNCE``` milliseconds of no further input for that key
+* sym_g - debouncing per keyboard. On any state change, a global timer is set. When ```DEBOUNCE``` milliseconds of no changes has occured, all input changes are pushed.