Skip to main content

Keys Overview

[Basic Keys]

KeyAliasesDescription
KC.NOIgnore this key (NOOP)
KC.TRANSPARENTKC.TRNSUse the next lowest non-transparent key
KC.Aa and A
KC.Bb and B
KC.Cc and C
KC.Dd and D
KC.Ee and E
KC.Ff and F
KC.Gg and G
KC.Hh and H
KC.Ii and I
KC.Jj and J
KC.Kk and K
KC.Ll and L
KC.Mm and M
KC.Nn and N
KC.Oo and O
KC.Pp and P
KC.Qq and Q
KC.Rr and R
KC.Ss and S
KC.Tt and T
KC.Uu and U
KC.Vv and V
KC.Ww and W
KC.Xx and X
KC.Yy and Y
KC.Zz and Z
KC.N11 and !
KC.N22 and @
KC.N33 and #
KC.N44 and $
KC.N55 and %
KC.N66 and ^
KC.N77 and &
KC.N88 and *
KC.N99 and (
KC.N00 and )
KC.ENTERKC.ENTReturn (Enter)
KC.ESCAPEKC.ESCEscape
KC.BSPACEKC.BSPCDelete (Backspace)
KC.TABTab
KC.SPACEKC.SPCSpacebar
KC.MINUSKC.MINS- and _
KC.EQUALKC.EQL= and +
KC.LBRACKETKC.LBRC[ and {
KC.RBRACKETKC.RBRC] and }
KC.BSLASHKC.BSLS\ and |
KC.SCOLONKC.SCLN; and :
KC.QUOTEKC.QUOT' and "
KC.GRAVEKC.GRV, KC.ZKHK` and ~, JIS Zenkaku/Hankaku
KC.COMMAKC.COMM, and <
KC.DOT. and >
KC.SLASHKC.SLSH/ and ?
KC.CAPSLOCKKC.CLCK, KC.CAPSCaps Lock
KC.F1F1
KC.F2F2
KC.F3F3
KC.F4F4
KC.F5F5
KC.F6F6
KC.F7F7
KC.F8F8
KC.F9F9
KC.F10F10
KC.F11F11
KC.F12F12
KC.PSCREENKC.PSCRPrint Screen
KC.SCROLLLOCKKC.SLCKScroll Lock
KC.PAUSEKC.PAUS, KC.BRKPause
KC.INSERTKC.INSInsert
KC.HOMEHome
KC.PGUPPage Up
KC.DELETEKC.DELForward Delete
KC.ENDEnd
KC.PGDOWNKC.PGDNPage Down
KC.RIGHTKC.RGHTRight Arrow
KC.LEFTLeft Arrow
KC.DOWNDown Arrow
KC.UPUp Arrow
KC.NUMLOCKKC.NLCKKeypad Num Lock and Clear
KC.KP_SLASHKC.PSLSKeypad /
KC.KP_ASTERISKKC.PASTKeypad *
KC.KP_MINUSKC.PMNSKeypad -
KC.KP_PLUSKC.PPLSKeypad +
KC.KP_ENTERKC.PENTKeypad Enter
KC.KP_1KC.P1Keypad 1 and End
KC.KP_2KC.P2Keypad 2 and Down Arrow
KC.KP_3KC.P3Keypad 3 and Page Down
KC.KP_4KC.P4Keypad 4 and Left Arrow
KC.KP_5KC.P5Keypad 5
KC.KP_6KC.P6Keypad 6 and Right Arrow
KC.KP_7KC.P7Keypad 7 and Home
KC.KP_8KC.P8Keypad 8 and Up Arrow
KC.KP_9KC.P9Keypad 9 and Page Up
KC.KP_0KC.P0Keypad 0 and Insert
KC.KP_DOTKC.PDOTKeypad . and Delete
KC.KP_EQUALKC.PEQLKeypad =
KC.F13F13
KC.F14F14
KC.F15F15
KC.F16F16
KC.F17F17
KC.F18F18
KC.F19F19
KC.F20F20
KC.F21F21
KC.F22F22
KC.F23F23
KC.F24F24
KC.LOCKING_CAPSKC.LCAPLocking Caps Lock
KC.LOCKING_NUMKC.LNUMLocking Num Lock
KC.LOCKING_SCROLLKC.LSCRLocking Scroll Lock
KC.KP_COMMAKC.PCMMKeypad ,
KC.KP_EQUAL_AS400Keypad = on AS/400 keyboards
KC.LCTRLKC.LCTLLeft Control
KC.LSHIFTKC.LSFTLeft Shift
KC.LALTLeft Alt
KC.LGUIKC.LCMD, KC.LWINLeft GUI (Windows/Command/Meta key)
KC.RCTRLKC.RCTLRight Control
KC.RSHIFTKC.RSFTRight Shift
KC.RALTRight Alt
KC.RGUIKC.RCMD, KC.RWINRight GUI (Windows/Command/Meta key)
KC.AUDIO_MUTEKC.MUTEMute
KC.AUDIO_VOL_UPKC.VOLUVolume Up
KC.AUDIO_VOL_DOWNKC.VOLDVolume Down
KC.MEDIA_NEXT_TRACKKC.MNXTNext Track (Windows)
KC.MEDIA_PREV_TRACKKC.MPRVPrevious Track (Windows)
KC.MEDIA_STOPKC.MSTPStop Track (Windows)
KC.MEDIA_PLAY_PAUSEKC.MPLYPlay/Pause Track
KC.MEDIA_EJECTKC.EJCTEject (macOS)
KC.MEDIA_FAST_FORWARDKC.MFFDNext Track (macOS)
KC.MEDIA_REWINDKC.MRWDPrevious Track (macOS)

[US ANSI Shifted Symbols]

KeyAliasesDescription
KC.TILDEKC.TILD~
KC.EXCLAIMKC.EXLM!
KC.AT@
KC.HASH#
KC.DOLLARKC.DLR$
KC.PERCENTKC.PERC%
KC.CIRCUMFLEXKC.CIRC^
KC.AMPERSANDKC.AMPR&
KC.ASTERISKKC.ASTR*
KC.LEFT_PARENKC.LPRN(
KC.RIGHT_PARENKC.RPRN)
KC.UNDERSCOREKC.UNDS_
KC.PLUS+
KC.LEFT_CURLY_BRACEKC.LCBR{
KC.RIGHT_CURLY_BRACEKC.RCBR}
KC.PIPE|
KC.COLONKC.COLN:
KC.DOUBLE_QUOTEKC.DQUO, KC.DQT"
KC.LEFT_ANGLE_BRACKETKC.LABK, KC.LT<
KC.RIGHT_ANGLE_BRACKETKC.RABK, KC.GT>
KC.QUESTIONKC.QUES?

[International Keys]

KeyAliasesDescription
KC.NONUS_HASHKC.NUHSISO Left of Return
KC.NONUS_BSLASHKC.NUBSISO Right of LSHIFT
KC.APPLICATIONKC.APP,KC.SEL,KC.WINMENUMenu Key (Near RCTRL)
KC.INT1KC.RO
KC.INT2KC.KANA
KC.INT3KC.JYEN
KC.INT4KC.HENK
KC.INT5KC.MHEN
KC.INT6
KC.INT7
KC.INT8
KC.INT9
KC.LANG1HAEN
KC.LANG2HAEJ
KC.LANG3
KC.LANG4
KC.LANG5
KC.LANG6
KC.LANG7
KC.LANG8
KC.LANG9

[Internal Keys]

KeyDescription
KC.RESETRestarts the keyboard
KC.DEBUGToggle debug_enabled, which enables log spew to serial console
KC.GESCEscape when tapped, ` when pressed with Shift or GUI
KC.BKDLBackspace when tapped, Delete when pressed with GUI
KC.UC_MODE_NOOPSets UnicodeMode to NOOP
KC.UC_MODE_LINUXSets UnicodeMode to Linux
KC.UC_MODE_MACOSSets UnicodeMode to macOS
KC.UC_MODE_WINCSets UnicodeMode to WinCompose
KC.MACRO_SLEEP_MS(ms)Sleeps in a macro. Check MACROS for more information.

[Modifiers]

KeyDescription
KC.HYPRHold Left Control, Shift, Alt and GUI
KC.MEHHold Left Control, Shift and Alt
KC.LCTL(kc)Hold Left Control and press kc
KC.LSFT(kc)Hold Left Shift and press kc
KC.LALT(kc)Hold Left Alt and press kc
KC.LGUI(kc)Hold Left GUI and press kc
KC.RCTL(kc)Hold Right Control and press kc
KC.RSFT(kc)Hold Right Shift and press kc
KC.RALT(kc)Hold Right Alt and press kc
KC.RGUI(kc)Hold Right GUI and press kc

[Bluetooth Keys]

KeyAliasesDescription
KC.BT_CLEAR_BONDSKC.BT_CLRClears all stored bondings
KC.BT_NEXT_CONNKC.BT_NXTSelects the next BT connection
KC.BT_PREV_CONNKC.BT_PRVSelects the previous BT connection