Hardware-specific Keycodes

Hardware-specific keycodes are keycodes that trigger specific hardware functionality.

GroupUsage NameKeycode IdentifiersStatus
Hardware StatusPrint Battery InformationPRINT_BATTERYโœ…
Hardware StatusPrint Keyboard InformationPRINT_INFOโœ…
Hardware StatusPrint BLE InformationPRINT_BLEโœ…
nRF52Put Keyboard to Sleep NowSLEEP_NOWโœ…
nRF52Restart Firmware (RESET)RESETโœ…
nRF52Toggle Debug Serial CLIDEBUGโœ…
nRF52Reformat User FlashEEPROM_RESET EEP_RSTโœ…
nRF52Enter OTA DFUDFUโœ…
nRF52Enter Serial DFUSERIAL_DFUโœ…
nRF52Enter UF2 DFU (nrf52840 only)UF2_DFUโœ…
nRF52Toggle Help ModeHELP_MODEโœ…
nRF52Use default Battery Level CalculationBATTERY_CALC_DEFAULTโœ…
nRF52Use test Battery Level Calculation (4.2V = 42%)BATTERY_CALC_TESTโœ…
nRF52 BLE HIDSwitch to BLE Profile 1BLEPROFILE_1โœ…
nRF52 BLE HIDSwitch to BLE Profile 2BLEPROFILE_2โœ…
nRF52 BLE HIDSwitch to BLE Profile 3BLEPROFILE_3โœ…
nRF52840 USB HIDAutomatic Switch between USB and BLEOUT_AUTOโœ…
nRF52840 USB HIDOutput to USB OnlyOUT_USBโœ…
nRF52840 USB HIDOutput to BLE OnlyOUT_BTโœ…
Custom HardwareExternal VCC ON๐Ÿšง
Custom HardwareExternal VCC OFF๐Ÿšง
Custom HardwareBattery Charger ON๐Ÿšง
Custom HardwareBattery Charger OFF๐Ÿšง
LED PWM BacklightToggle Backlight ON/OFFBL_TOGGโœ…
LED PWM BacklightStep through Backlight ModesBL_STEPโœ…
LED PWM BacklightTurn Backlight ONBL_ONโœ…
LED PWM BacklightTurn Backlight OFFBL_OFFโœ…
LED PWM BacklightIncrease Maximum IntensityBL_INCโœ…
LED PWM BacklightDecrease Maximum IntensityBL_DECโœ…
LED PWM BacklightSet to Breathing ModeBL_BRTGโœ…
LED PWM BacklightSet to React Mode (default)BL_REACTโœ…
LED PWM BacklightIncrease PWM Step SizeBL_STEPINCโœ…
LED PWM BacklightDecrease PWM Step SizeBL_STEPDECโœ…
RGB LEDsRGB_TOG๐Ÿšง
RGB LEDsRGB_MODE_FORWARD๐Ÿšง
RGB LEDsRGB_MODE_REVERSE๐Ÿšง
RGB LEDsRGB_HUI๐Ÿšง
RGB LEDsRGB_HUD๐Ÿšง
RGB LEDsRGB_SAI๐Ÿšง
RGB LEDsRGB_SAD๐Ÿšง
RGB LEDsRGB_VAI๐Ÿšง
RGB LEDsRGB_VAD๐Ÿšง
RGB LEDsRGB_MODE_PLAIN๐Ÿšง
RGB LEDsRGB_MODE_BREATHE๐Ÿšง
RGB LEDsRGB_MODE_RAINBOW๐Ÿšง
RGB LEDsRGB_MODE_SWIRL๐Ÿšง
RGB LEDsRGB_MODE_SNAKE๐Ÿšง
RGB LEDsRGB_MODE_KNIGHT๐Ÿšง
RGB LEDsRGB_MODE_PLAIN๐Ÿšง
RGB LEDsRGB_MODE_XMAS๐Ÿšง
RGB LEDsRGB_MODE_GRADIENT๐Ÿšง
RGB LEDsRGB_MODE_RGBTEST๐Ÿšง
RGB LEDsRGB_SPI๐Ÿšง
RGB LEDsRGB_SPD๐Ÿšง

Table is still a work in progress. Refer to hid_keycodes.h and advanced_keycodes.h for a detailed list of keycodes.