FAQ Keymap Editor - mcaple/tmk_keyboard GitHub Wiki

TMK Keymap Editor

TMK products officially supported are listed here.

http://www.tmk-kbd.com/tmk_keyboard/editor/

Tutorial Video

You can grasp how this works by watching stoic-lemon's video.

Edit keymap

https://youtu.be/TYmAb8zOPWU?t=10m59s

Flash with FLIP

https://youtu.be/TYmAb8zOPWU?t=14m2s

Keys not exist on your keyboard?

You can just ignore them and any action should be fine for the key, but NO is preferable to indicate the key is not exist.

Locking switch support

Mechanical locking switch support for CapsLock, NumLock and ScrollLock key is built in by default. You can find acitons for those keys like Locking Caps Lock in 'Function and Keypad' tab on Keymap Editor.

How to edit firmware not officially suppored

  1. Download unimap firmware or build with enabling unimap option yourself
  2. Open Editor with this URL: http://www.tmk-kbd.com/tmk_keyboard/editor/unimap/?usb_usb
  3. Select the firmware file on file chooser in 'Base Firmware File:' section
  4. Click 'Load keymap from firmware' button, you will see keymap of the firmware on Editor
  5. Edit your keymap
  6. Then, click 'Download' button to download firmware with new keymap

How to define custom action on Keymap Editor

Assuming you want to define 'LCtrl+Left' key...

You have to define custom action in 'Code Edit' tab while simple action codes that are pre-defined and available in 'Main', 'Function and Keypad', 'System, Media, Mouse key' and 'Layer Switching and etc.' tab by default.

To know how to define your custom action you can check this document, this is not well decribed and not complete at this time unfortunately.

https://github.com/tmk/tmk_keyboard/wiki/Keymap

As for Ctrl+Left you can use 'Modified key' action givinig proper arguments like ACTION_MODS_KEY(MOD_LCTL, KC_LEFT). You can define this action in 'Code Edit' somehow.

https://github.com/tmk/tmk_keyboard/wiki/Keymap#212-modified-key

Also check key at right bottom corner of this example keymap, the key is defined as 'LCtrl+Left'.

http://bit.ly/35ITkx7