Skip to main content

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.