Remove backwards compatibility of debounce names (#13877)
* Remove backwards compatibility of debounce names * Update docs * Update keyboards/keymaps
This commit is contained in:
Joel Challis
GitHub
parent
7c691d82bf
commit
c0628c2820
11 changed files with 10 additions and 56 deletions
|
|
@ -514,22 +514,10 @@ ifneq ($(strip $(CUSTOM_MATRIX)), yes)
|
|||
endif
|
||||
endif
|
||||
|
||||
# Support for translating old names to new names:
|
||||
ifeq ($(strip $(DEBOUNCE_TYPE)),sym_g)
|
||||
DEBOUNCE_TYPE:=sym_defer_g
|
||||
else ifeq ($(strip $(DEBOUNCE_TYPE)),eager_pk)
|
||||
DEBOUNCE_TYPE:=sym_eager_pk
|
||||
else ifeq ($(strip $(DEBOUNCE_TYPE)),sym_pk)
|
||||
DEBOUNCE_TYPE:=sym_defer_pk
|
||||
else ifeq ($(strip $(DEBOUNCE_TYPE)),eager_pr)
|
||||
DEBOUNCE_TYPE:=sym_eager_pr
|
||||
endif
|
||||
|
||||
DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
|
||||
# Debounce Modules. Set DEBOUNCE_TYPE=custom if including one manually.
|
||||
DEBOUNCE_TYPE?= sym_defer_g
|
||||
DEBOUNCE_TYPE ?= sym_defer_g
|
||||
ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
|
||||
QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
|
||||
QUANTUM_SRC += $(QUANTUM_DIR)/debounce/$(strip $(DEBOUNCE_TYPE)).c
|
||||
endif
|
||||
|
||||
ifeq ($(strip $(SPLIT_KEYBOARD)), yes)
|
||||
|
|
|
|||
|
|
@ -92,15 +92,6 @@ susceptible to noise, you must choose a debounce method that will also mitigate
|
|||
## Debounce algorithms supported by QMK
|
||||
|
||||
QMK supports multiple debounce algorithms through its debounce API.
|
||||
The logic for which debounce method called is below. It checks various defines that you have set in ```rules.mk```
|
||||
|
||||
```
|
||||
DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
|
||||
DEBOUNCE_TYPE?= sym_defer_g
|
||||
ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
|
||||
QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
|
||||
endif
|
||||
```
|
||||
|
||||
### Debounce selection
|
||||
|
||||
|
|
@ -140,11 +131,3 @@ You have the option to implement you own debouncing algorithm. To do this:
|
|||
* Debouncing occurs after every raw matrix scan.
|
||||
* Use num_rows rather than MATRIX_ROWS, so that split keyboards are supported correctly.
|
||||
* If the algorithm might be applicable to other keyboards, please consider adding it to ```quantum/debounce```
|
||||
|
||||
### Old names
|
||||
The following old names for existing algorithms will continue to be supported, however it is recommended to use the new names instead.
|
||||
|
||||
* sym_g - old name for sym_defer_g
|
||||
* eager_pk - old name for sym_eager_pk
|
||||
* sym_pk - old name for sym_defer_pk
|
||||
* eager_pr - old name for sym_eager_pr
|
||||
|
|
|
|||
|
|
@ -88,15 +88,6 @@ voltage +----------------------
|
|||
## QMK でサポートされるデバウンスアルゴリズム
|
||||
|
||||
QMK はデバウンス API を介して複数のデバウンスアルゴリズムをサポートします。
|
||||
どのデバウンスメソッドが呼ばれるかのロジックは下記のとおりです。```rules.mk``` で設定された様々な定義をチェックします。
|
||||
|
||||
```
|
||||
DEBOUNCE_DIR:= $(QUANTUM_DIR)/debounce
|
||||
DEBOUNCE_TYPE?= sym_defer_g
|
||||
ifneq ($(strip $(DEBOUNCE_TYPE)), custom)
|
||||
QUANTUM_SRC += $(DEBOUNCE_DIR)/$(strip $(DEBOUNCE_TYPE)).c
|
||||
endif
|
||||
```
|
||||
|
||||
### デバウンスの選択
|
||||
|
||||
|
|
@ -135,11 +126,3 @@ DEBOUNCE_TYPE = <アルゴリズムの名前>
|
|||
* デバウンスは、全てのマトリクススキャンの後で発生します。
|
||||
* MATRIX_ROWS ではなく num_rows を使って、分割キーボードが正しくサポートされるようにします。
|
||||
* アルゴリズムが他のキーボードにも適用できる可能性がある場合、```quantum/debounce``` に追加することを検討してください。
|
||||
|
||||
### 古い名前
|
||||
次の既存のアルゴリズムの古い名前は引き続きサポートされますが、代わりに新しい名前を使うことを推奨します。
|
||||
|
||||
* sym_g - sym_defer_g の古い名前
|
||||
* eager_pk - sym_eager_pk の古い名前
|
||||
* sym_pk - sym_defer_pk の古い名前
|
||||
* eager_pr - sym_eager_pr の古い名前
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
# Set any rules.mk overrides for your specific keymap here.
|
||||
# See rules at https://docs.qmk.fm/#/config_options?id=the-rulesmk-file
|
||||
DEBOUNCE_TYPE = eager_pk
|
||||
DEBOUNCE_TYPE = sym_eager_pk
|
||||
LTO_ENABLE = yes
|
||||
COMMAND_ENABLE = no
|
||||
UNICODE_ENABLE = no
|
||||
|
|
|
|||
|
|
@ -25,7 +25,7 @@ SLEEP_LED_ENABLE = no
|
|||
|
||||
RGB_MATRIX_ENABLE = no # enable later
|
||||
RGB_MATRIX_DRIVER = IS31FL3731
|
||||
DEBOUNCE_TYPE = eager_pr
|
||||
DEBOUNCE_TYPE = sym_eager_pr
|
||||
|
||||
# project specific files
|
||||
SRC += matrix.c \
|
||||
|
|
|
|||
|
|
@ -17,6 +17,6 @@ CONSOLE_ENABLE = yes
|
|||
COMMAND_ENABLE = yes
|
||||
BOOTMAGIC_ENABLE = lite # Enable Bootmagic Lite
|
||||
|
||||
DEBOUNCE_TYPE = eager_pr
|
||||
DEBOUNCE_TYPE = sym_eager_pr
|
||||
SRC += matrix.c
|
||||
QUANTUM_LIB_SRC += i2c_master.c
|
||||
|
|
|
|||
|
|
@ -34,6 +34,6 @@ SUBPROJECT_rev1 = yes
|
|||
SLEEP_LED_ENABLE = no # Breathing sleep LED during USB suspend
|
||||
|
||||
SRC += matrix.c
|
||||
DEBOUNCE_TYPE = eager_pk
|
||||
DEBOUNCE_TYPE = sym_eager_pk
|
||||
|
||||
DEFAULT_FOLDER = handwired/xealous/rev1
|
||||
|
|
|
|||
|
|
@ -2,4 +2,4 @@ MOUSEKEY_ENABLE = no
|
|||
COMMAND_ENABLE = no
|
||||
RGBLIGHT_ENABLE = yes
|
||||
LTO_ENABLE = yes
|
||||
DEBOUNCE_TYPE = eager_pk
|
||||
DEBOUNCE_TYPE = sym_eager_pk
|
||||
|
|
|
|||
|
|
@ -2,4 +2,4 @@ MOUSEKEY_ENABLE = no
|
|||
COMMAND_ENABLE = no
|
||||
RGBLIGHT_ENABLE = yes
|
||||
LTO_ENABLE = yes
|
||||
DEBOUNCE_TYPE = eager_pk
|
||||
DEBOUNCE_TYPE = sym_eager_pk
|
||||
|
|
|
|||
|
|
@ -21,4 +21,4 @@ RGBLIGHT_ENABLE = yes # Enable keyboard RGB underglow
|
|||
BLUETOOTH_ENABLE = no # Enable Bluetooth
|
||||
AUDIO_ENABLE = no # Audio output
|
||||
OLED_DRIVER_ENABLE = yes
|
||||
DEBOUNCE_TYPE = eager_pk
|
||||
DEBOUNCE_TYPE = sym_eager_pk
|
||||
|
|
|
|||
|
|
@ -18,4 +18,4 @@ UNICODE_ENABLE = no
|
|||
UNICDOEMAP_ENABLE = no
|
||||
|
||||
|
||||
DEBOUNCE_TYPE = eager_pr
|
||||
DEBOUNCE_TYPE = sym_eager_pr
|
||||
|
|
|
|||
Loading…
Reference in a new issue