[Core] Add compile/make macro to core (#15959)
* [Core] Add KC_MAKE keycode to core fix linting fix testing error work around test idiocyncracies fix more lint something something stupid tests add doc * updates based on feedback * Add bad names * Fixup docs * semantics but cleaner Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> * Hide oneshot checks behind preprocessors * Move no-compile option around * Fix formatting * make shift optional * Make opt in * fix formatting * update send string function name Co-authored-by: Joel Challis <git@zvecr.com> Co-authored-by: precondition <57645186+precondition@users.noreply.github.com> Co-authored-by: Joel Challis <git@zvecr.com>
This commit is contained in:
parent
2749346a53
commit
02655690f4
5 changed files with 36 additions and 10 deletions
|
@ -131,6 +131,8 @@ If you define these options you will disable the associated feature, which can s
|
||||||
|
|
||||||
If you define these options you will enable the associated feature, which may increase your code size.
|
If you define these options you will enable the associated feature, which may increase your code size.
|
||||||
|
|
||||||
|
* `#define ENABLE_COMPILE_KEYCODE`
|
||||||
|
* Enables the `QK_MAKE` keycode
|
||||||
* `#define FORCE_NKRO`
|
* `#define FORCE_NKRO`
|
||||||
* NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
|
* NKRO by default requires to be turned on, this forces it on during keyboard startup regardless of EEPROM setting. NKRO can still be turned off but will be turned on again if the keyboard reboots.
|
||||||
* `#define STRICT_LAYER_RELEASE`
|
* `#define STRICT_LAYER_RELEASE`
|
||||||
|
|
|
@ -220,10 +220,11 @@ See also: [Basic Keycodes](keycodes_basic.md)
|
||||||
See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
|
See also: [Quantum Keycodes](quantum_keycodes.md#qmk-keycodes)
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|-----------------|---------|-------------------------------------------------------|
|
|-----------------|---------|---------------------------------------------------------------------------------|
|
||||||
|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing |
|
|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing |
|
||||||
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode |
|
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode |
|
||||||
|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)|
|
|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory) |
|
||||||
|
|`QK_MAKE` | |Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held |
|
||||||
|
|
||||||
## Audio Keys :id=audio-keys
|
## Audio Keys :id=audio-keys
|
||||||
|
|
||||||
|
|
|
@ -9,7 +9,8 @@ On this page we have documented keycodes between `0x00FF` and `0xFFFF` which are
|
||||||
## QMK Keycodes :id=qmk-keycodes
|
## QMK Keycodes :id=qmk-keycodes
|
||||||
|
|
||||||
|Key |Aliases |Description |
|
|Key |Aliases |Description |
|
||||||
|-----------------|---------|-------------------------------------------------------|
|
|-----------------|---------|---------------------------------------------------------------------------------|
|
||||||
|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing |
|
|`QK_BOOTLOADER` |`QK_BOOT`|Put the keyboard into bootloader mode for flashing |
|
||||||
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode |
|
|`QK_DEBUG_TOGGLE`|`DB_TOGG`|Toggle debug mode |
|
||||||
|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory)|
|
|`QK_CLEAR_EEPROM`|`EE_CLR` |Reinitializes the keyboard's EEPROM (persistent memory) |
|
||||||
|
|`QK_MAKE` | |Sends `qmk compile -kb (keyboard) -km (keymap)`, or `qmk flash` if shift is held |
|
||||||
|
|
|
@ -357,6 +357,26 @@ bool process_record_quantum(keyrecord_t *record) {
|
||||||
case ONESHOT_DISABLE:
|
case ONESHOT_DISABLE:
|
||||||
oneshot_disable();
|
oneshot_disable();
|
||||||
break;
|
break;
|
||||||
|
#endif
|
||||||
|
#ifdef ENABLE_COMPILE_KEYCODE
|
||||||
|
case QK_MAKE: // Compiles the firmware, and adds the flash command based on keyboard bootloader
|
||||||
|
{
|
||||||
|
# ifdef NO_ACTION_ONESHOT
|
||||||
|
const uint8_t temp_mod = mod_config(get_mods());
|
||||||
|
# else
|
||||||
|
const uint8_t temp_mod = mod_config(get_mods() | get_oneshot_mods());
|
||||||
|
clear_oneshot_mods();
|
||||||
|
# endif
|
||||||
|
clear_mods();
|
||||||
|
|
||||||
|
SEND_STRING_DELAY("qmk", TAP_CODE_DELAY);
|
||||||
|
if (temp_mod & MOD_MASK_SHIFT) { // if shift is held, flash rather than compile
|
||||||
|
SEND_STRING_DELAY(" flash ", TAP_CODE_DELAY);
|
||||||
|
} else {
|
||||||
|
SEND_STRING_DELAY(" compile ", TAP_CODE_DELAY);
|
||||||
|
}
|
||||||
|
SEND_STRING_DELAY("-kb " QMK_KEYBOARD " -km " QMK_KEYMAP SS_TAP(X_ENTER), TAP_CODE_DELAY);
|
||||||
|
}
|
||||||
#endif
|
#endif
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
@ -595,6 +595,8 @@ enum quantum_keycodes {
|
||||||
|
|
||||||
MAGIC_TOGGLE_CONTROL_CAPSLOCK,
|
MAGIC_TOGGLE_CONTROL_CAPSLOCK,
|
||||||
|
|
||||||
|
QK_MAKE,
|
||||||
|
|
||||||
// Start of custom keycode range for keyboards and keymaps - always leave at the end
|
// Start of custom keycode range for keyboards and keymaps - always leave at the end
|
||||||
SAFE_RANGE
|
SAFE_RANGE
|
||||||
};
|
};
|
||||||
|
|
Loading…
Reference in a new issue