qmk_firmware/how_a_matrix_works.html

73 lines
105 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 a Keyboard Matrix Works | 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.DWuET1QV.css" as="style">
<script type="module" src="/assets/app.D4WigKuz.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.BUy7YO2h.js">
<link rel="modulepreload" href="/assets/how_a_matrix_works.md.JINKbCuX.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> x x</span></span>
<span class="line"><span> col0 col1 col0 col1</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> row0 ---(key0)---(key1) row0 ---(key0)---(key1)</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> row1 ---(key2)---(key3) row1 ---(key2)---(key3)</span></span></code></pre></div><p>The <code>x</code> represents that the column/row associated has a value of 1, or is HIGH. Here, we see that no keys are being pressed, so no rows get an <code>x</code>. For one keyswitch, keep in mind that one side of the contacts is connected to its row, and the other, its column.</p><p>When we press <code>key0</code>, <code>col0</code> gets connected to <code>row0</code>, so the values that the firmware receives for that row is <code>0b01</code> (the <code>0b</code> here means that this is a bit value, meaning all of the following digits are bits - 0 or 1 - and represent the keys in that column). We&#39;ll use this notation to show when a keyswitch has been pressed, to show that the column and row are being connected:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span> Column 0 being scanned Column 1 being scanned</span></span>
<span class="line"><span> x x</span></span>
<span class="line"><span> col0 col1 col0 col1</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> x row0 ---(-+-0)---(key1) row0 ---(-+-0)---(key1)</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> row1 ---(key2)---(key3) row1 ---(key2)---(key3)</span></span></code></pre></div><p>We can now see that <code>row0</code> has an <code>x</code>, so has the value of 1. As a whole, the data the firmware receives when <code>key0</code> is pressed is:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>col0: 0b01</span></span>
<span class="line"><span>col1: 0b00</span></span>
<span class="line"><span> │└row0</span></span>
<span class="line"><span> └row1</span></span></code></pre></div><p>A problem arises when you start pressing more than one key at a time. Looking at our matrix again, it should become pretty obvious:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span> Column 0 being scanned Column 1 being scanned</span></span>
<span class="line"><span> x x</span></span>
<span class="line"><span> col0 col1 col0 col1</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> x row0 ---(-+-0)---(-+-1) x row0 ---(-+-0)---(-+-1)</span></span>
<span class="line"><span> | | | |</span></span>
<span class="line"><span> x row1 ---(key2)---(-+-3) x row1 ---(key2)---(-+-3)</span></span>
<span class="line"><span></span></span>
<span class="line"><span> Remember that this ^ is still connected to row1</span></span></code></pre></div><p>The data we get from that is:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>col0: 0b11</span></span>
<span class="line"><span>col1: 0b11</span></span>
<span class="line"><span> │└row0</span></span>
<span class="line"><span> └row1</span></span></code></pre></div><p>Which isn&#39;t accurate, since we only have 3 keys pressed down, not all 4. This behavior is called ghosting, and only happens in odd scenarios like this, but can be much more common on a bigger keyboard. The way we can get around this is by placing a diode after the keyswitch, but before it connects to its row. A diode only allows current to pass through one way, which will protect our other columns/rows from being activated in the previous example. We&#39;ll represent a dioded matrix like this;</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span> Column 0 being scanned Column 1 being scanned</span></span>
<span class="line"><span> x x</span></span>
<span class="line"><span> col0 col1 col0 col1</span></span>
<span class="line"><span> │ │ | │</span></span>
<span class="line"><span> (key0) (key1) (key0) (key1)</span></span>
<span class="line"><span> ! │ ! │ ! | ! │</span></span>
<span class="line"><span> row0 ─────┴────────┘ │ row0 ─────┴────────┘ │</span></span>
<span class="line"><span> │ │ | │</span></span>
<span class="line"><span> (key2) (key3) (key2) (key3)</span></span>
<span class="line"><span> ! ! ! !</span></span>
<span class="line"><span> row1 ─────┴────────┘ row1 ─────┴────────┘</span></span></code></pre></div><p>In practical applications, the black line of the diode will be placed facing the row, and away from the keyswitch - the <code>!</code> in this case is the diode, where the gap represents the black line. A good way to remember this is to think of this symbol: <code>&gt;|</code></p><p>Now when we press the three keys, invoking what would be a ghosting scenario:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span> Column 0 being scanned Column 1 being scanned</span></span>
<span class="line"><span> x x</span></span>
<span class="line"><span> col0 col1 col0 col1</span></span>
<span class="line"><span> │ │ │ │</span></span>
<span class="line"><span> (┌─┤0) (┌─┤1) (┌─┤0) (┌─┤1)</span></span>
<span class="line"><span> ! │ ! │ ! │ ! │</span></span>
<span class="line"><span> x row0 ─────┴────────┘ │ x row0 ─────┴────────┘ │</span></span>
<span class="line"><span> │ │ │ │</span></span>
<span class="line"><span> (key2) (┌─┘3) (key2) (┌─┘3)</span></span>
<span class="line"><span> ! ! ! !</span></span>
<span class="line"><span> row1 ─────┴────────┘ x row1 ─────┴────────┘</span></span></code></pre></div><p>Things act as they should! Which will get us the following data:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>col0: 0b01</span></span>
<span class="line"><span>col1: 0b11</span></span>
<span class="line"><span> │└row0</span></span>
<span class="line"><span> └row1</span></span></code></pre></div><p>The firmware can then use this correct data to detect what it should do, and eventually, what signals it needs to send to the OS.</p><p>Further reading:</p><ul><li><a href="https://en.wikipedia.org/wiki/Keyboard_matrix_circuit" target="_blank" rel="noreferrer">Wikipedia article</a></li><li><a href="https://deskthority.net/wiki/Keyboard_matrix" target="_blank" rel="noreferrer">Deskthority article</a></li><li><a href="https://www.dribin.org/dave/keyboard/one_html/" target="_blank" rel="noreferrer">Keyboard Matrix Help by Dave Dribin (2000)</a></li><li><a href="https://pcbheaven.com/wikipages/How_Key_Matrices_Works/" target="_blank" rel="noreferrer">How Key Matrices Works by PCBheaven</a> (animated examples)</li><li><a href="./how_keyboards_work">How keyboards work - QMK documentation</a></li></ul></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link prev" href="/how_keyboards_work" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Previous page</span><span class="title" data-v-09de1c0f>How Keyboards Work</span><!--]--></a></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/understanding_qmk" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Next page</span><span class="title" data-v-09de1c0f>Understanding QMK</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20220827.md\":\"I6ja7C5w\",\"faq_build.md\":\"Bryo1ywz\",\"driver_installation_zadig.md\":\"BIO-iq8r\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"contributing.md\":\"DLsp4vSA\",\"feature_digitizer.md\":\"XYO9R19s\",\"feature_advanced_keycodes.md\":\"jN1BLaPG\",\"eeprom_driver.md\":\"CJGhJYmK\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"changelog_20190830.md\":\"Drtq3lMy\",\"breaking_changes.md\":\"BtdqWQlY\",\"configurator_architecture.md\":\"DEFTvTlS\",\"feature_key_lock.md\":\"DBAH_Fju\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"changelog_20220528.md\":\"BdSPPJS6\",\"feature_key_overrides.md\":\"DXeoCP3-\",\"feature_backlight.md\":\"DBI0guDv\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"custom_matrix.md\":\"DMnRw_5l\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"changelog_20210529.md\":\"CR1YNfZX\",\"config_options.md\":\"D0qoSxZG\",\"feature_caps_word.md\":\"DFEidvi5\",\"data_driven_config.md\":\"BvLQ7P20\",\"documentation_templates.md\":\"Bhkum0wD\",\"easy_maker.md\":\"BLadB4D_\",\"feature_auto_shift.md\":\"0xqmu9IK\",\"feature_haptic_feedback.md\":\"CI5hNqfq\",\"changelog_20211127.md\":\"BDzkUAQX\",\"changelog_20200829.md\":\"CoqrOffn\",\"feature_led_indicators.md\":\"CZMu7H5E\",\"changelog_20220226.md\":\"Ee8ZP8S1\",\"feature_led_matrix.md\":\"xGxJCIdk\",\"feature_combo.md\":\"BFcSajDz\",\"feature_command.md\":\"DyD1wEzr\",\"feature_converters.md\":\"Bmv29bqN\",\"feature_dip_switch.md\":\"BRm_919T\",\"faq_misc.md\":\"qGrhOTu4\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"newbs_flashing.md\":\"B42m5Wln\",\"newbs_getting_started.md\":\"DD4a5qPC\",\"feature_rawhid.md\":\"_qE_L8rS\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3BRmm\",\"newbs_git_resynchronize_a_branch.md\":\"YGDefQFx\",\"newbs_git_using_your_master_branch.md\":\"B9DxZCl8\",\"flashing_bootloadhid.md\":\"aXGP0bN5\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"getting_started_github.md\":\"OYq7IT7B\",\"getting_started_introduction.md\":\"BOJreqSs\",\"getting_started_make_guide.md\":\"fsRi0mqX\",\"gpio_control.md\":\"BXAY05Da\",\"hand_wire.md\":\"CieyXSH7\",\"feature_repeat_key.md\":\"D8sTeKpj\",\"feature_ps2_mouse.md\":\"DgKRvSpd\",\"hardware_drivers.md\":\"DFF5LGTT\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"feature_macros.md\":\"DpKdCniT\",\"feature_os_detection.md\":\"DZib_QdQ\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"feature_mouse_keys.md\":\"Iyt3Hb3p\",\"one_shot_keys.md\":\"QR09rSb-\",\"feature_swap_hands.md\":\"DYy3Hkxa\",\"other_eclipse.md\":\"C-zqyJO9\",\"other_vscode.md\":\"Di3vOySR\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"porting_your_keyboard_to_qmk.md\":\"YHGsI2lB\",\"pr_checklist.md\":\"B5cKcG_-\",\"feature_pointing_device.md\":\"D8bKydDH\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"feature_programmable_button.md\":\"BP5-HUlT\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"hardware_keyboard_guidelines.md\":\"D6JrfTvT\",\"flashing.md\":\"CGYYQUk5\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"platformdev_rp2040.md\":\"Ca0zZxM4\",\"quantum_painter_qff.md\":\"kLNwshez\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"ref_functions.md\":\"BqUSY2Jo\",\"feature_joystick.md\":\"BQEb6YMp\",\"changelog_20230827.md\":\"CkGh7Wzq\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"documentation_best_practices.md\":\"D_UwEt1C\",\"feature_unicode.md\":\"D_2PhXnL\",\"faq_debug.md\":\"uJtFRvCN\",\"cli_development.md\":\"CczMJOE3\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"feature_bootmagic.md\":\"C
</body>
</html>