• Keymap framework - how to define your keymap
  • 0. Keymap and layers
  • 0.1 Layer state
  • 0.1.1 layer_state
  • 0.1.2 default_layer_state
  • 0.1.3 Current Layer State
  • 0.2 Layer Precedence and Transparency
  • 0.3 Keymap Example
  • 1. Keycode
  • 1.0 Other key
  • 1.1 Normal key
  • 1.2 Modifier
  • 1.3 Mousekey
  • 1.4 System & Media key
  • 1.5 Fn key
  • 1.6 Keycode Table
  • 2. Action
  • 2.1 Key Action
  • Parameters
  • 2.1.1 Normal key and Modifier
  • 2.1.2 Modified key
  • 2.1.3 Multiple Modifiers
  • 2.1.3 Modifier with Tap key(Dual role)
  • 2.2 Layer Action
  • Parameters
  • 2.2.1 Default Layer
  • 2.2.2 Momentary
  • 2.2.3 Toggle Switch
  • 2.2.4 Momentary Switch with tap key
  • 2.2.5 Momentary Switch with tap toggle
  • 2.2.6 Invert state of layer
  • 2.2.7 Turn On layer
  • 2.2.8 Turn Off layer
  • 2.2.9 Set layer
  • 2.2.10 Bitwise operation
  • 2.3 Macro action
  • 2.3.1 Implementing Macro getter function
  • 2.3.1.1 Limitations
  • 2.3.2 Implementing/Defining Macro sequences
  • 2.3.2 Examples
  • 2.4 Function action
  • 2.4.1 Function
  • 2.4.2 Function with tap
  • 2.4.3 Implement user function
  • 2.5 Backlight Action
  • 2.5.1 Change backlight level
  • 2.5.2 Turn on / off backlight
  • 3. Layer switching Example
  • 3.1 Momentary switching
  • 3.2 Toggle switching
  • 3.3 Momentary switching with Tap key
  • 3.4 Momentary switching with Tap Toggle
  • 3.5 Momentary switching with Modifiers
  • 4. Tapping
  • 4.1 Tap Key
  • 4.2 Tap Toggle
  • 4.3 Oneshot Modifier
  • 4.4 Tap Toggle Mods
  • 5. Legacy Keymap
  • 6. Terminology
  • keymap
  • layer
  • key
  • keycode
  • action
  • layer transparency
  • layer precedence
  • tapping
  • Fn key
  • dual role key