keycodes

Documentation

Index

• Constants
• Variables

Constants

const (
	ModKeyMask      = 0xFF00
	QuantumMask     = 0xF000
	QuantumTypeMask = 0x0F00
	ToKeyMask       = 0x0010
)

const (
	TypeMediaKey = 0xE400
	TypeNormal   = 0xF000
	TypeMouse    = 0xD000
	TypeModKey   = 0xFF00
	TypeToKey    = 0xFF10
	TypeMacroKey = 0x7700
	TypeLxxx     = 0x0000
	TypeRxxx     = 0x1000
	TypeLxxxT    = 0x2000
	TypeRxxxT    = 0x3000
)

const (
	TypeXCtl = 0x0100
	TypeXSft = 0x0200
	TypeXAlt = 0x0400
	TypeXGui = 0x0800

	TypeLCtlT = TypeLxxxT | TypeXCtl
	TypeLSftT = TypeLxxxT | TypeXSft
	TypeLAltT = TypeLxxxT | TypeXAlt
	TypeLGuiT = TypeLxxxT | TypeXGui
	TypeRCtlT = TypeRxxxT | TypeXCtl
	TypeRSftT = TypeRxxxT | TypeXSft
	TypeRAltT = TypeRxxxT | TypeXAlt
	TypeRGuiT = TypeRxxxT | TypeXGui
)

const (
	KeyLeftCtrl   = TypeNormal | 0xE0
	KeyLeftShift  = TypeNormal | 0xE1
	KeyLeftAlt    = TypeNormal | 0xE2
	KeyWindows    = TypeNormal | 0xE3
	KeyRightCtrl  = TypeNormal | 0xE4
	KeyRightShift = TypeNormal | 0xE5
	KeyRightAlt   = TypeNormal | 0xE6

	KeyH         = TypeNormal | 0x0B
	KeyBackspace = TypeNormal | 0x2A
)

const (
	KeyMod0 = TypeModKey | 0x00
	KeyMod1 = TypeModKey | 0x01
	KeyMod2 = TypeModKey | 0x02
	KeyMod3 = TypeModKey | 0x03
	KeyMod4 = TypeModKey | 0x04
	KeyMod5 = TypeModKey | 0x05

	KeyTo0 = TypeToKey | 0x00
	KeyTo1 = TypeToKey | 0x01
	KeyTo2 = TypeToKey | 0x02
	KeyTo3 = TypeToKey | 0x03
	KeyTo4 = TypeToKey | 0x04
	KeyTo5 = TypeToKey | 0x05
)

const (
	KeyMacro0  = TypeMacroKey | 0x00
	KeyMacro1  = TypeMacroKey | 0x01
	KeyMacro2  = TypeMacroKey | 0x02
	KeyMacro3  = TypeMacroKey | 0x03
	KeyMacro4  = TypeMacroKey | 0x04
	KeyMacro5  = TypeMacroKey | 0x05
	KeyMacro6  = TypeMacroKey | 0x06
	KeyMacro7  = TypeMacroKey | 0x07
	KeyMacro8  = TypeMacroKey | 0x08
	KeyMacro9  = TypeMacroKey | 0x09
	KeyMacro10 = TypeMacroKey | 0x0a
	KeyMacro11 = TypeMacroKey | 0x0b
	KeyMacro12 = TypeMacroKey | 0x0c
	KeyMacro13 = TypeMacroKey | 0x0d
	KeyMacro14 = TypeMacroKey | 0x0e
	KeyMacro15 = TypeMacroKey | 0x0f
)

const (
	ShiftMask = 0x0400
	AltGrMask = 0x0800
)

from machine/usb/hid/keyboard

const (
	KeyMediaBrightnessUp   = TypeMediaKey | 0x6F
	KeyMediaBrightnessDown = TypeMediaKey | 0x70
	KeyMediaPlay           = TypeMediaKey | 0xB0
	KeyMediaPause          = TypeMediaKey | 0xB1
	KeyMediaRecord         = TypeMediaKey | 0xB2
	KeyMediaFastForward    = TypeMediaKey | 0xB3
	KeyMediaRewind         = TypeMediaKey | 0xB4
	KeyMediaNextTrack      = TypeMediaKey | 0xB5
	KeyMediaPrevTrack      = TypeMediaKey | 0xB6
	KeyMediaStop           = TypeMediaKey | 0xB7
	KeyMediaEject          = TypeMediaKey | 0xB8
	KeyMediaRandomPlay     = TypeMediaKey | 0xB9
	KeyMediaPlayPause      = TypeMediaKey | 0xCD
	KeyMediaPlaySkip       = TypeMediaKey | 0xCE
	KeyMediaMute           = TypeMediaKey | 0xE2
	KeyMediaVolumeInc      = TypeMediaKey | 0xE9
	KeyMediaVolumeDec      = TypeMediaKey | 0xEA
)

const (
	MouseLeft    = TypeMouse | 0x01 // mouse.Left
	MouseRight   = TypeMouse | 0x02 // mouse.Right
	MouseMiddle  = TypeMouse | 0x04 // mouse.Middle
	MouseBack    = TypeMouse | 0x08 // mouse.Back
	MouseForward = TypeMouse | 0x10 // mouse.Forward
	WheelDown    = TypeMouse | 0x20
	WheelUp      = TypeMouse | 0x40
)

const (
	// restore default keymap for QMK
	KeyRestoreDefaultKeymap = 0x7C03
)

Variables

var (
	CharToKeyCodeMap *[256]keyboard.Keycode
)