qmk_firmware/faq_keymap.html

26 lines
110 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Keymap FAQ | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.R_mF0amW.css" as="style">
<script type="module" src="/assets/app.B02gM4TG.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/framework.DyMmIvSC.js">
<link rel="modulepreload" href="/assets/chunks/theme.Y8mokbzj.js">
<link rel="modulepreload" href="/assets/faq_keymap.md.BNm1UZCq.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/badge-community-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/badge-community-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><!----><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="./" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719 4.3125 31.3125 3.843
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ALT_TAB</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LALT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(KC_TAB)</span></span></code></pre></div><p>This will allow you to use <code>FN_CAPS</code> and <code>ALT_TAB</code> in your keymap, keeping it more readable.</p><h2 id="my-keymap-doesn-t-update-when-i-flash-it" tabindex="-1">My Keymap Doesn&#39;t Update When I Flash It <a class="header-anchor" href="#my-keymap-doesn-t-update-when-i-flash-it" aria-label="Permalink to &quot;My Keymap Doesn&#39;t Update When I Flash It&quot;"></a></h2><p>This is usually due to VIA, and has to do with how it deals with keymaps.</p><p>On first run, the VIA code in the firmware will copy the keymap from flash memory into EEPROM so that it can be rewritten at runtime by the VIA app. From this point QMK will use the keymap stored in EEPROM instead of flash, and so updates to your <code>keymap.c</code> will not be reflected.</p><p>The simple fix for this is to clear the EEPROM. You can do this in several ways:</p><ul><li>Hold the Bootmagic Lite key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board.</li><li>Press the <code>QK_CLEAR_EEPROM</code>/<code>EE_CLR</code> keycode if it is accessible on your keymap.</li><li>Place the board into bootloader mode and hit the &quot;Clear EEPROM&quot; button. This may not be available for all bootloaders, and you may need to reflash the board afterwards.</li></ul><h2 id="some-of-my-keys-are-swapped-or-not-working" tabindex="-1">Some Of My Keys Are Swapped Or Not Working <a class="header-anchor" href="#some-of-my-keys-are-swapped-or-not-working" aria-label="Permalink to &quot;Some Of My Keys Are Swapped Or Not Working&quot;"></a></h2><p>QMK has a couple of features which allow you to change the behavior of your keyboard on the fly. This includes, but is not limited to, swapping Ctrl/Caps, disabling GUI, swapping Alt/GUI, swapping Backspace/Backslash, disabling all keys, and other behavioral modifications.</p><p>Refer to the EEPROM clearing methods above, which should return those keys to normal operation. If that doesn&#39;t work, look here:</p><ul><li><a href="./keycodes_magic">Magic Keycodes</a></li><li><a href="./feature_command">Command</a></li></ul><h2 id="the-menu-key-isn-t-working" tabindex="-1">The Menu Key Isn&#39;t Working <a class="header-anchor" href="#the-menu-key-isn-t-working" aria-label="Permalink to &quot;The Menu Key Isn&#39;t Working&quot;"></a></h2><p>The key found on most modern keyboards that is located between <code>KC_RGUI</code> and <code>KC_RCTL</code> is actually called <code>KC_APP</code>. This is because when the key was invented, there was already a key named &quot;Menu&quot; in the HID specification, so for whatever reason, Microsoft chose to create a new key and call it &quot;Application&quot;.</p><h2 id="power-keys-aren-t-working" tabindex="-1">Power Keys Aren&#39;t Working <a class="header-anchor" href="#power-keys-aren-t-working" aria-label="Permalink to &quot;Power Keys Aren&#39;t Working&quot;"></a></h2><p>Somewhat confusingly, there are two &quot;Power&quot; keycodes in QMK: <code>KC_KB_POWER</code> in the Keyboard/Keypad HID usage page, and <code>KC_SYSTEM_POWER</code> (or <code>KC_PWR</code>) in the Consumer page.</p><p>The former is only recognized on macOS, while the latter, <code>KC_SLEP</code> and <code>KC_WAKE</code> are supported by all three major operating systems, so it is recommended to use those instead. Under Windows, these keys take effect immediately, however on macOS they must be held down until a dialog appears.</p><h2 id="one-shot-modifier" tabindex="-1">One Shot Modifier <a class="header-anchor" href="#one-shot-modifier" aria-label="Permalink to &quot;One Shot Modifier&quot;"></a></h2><p>Solves my personal &#39;the&#39; problem. I often got &#39;the&#39; or &#3
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LOCKING_RESYNC_ENABLE</span></span></code></pre></div><p>After enabling this feature use keycodes <code>KC_LCAP</code>, <code>KC_LNUM</code> and <code>KC_LSCR</code> in your keymap instead.</p><p>Old vintage mechanical keyboards occasionally have lock switches but modern ones don&#39;t have. <em><strong>You don&#39;t need this feature in most case and just use keycodes <code>KC_CAPS</code>, <code>KC_NUM</code> and <code>KC_SCRL</code>.</strong></em></p><h2 id="input-special-characters-other-than-ascii-like-cedille-c" tabindex="-1">Input Special Characters Other Than ASCII like Cédille &#39;Ç&#39; <a class="header-anchor" href="#input-special-characters-other-than-ascii-like-cedille-c" aria-label="Permalink to &quot;Input Special Characters Other Than ASCII like Cédille &#39;Ç&#39;&quot;"></a></h2><p>See the <a href="./feature_unicode">Unicode</a> feature.</p><h2 id="fn-key-on-macos" tabindex="-1"><code>Fn</code> Key on macOS <a class="header-anchor" href="#fn-key-on-macos" aria-label="Permalink to &quot;`Fn` Key on macOS&quot;"></a></h2><p>Unlike most Fn keys, the one on Apple keyboards actually has its own keycode... sort of. It takes the place of the sixth keycode in a basic 6KRO HID report -- so an Apple keyboard is in fact only 5KRO.</p><p>It is technically possible to get QMK to send this key. However, doing so requires modification of the report format to add the state of the Fn key. Even worse, it is not recognized unless the keyboard&#39;s VID and PID match that of a real Apple keyboard. The legal issues that official QMK support for this feature may create mean it is unlikely to happen.</p><p>See <a href="https://github.com/qmk/qmk_firmware/issues/2179" target="_blank" rel="noreferrer">this issue</a> for detailed information.</p><h2 id="keys-supported-in-mac-osx" tabindex="-1">Keys Supported in Mac OSX? <a class="header-anchor" href="#keys-supported-in-mac-osx" aria-label="Permalink to &quot;Keys Supported in Mac OSX?&quot;"></a></h2><p>You can know which keycodes are supported in OSX from this source code.</p><p><code>usb_2_adb_keymap</code> array maps Keyboard/Keypad Page usages to ADB scancodes(OSX internal keycodes).</p><p><a href="https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c" target="_blank" rel="noreferrer">https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/Cosmo_USB2ADB.c</a></p><p>And <code>IOHIDConsumer::dispatchConsumerEvent</code> handles Consumer page usages.</p><p><a href="https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp" target="_blank" rel="noreferrer">https://opensource.apple.com/source/IOHIDFamily/IOHIDFamily-606.1.7/IOHIDFamily/IOHIDConsumer.cpp</a></p><h2 id="jis-keys-in-mac-osx" tabindex="-1">JIS Keys in Mac OSX <a class="header-anchor" href="#jis-keys-in-mac-osx" aria-label="Permalink to &quot;JIS Keys in Mac OSX&quot;"></a></h2><p>Japanese JIS keyboard specific keys like <code>無変換(Muhenkan)</code>, <code>変換(Henkan)</code>, <code>ひらがな(hiragana)</code> are not recognized on OSX. You can use <strong>Seil</strong> to enable those keys, try following options.</p><ul><li>Enable NFER Key on PC keyboard</li><li>Enable XFER Key on PC keyboard</li><li>Enable KATAKANA Key on PC keyboard</li></ul><p><a href="https://pqrs.org/osx/karabiner/seil.html" target="_blank" rel="noreferrer">https://pqrs.org/osx/karabiner/seil.html</a></p><h2 id="rn-42-bluetooth-doesn-t-work-with-karabiner" tabindex="-1">RN-42 Bluetooth Doesn&#39;t Work with Karabiner <a class="header-anchor" href="#rn-42-bluetooth-doesn-t-work-with-karabiner" aria-label="Permalink to &quot;RN-42 Bluetooth Doesn&#39;t Work with Karabiner&quot;"></a></h2><p>Karabiner - Keymapping tool on Mac OSX - ignores inputs from RN-42 module by default. You have to enable this option to make Karabiner working with your keyboard. <a href="https://g
<script>window.__VP_HASH_MAP__=JSON.parse("{\"feature_programmable_button.md\":\"BP5-HUlT\",\"feature_wpm.md\":\"C-SARAXc\",\"feature_eeprom.md\":\"vdeTTfI0\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"api_development_overview.md\":\"Dcey4ntL\",\"feature_ps2_mouse.md\":\"DgKRvSpd\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"audio_driver.md\":\"YKqJ1wkZ\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"cli.md\":\"BLzAdA6l\",\"cli_configuration.md\":\"CGSB128P\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"api_overview.md\":\"0FPaUsMb\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"cli_development.md\":\"CczMJOE3\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"cli_commands.md\":\"DCpejdln\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"configurator_architecture.md\":\"DEFTvTlS\",\"changelog_20200829.md\":\"CoqrOffn\",\"data_driven_config.md\":\"BvLQ7P20\",\"changelog_20230226.md\":\"CEQKb2Sw\",\"documentation_best_practices.md\":\"D_UwEt1C\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"BIO-iq8r\",\"easy_maker.md\":\"BLadB4D_\",\"eeprom_driver.md\":\"CJGhJYmK\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"feature_advanced_keycodes.md\":\"jN1BLaPG\",\"feature_audio.md\":\"CSdy-B0q\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20220528.md\":\"BdSPPJS6\",\"changelog_20211127.md\":\"BDzkUAQX\",\"changelog_20230528.md\":\"BMuuw__T\",\"changelog_20220827.md\":\"I6ja7C5w\",\"changelog_20200229.md\":\"DNsowwM1\",\"faq_build.md\":\"Bryo1ywz\",\"faq_general.md\":\"BC3pFw4U\",\"feature_encoders.md\":\"DzEjkR0q\",\"feature_caps_word.md\":\"DFEidvi5\",\"feature_mouse_keys.md\":\"Iyt3Hb3p\",\"feature_command.md\":\"DyD1wEzr\",\"feature_combo.md\":\"BFcSajDz\",\"feature_converters.md\":\"Bmv29bqN\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_oled_driver.md\":\"C3msZUgf\",\"feature_digitizer.md\":\"D7mG1fUR\",\"feature_dip_switch.md\":\"BRm_919T\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"feature_secure.md\":\"DTio1NtX\",\"feature_macros.md\":\"DpKdCniT\",\"feature_tri_layer.md\":\"H5S9g49a\",\"feature_send_string.md\":\"ucKdf_1f\",\"feature_pointing_device.md\":\"D8bKydDH\",\"feature_unicode.md\":\"CmuIgTId\",\"feature_split_keyboard.md\":\"dSXqGTcC\",\"flash_driver.md\":\"BTZjpIxy\",\"feature_rgb_matrix.md\":\"DjrTztSt\",\"flashing_bootloadhid.md\":\"aXGP0bN5\",\"flashing.md\":\"CGYYQUk5\",\"feature_space_cadet.md\":\"BadigqA6\",\"faq_keymap.md\":\"BNm1UZCq\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"index.md\":\"Q8qZBSI9\",\"pr_checklist.md\":\"B5cKcG_-\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"quantum_painter_qff.md\":\"kLNwshez\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"isp_flashing_guide.md\":\"DfzdHli4\",\"ref_functions.md\":\"BqUSY2Jo\",\"reference_configurator_support.md\":\"FaBQzIj6\",\"reference_glossary.md\":\"2AN0RaWE\",\"spi_driver.md\":\"BUPXWtdm\",\"serial_driver.md\":\"FRk1ebke\",\"squeezing_avr.md\":\"BmcLYKOr\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"support.md\":\"CwJ_H6Qx\",\"reference_info_json.md\":\"DLkUuXVh\",\"syllabus.md\":\"0-MOMJnE\",\"uart_driver.md\":\"Cby_2B9q\",\"tap_hold.md\":\"54I6XHRj\",\"changelog_20221126.md\":\"BOpHhXi2\",\"feature_midi.md\":\"6rA7lbe-\",\"feature_sequencer.md\":\"B9A4Z8EN\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"hardware_drivers.md\":\"DFF5LGTT\",\"getting_started_introduction.md\":\"BOJreqSs\",\"feature_autocorrect.md\":\"MXySdvB8\",\"feature_bluetooth.md\":\"bG-tYvch\",\"newbs_building_firmware.md\":\"C7XiOjZf\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"newbs_flashing.md\":\"B42m5Wln\",\"feature_tap_dance.md\":\"B6ipWqOP\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3
</body>
</html>