Update debounce docs (#7355)
This commit is contained in:
		
							parent
							
								
									44df08746a
								
							
						
					
					
						commit
						872744f5ab
					
				
					 1 changed files with 5 additions and 5 deletions
				
			
		| 
						 | 
					@ -17,14 +17,14 @@ endif
 | 
				
			||||||
| DEBOUNCE_TYPE    | Description                                          | What else is needed           |
 | 
					| DEBOUNCE_TYPE    | Description                                          | What else is needed           |
 | 
				
			||||||
| -------------    | ---------------------------------------------------  | ----------------------------- |
 | 
					| -------------    | ---------------------------------------------------  | ----------------------------- |
 | 
				
			||||||
| Not defined      | Use the default algorithm, currently sym_g           | Nothing                       |
 | 
					| 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                       |
 | 
					| anything_else    | Use another algorithm from quantum/debounce/*        | Nothing                       |
 | 
				
			||||||
 | 
					
 | 
				
			||||||
**Regarding split keyboards**:
 | 
					**Regarding split keyboards**:
 | 
				
			||||||
The debounce code is compatible with split keyboards.
 | 
					The debounce code is compatible with split keyboards.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
# Use your own debouncing code
 | 
					# Use your own debouncing code
 | 
				
			||||||
* Set ```DEBOUNCE_TYPE = custom ```.
 | 
					* Set ```DEBOUNCE_TYPE = custom```.
 | 
				
			||||||
* Add ```SRC += debounce.c```
 | 
					* Add ```SRC += debounce.c```
 | 
				
			||||||
* Add your own ```debounce.c```. Look at current implementations in ```quantum/debounce``` for examples.
 | 
					* Add your own ```debounce.c```. Look at current implementations in ```quantum/debounce``` for examples.
 | 
				
			||||||
* Debouncing occurs after every raw matrix scan.
 | 
					* Debouncing occurs after every raw matrix scan.
 | 
				
			||||||
| 
						 | 
					@ -33,10 +33,10 @@ The debounce code is compatible with split keyboards.
 | 
				
			||||||
# Changing between included debouncing methods
 | 
					# Changing between included debouncing methods
 | 
				
			||||||
You can either use your own code, by including your own debounce.c, or switch to another included one.
 | 
					You can either use your own code, by including your own debounce.c, or switch to another included one.
 | 
				
			||||||
Included debounce methods are:
 | 
					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
 | 
					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.
 | 
					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
 | 
					* 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_DELAY``` milliseconds of no changes has occured, all input changes are pushed.
 | 
					* 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.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
| 
						 | 
					
 | 
				
			||||||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue