qmk_firmware/how_keyboards_work.html

26 lines
101 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>How Keys Are Registered, and Interpreted by Computers | 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.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.D828SKzM.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.D-bb5p4x.js">
<link rel="modulepreload" href="/assets/how_keyboards_work.md.CB7z8ocb.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="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></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
<span class="line"><span>| User |--------&gt;| Key |------&gt;| Firmware |-----&gt;| USB wire |----&gt;| OS |</span></span>
<span class="line"><span>+------+ +-----+ +----------+ +----------+ +----+</span></span></code></pre></div><p>This scheme is a very simple view of what&#39;s going on, and more details follow in the next sections.</p><h2 id="_1-you-press-a-key" tabindex="-1">1. You Press a Key <a class="header-anchor" href="#_1-you-press-a-key" aria-label="Permalink to &quot;1. You Press a Key&quot;"></a></h2><p>Whenever you press a key, the firmware of your keyboard can register this event. It can register when the key is pressed, held and released.</p><p>This usually happens with a periodic scan of key presses. This speed often is limited by the mechanical key response time, the protocol to transfer those key presses (here USB HID), and by the software it is used in.</p><h2 id="_2-what-the-firmware-sends" tabindex="-1">2. What the Firmware Sends <a class="header-anchor" href="#_2-what-the-firmware-sends" aria-label="Permalink to &quot;2. What the Firmware Sends&quot;"></a></h2><p>The <a href="https://www.usb.org/sites/default/files/documents/hut1_12v2.pdf" target="_blank" rel="noreferrer">HID specification</a> tells what a keyboard can actually send through USB to have a chance to be properly recognised. This includes a pre-defined list of scancodes which are simple numbers from <code>0x00</code> to <code>0xE7</code>. The firmware assigns a scancode to each key of the keyboard.</p><p>The firmware does not send actual letters or characters, but only scancodes. Thus, by modifying the firmware, you can only modify what scancode is sent over USB for a given key.</p><h2 id="_3-what-the-event-input-kernel-does" tabindex="-1">3. What the Event Input/Kernel Does <a class="header-anchor" href="#_3-what-the-event-input-kernel-does" aria-label="Permalink to &quot;3. What the Event Input/Kernel Does&quot;"></a></h2><p>The <em>scancode</em> is mapped to a <em>keycode</em> dependent on the keyboard <a href="https://github.com/systemd/systemd/blob/main/hwdb.d/60-keyboard.hwdb" target="_blank" rel="noreferrer">60-keyboard.hwdb at Main</a>. Without this mapping, the operating system will not receive a valid keycode and will be unable to do anything useful with that key press.</p><h2 id="_4-what-the-operating-system-does" tabindex="-1">4. What the Operating System Does <a class="header-anchor" href="#_4-what-the-operating-system-does" aria-label="Permalink to &quot;4. What the Operating System Does&quot;"></a></h2><p>Once the keycode reaches the operating system, a piece of software has to have it match an actual character thanks to a keyboard layout. For example, if your layout is set to QWERTY, a sample of the matching table is as follows:</p><table><thead><tr><th>keycode</th><th>character</th></tr></thead><tbody><tr><td>0x04</td><td>a/A</td></tr><tr><td>0x05</td><td>b/B</td></tr><tr><td>0x06</td><td>c/C</td></tr><tr><td>...</td><td>...</td></tr><tr><td>0x1C</td><td>y/Y</td></tr><tr><td>0x1D</td><td>z/Z</td></tr><tr><td>...</td><td>...</td></tr></tbody></table><h2 id="back-to-the-firmware" tabindex="-1">Back to the Firmware <a class="header-anchor" href="#back-to-the-firmware" aria-label="Permalink to &quot;Back to the Firmware&quot;"></a></h2><p>As the layout is generally fixed (unless you create your own), the firmware can actually call a keycode by its layout name directly to ease things for you. This is exactly what is done here with <code>KC_A</code> actually representing <code>0x04</code> in QWERTY. The full list can be found in <a href="./keycodes">keycodes</a>.</p><h2 id="list-of-characters-you-can-send" tabindex="-1">List of Characters You Can Send <a class="header-anchor" href="#list-of-characters-you-can-send" aria-label="Permalink to &quot;List of Characters You Can Send&quot;"></a></h2><p>Putting aside shortcuts, having a limited set of keycodes mapped to a limited layout means that <strong>the list of characters you can assign to a given key are only the ones present in the layout</strong>.</p><p>For example, this means that if you have a QWERTY US layout, and you want to assign one key to produc
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20200829.md\":\"CoqrOffn\",\"changelog_20210529.md\":\"CR1YNfZX\",\"cli_configuration.md\":\"CGSB128P\",\"config_options.md\":\"DvMeqlpB\",\"cli.md\":\"BLzAdA6l\",\"configurator_architecture.md\":\"DEFTvTlS\",\"cli_commands.md\":\"DGx-qNiE\",\"drivers_serial.md\":\"qxjytVdM\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_uart.md\":\"BNBs-m3h\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"changelog_20230827.md\":\"NSPhmB6l\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"api_overview.md\":\"0FPaUsMb\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"features_sequencer.md\":\"DkgqNCsQ\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"one_shot_keys.md\":\"QR09rSb-\",\"arm_debugging.md\":\"BH-H2Ukz\",\"feature_userspace.md\":\"BsmY9yWw\",\"features_unicode.md\":\"CsON-fJH\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20210828.md\":\"DNbHIuuM\",\"cli_development.md\":\"3xFA2OvS\",\"faq_keymap.md\":\"BsEmEZTo\",\"other_eclipse.md\":\"C-zqyJO9\",\"drivers_gpio.md\":\"C5PvyJVh\",\"other_vscode.md\":\"Di3vOySR\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20240526.md\":\"iGLFD0SP\",\"features_space_cadet.md\":\"DmNfYRVJ\",\"faq_misc.md\":\"qGrhOTu4\",\"features_stenography.md\":\"Bb_IhUGl\",\"features_st7565.md\":\"MoajNurJ\",\"features_ps2_mouse.md\":\"CL_pA9sk\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"feature_eeprom.md\":\"a0eoTZm7\",\"changelog_20220827.md\":\"DjPthqDk\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_eeprom.md\":\"B_6soqar\",\"drivers_flash.md\":\"DhWcHp8S\",\"changelog_20221126.md\":\"DpbrnXeC\",\"drivers_i2c.md\":\"Cuj87reB\",\"api_development_overview.md\":\"Dcey4ntL\",\"features_wpm.md\":\"BYf-Xc1H\",\"flashing.md\":\"BSZF2RCy\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"faq_build.md\":\"DL_WezA1\",\"api_docs.md\":\"CRoD6CbL\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"porting_your_keyboard_to_qmk.md\":\"CGlGdFj4\",\"faq_general.md\":\"BC3pFw4U\",\"data_driven_config.md\":\"BvLQ7P20\",\"custom_matrix.md\":\"DMnRw_5l\",\"faq_debug.md\":\"DuThValw\",\"pr_checklist.md\":\"BnrDXG2G\",\"documentation_templates.md\":\"Bhkum0wD\",\"drivers_adc.md\":\"DzU8txf8\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"features_caps_word.md\":\"BDQGM0-x\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"features_swap_hands.md\":\"DOhgGQf9\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_tri_layer.md\":\"DdnBVinw\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"features_encoders.md\":\"B2SX3hG2\",\"features_tap_dance.md\":\"CKLVpnIn\",\"getting_started_make_guide.md\":\"BjUuEnSh\",\"reference_glossary.md\":\"CXMuxToT\",\"features_grave_esc.md\":\"mUNEjUYS\",\"reference_keymap_extras.md\":\"-n_bLm78\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20230528.md\":\"nX9R48zP\",\"changelog_20240225.md\":\"B4-WrXj6\",\"features_audio.md\":\"DWNYte3W\",\"contributing.md\":\"DLsp4vSA\",\"features_hd44780.md\":\"15K40o_e\",\"features_key_lock.md\":\"IjFq9dYs\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_led_indicators.md\":\"CCZhjHe9\",\"features_mouse_keys.md\":\"C3P3pYuE\",\"features_midi.md\":\"u3tHPteB\",\"features_led_matrix.md\":\"DV31nHH-\",\"features_repeat_key.md\":\"C3eWDUWn\",\"features_rawhid.md\":\"bKKG3KCa\",\"features_oled_driver.md\":\"D9wJVdL1\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"getting_started_github.md\":\"OYq7IT7B\",\"getting_started_introduction.md\":\"BOJreqSs\",\"features_secure.md\":\"BX7jFvW5\",\"features_rgblight.md\":\"DehQikiL\",\"hardware_drivers.md\":\"BUnx48D9\",\"h
</body>
</html>