mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-02 07:55:12 +00:00
62 lines
158 KiB
HTML
62 lines
158 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>QMK Breaking Changes - 2021 November 27 Changelog | 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.85wRauGK.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.Ddh06bHk.js">
|
||
<link rel="modulepreload" href="/assets/ChangeLog_20211127.md.ClUawWkq.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 4.3125 31.3125 3.84375 C 30.738281 3.375 29.9375 3 29 3 Z M 41 5 C 42.667969 5 44 6.332031 44 8 C 44 9.667969 42.667969 11 41 11 C 39.332031 11 38 9.667969 38 8 C 38 6.332031 39.332031 5 41 5 Z M 25 15 C 30.609375 15 35.675781 16.613281 39.28125 19.1875 C 42.886719 21.761719 45 25.226563 45 29 C 45 32.773438 42.886719 36.238281 39.28125 38.8125 C 35.675781 41.386719 30.609375 43 25 43 C 19.390625 43 14.324219 41.386719 10.71875 38.8125 C 7.113281 36.238281 5 32.773438 5 29 C 5 25.226563 7.113281 21.761719 10.71875 19.1875 C 14.324219 16.613281 19.390625 15 25 15 Z M 7.5 16.9375 C 8.203125 16.9375 8.914063 17.148438 9.53125 17.59375 C 7.527344 19.03125 5.886719 20.769531 4.75 22.71875 C 3.582031 21.296875 3.660156 19.339844 5 18 C 5.714844 17.285156 6.609375 16.9375 7.5 16.9375 Z M 42.5 16.9375 C 43.390625 16.9375 44.285156 17.285156 45 18 C 46.339844 19.339844 46.417969 21.296875 45.25 22.71875 C 44.113281 20.769531 42.472656 19.03125 40.46875 17.59375 C 41.085938 17.148438 41.796875 16.9375 42.5 16.9375 Z M 17 22 C 14.800781 22 13 23.800781 13 26 C 13 28.199219 14.800781 30 17 30 C 19.199219 30 21 28.199219 21 26 C 21 23.800781 19.199219 22 17 22 Z M 33 22 C 30.800781 22 29 23.800781 29 26 C 29 28.199219 30.800781 30 33 30 C 35.199219 30 37 28.199219 37 26 C 37 23.800781 35.199219 22 33 22 Z M 17 24 C 18.117188 24 19 24.882813 19 26 C 19 27.117188 18.117188 28 17 28 C 15.882813 28 15 27.117188 15 26 C 15 24.882813 15.882813 24 17 24 Z M 33 24 C 34.117188 24 35 24.882813 35 26 C 35 27.117188 34.117188 28 33 28 C 31.882813 28 31 27.117188 31 26 C 31 24.882813 31.882813 24 33 24 Z M 34.15625 33.84375 C 34.101563 33.851563 34.050781 33.859375 34 33.875 C 33.683594 33.9375 33.417969 34.144531 33.28125 34.4375 C 33.28125 34.4375 32.757813 35.164063 31.4375 36 C 30.117188 36.835938 28.058594 37.6875 25 37.6875 C 21.941406 37.6875 19.882813 36.835938 18.5625 36 C 17.242188 35.164063 16.71875 34.4375 16.71875 34.4375 C 16.492188 34.082031 16.066406 33.90625 15.65625 34 C 15.332031 34.082031 15.070313 34.316406 14.957031 34.632813 C 14.84375 34.945313 14.894531 35.292969 15.09375 35.5625 C 15.09375 35.5625 15.863281 36.671875 17.46875 37.6875 C 19.074219 38.703125 21.558594 39.6875 25 39.6875 C 28.441406 39.6875 30.925781 38.703125 32.53125 37.6875 C 34.136719 36.671875 34.90625 35.5625 34.90625 35.5625 C 35.207031 35.273438 35.296875 34.824219 35.128906 34.441406 C 34.960938 34.058594 34.574219 33.820313 34.15625 33.84375 Z"/></svg></a><a class="VPSocialLink no-icon" href="https://discord.gg/qmk" aria-label="discord" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-discord" /></a><a class="VPSocialLink no-icon" href="https://github.com/qmk/qmk_firmware" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-ccf7ddec data-v-d0bd9dde data-v-b6c34ac9><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-b6c34ac9><span class="vpi-more-horizontal icon" data-v-b6c34ac9></span></button><div class="menu" data-v-b6c34ac9><div class="VPMenu" data-v-b6c34ac9 data-v-e7ea1737><!----><!--[--><!--[--><!----><div class="group" data-v-d0bd9dde><div class="item appearance" data-v-d0bd9dde><p class="label" data-v-d0bd9dde>Appearance</p><div class="appearance-action" data-v-d0bd9dde><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-d0bd9dde 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></div><div class="group" data-v-d0bd9dde><div class="item social-links" data-v-d0bd9dde><div class="VPSocialLinks social-links-list" data-v-d0bd9dde 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.84375 C 30.738281 3.375 29.9375 3 29 3 Z M 41 5 C 42.667969 5 44 6.332031 44 8 C 44 9.667969 42.667969 11 41 11 C 39.332031 11 38 9.667969 38 8 C 38 6.332031 39.332031 5 41 5 Z M 25 15 C 30.609375 15 35.675781 16.613281 39.28125 19.1875 C 42.886719 21.761719 45 25.226563 45 29 C 45 32.773438 42.886719 36.238281 39.28125 38.8125 C 35.675781 41.386719 30.609375 43 25 43 C 19.390625 43 14.324219 41.386719 10.71875 38.8125 C 7.113281 36.238281 5 32.773438 5 29 C 5 25.226563 7.113281 21.761719 10.71875 19.1875 C 14.324219 16.613281 19.390625 15 25 15 Z M 7.5 16.9375 C 8.203125 16.9375 8.914063 17.148438 9.53125 17.59375 C 7.527344 19.03125 5.886719 20.769531 4.75 22.71875 C 3.582031 21.296875 3.660156 19.339844 5 18 C 5.714844 17.285156 6.609375 16.9375 7.5 16.9375 Z M 42.5 16.9375 C 43.390625 16.9375 44.285156 17.285156 45 18 C 46.339844 19.339844 46.417969 21.296875 45.25 22.71875 C 44.113281 20.769531 42.472656 19.03125 40.46875 17.59375 C 41.085938 17.148438 41.796875 16.9375 42.5 16.9375 Z M 17 22 C 14.800781 22 13 23.800781 13 26 C 13 28.199219 14.800781 30 17 30 C 19.199219 30 21 28.199219 21 26 C 21 23.800781 19.199219 22 17 22 Z M 33 22 C 30.800781 22 29 23.800781 29 26 C 29 28.199219 30.800781 30 33 30 C 35.199219 30 37 28.199219 37 26 C 37 23.800781 35.199219 22 33 22 Z M 17 24 C 18.117188 24 19 24.882813 19 26 C 19 27.117188 18.117188 28 17 28 C 15.882813 28 15 27.117188 15 26 C 15 24.882813 15.882813 24 17 24 Z M 33 24 C 34.117188 24 35 24.882813 35 26 C 35 27.117188 34.117188 28 33 28 C 31.882813 28 31 27.117188 31 26 C 31 24.882813 31.882813 24 33 24 Z M 34.15625 33.84375 C 34.101563 33.851563 34.050781 33.859375 34 33.875 C 33.683594 33.9375 33.417969 34.144531 33.28125 34.4375 C 33.28125 34.4375 32.757813 35.164063 31.4375 36 C 30.117188 36.835938 28.058594 37.6875 25 37.6875 C 21.941406 37.6875 19.882813 36.835938 18.5625 36 C 17.242188 35.164063 16.71875 34.4375 16.71875 34.4375 C 16.492188 34.082031 16.066406 33.90625 15.65625 34 C 15.332031 34.082031 15.070313 34.316406 14.957031 34.632813 C 14.84375 34.945313 14.894531 35.292969 15.09375 35.5625 C 15.09375 35.5625 15.863281 36.671875 17.46875 37.6875 C 19.074219 38.703125 21.558594 39.6875 25 39.6875 C 28.441406 39.6875 30.925781 38.703125 32.53125 37.6875 C 34.136719 36.671875 34.90625 35.5625 34.90625 35.5625 C 35.207031 35.273438 35.296875 34.824219 35.128906 34.441406 C 34.960938 34.058594 34.574219 33.820313 34.15625 33.84375 Z"/></svg></a><a class="VPSocialLink no-icon" href="https://discord.gg/qmk" aria-label="discord" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-discord" /></a><a class="VPSocialLink no-icon" href="https://github.com/qmk/qmk_firmware" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><span class="vpi-social-github" /></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-ccf7ddec data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-ccf7ddec><div class="divider-line" data-v-ccf7ddec></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-267dd0ed><button data-v-267dd0ed>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-575e6a36><div class="curtain" data-v-575e6a36></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-575e6a36><span class="visually-hidden" id="sidebar-aria-label" data-v-575e6a36> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>Tutorial</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_getting_started" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Setup</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_building_firmware" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Building Your First Firmware</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_flashing" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Flashing Firmware</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/support" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Getting Help/Support</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_external_userspace" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>External Userspace</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_learn_more_resources" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Other Resources</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/syllabus" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Syllabus</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>FAQs</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/faq_general" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>General FAQ</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/faq_build" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Build/Compile QMK</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/faq_misc" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Troubleshooting QMK</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/faq_debug" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Debugging QMK</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/faq_keymap" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Keymap FAQ</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/squeezing_avr" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Squeezing Space from AVR</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/reference_glossary" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Glossary</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>Configurator</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_building_firmware_configurator" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/configurator_step_by_step" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Step by Step</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/configurator_troubleshooting" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Troubleshooting</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/configurator_architecture" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Architecture</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>QMK API</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/api_overview" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/api_docs" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>API Documentation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/reference_configurator_support" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Keyboard Support</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/configurator_default_keymaps" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Adding Default Keymaps</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>CLI</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/cli" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/cli_configuration" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Configuration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/cli_commands" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Commands</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/cli_tab_complete" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Tab Completion</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>Using QMK</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Guides</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/custom_quantum_functions" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Customizing Functionality</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/driver_installation_zadig" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Driver Installation with Zadig</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/keymap" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Keymap Overview</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>Development Environments</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/getting_started_docker" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Docker Guide</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/flashing" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Flashing</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>IDEs</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/other_eclipse" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Using Eclipse with QMK</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/other_vscode" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Using VSCode with QMK</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>Git Best Practices</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_git_best_practices" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Introduction</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_git_using_your_master_branch" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Your Fork</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_git_resolving_merge_conflicts" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Merge Conflicts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/newbs_git_resynchronize_a_branch" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Fixing Your Branch</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Simple Keycodes</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/keycodes" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Full List</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/keycodes_basic" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Basic Keycodes</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/reference_keymap_extras" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Language-Specific Keycodes</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_advanced_keycodes" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Modifier Keys</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/quantum_keycodes" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Quantum Keycodes</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/keycodes_magic" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Magic Keycodes</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Advanced Keycodes</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/command" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Command</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/dynamic_macros" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Dynamic Macros</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/grave_esc" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Grave Escape</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/leader_key" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Leader Key</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/mod_tap" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Mod-Tap</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_macros" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Macros</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/mouse_keys" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Mouse Keys</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/programmable_button" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Programmable Button</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/repeat_key" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Repeat Key</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/space_cadet" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Space Cadet Shift</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/keycodes_us_ansi_shifted" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>US ANSI Shifted Keys</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Software Features</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/auto_shift" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Auto Shift</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/autocorrect" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Autocorrect</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/caps_word" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Caps Word</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/combo" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Combos</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_debounce_type" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Debounce API</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/digitizer" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Digitizer</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_eeprom" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>EEPROM</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/key_lock" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Key Lock</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/key_overrides" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Key Overrides</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_layers" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Layers</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/one_shot_keys" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>One Shot Keys</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/os_detection" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>OS Detection</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/rawhid" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Raw HID</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/secure" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Secure</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/send_string" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Send String</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/sequencer" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Sequencer</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/swap_hands" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Swap Hands</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/tap_dance" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Tap Dance</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/tap_hold" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Tap-Hold Configuration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/tri_layer" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Tri Layer</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/unicode" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Unicode</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_userspace" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Userspace</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/wpm" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>WPM Calculation</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Hardware Features</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>Displays</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><section class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/quantum_painter" data-v-b8d55f3b><!--[--><h5 class="text" data-v-b8d55f3b>Quantum Painter</h5><!--]--></a><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-4 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/quantum_painter_lvgl" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Quantum Painter LVGL Integration</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/hd44780" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>HD44780 LCD Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/st7565" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>ST7565 LCD Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/oled_driver" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>OLED Driver</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>Lighting</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/backlight" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Backlight</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/led_matrix" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>LED Matrix</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/rgblight" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>RGB Lighting</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/rgb_matrix" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>RGB Matrix</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/audio" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Audio</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/bluetooth" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Bluetooth</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/bootmagic" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Bootmagic Lite</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_converters" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Converters</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/custom_matrix" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Custom Matrix</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/dip_switch" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>DIP Switch</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/encoders" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Encoders</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/haptic_feedback" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Haptic Feedback</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/joystick" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Joystick</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/led_indicators" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>LED Indicators</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/midi" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>MIDI</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/pointing_device" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Pointing Device</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/ps2_mouse" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>PS/2 Mouse</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/split_keyboard" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Split Keyboard</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/features/stenography" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Stenography</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Keyboard Building</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/easy_maker" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Easy Maker for One Offs</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/porting_your_keyboard_to_qmk" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Porting Keyboards</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/hand_wire" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Hand Wiring Guide</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/isp_flashing_guide" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>ISP Flashing Guide</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="group" data-v-575e6a36><section class="VPSidebarItem level-0" data-v-575e6a36 data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h2 class="text" data-v-b8d55f3b>Developing QMK</h2><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/pr_checklist" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>PR Checklist</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Breaking Changes</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/breaking_changes" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/breaking_changes_instructions" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>My Pull Request Was Flagged</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/ChangeLog/20240825" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Most Recent ChangeLog</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/breaking_changes_history" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Past Breaking Changes</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/support_deprecation_policy" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Deprecation Policy</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>C Development</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/arm_debugging" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>ARM Debugging Guide</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/coding_conventions_c" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Coding Conventions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/compatible_microcontrollers" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Compatible Microcontrollers</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/hardware_drivers" data-v-b8d55f3b><!--[--><h4 class="text" data-v-b8d55f3b>Drivers</h4><!--]--></a><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/adc" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>ADC Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/apa102" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>APA102 Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/audio" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Audio Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/eeprom" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>EEPROM Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/flash" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Flash Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/i2c" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>I2C Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/serial" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>'serial' Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/spi" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>SPI Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/uart" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>UART Driver</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/ws2812" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>WS2812 Driver</p><!--]--></a><!----></div><!----></div><!--]--></div></section><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/drivers/gpio" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>GPIO Controls</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/hardware_keyboard_guidelines" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Keyboard Guidelines</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Python Development</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/coding_conventions_python" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Coding Conventions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/cli_development" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>QMK CLI Development</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Configurator Development</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>QMK API</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/api_development_environment" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Development Environment</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/api_development_overview" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Architecture Overview</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>Hardware Platform Development</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><section class="VPSidebarItem level-2" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h4 class="text" data-v-b8d55f3b>Arm/ChibiOS</h4><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/platformdev_selecting_arm_mcu" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Selecting an MCU</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/platformdev_chibios_earlyinit" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Early initialization</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/platformdev_rp2040" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Raspberry Pi RP2040</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/platformdev_proton_c" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Proton C</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-3 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/platformdev_blackpill_f4x1" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>WeAct Blackpill F4x1</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>QMK Reference</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/contributing" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Contributing to QMK</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/config_options" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Config Options</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/data_driven_config" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Data Driven Configuration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/getting_started_make_guide" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Make Documentation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/documentation_best_practices" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Documentation Best Practices</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/documentation_templates" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Documentation Templates</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/feature_layouts" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Community Layouts</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/unit_testing" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Unit Testing</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/ref_functions" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Useful Functions</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/reference_info_json" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>info.json Format</p><!--]--></a><!----></div><!----></div><!--]--></div></section><section class="VPSidebarItem level-1" data-v-b8d55f3b data-v-b8d55f3b><div class="item" role="button" tabindex="0" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><h3 class="text" data-v-b8d55f3b>For a Deeper Understanding</h3><!----></div><div class="items" data-v-b8d55f3b><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/how_keyboards_work" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>How Keyboards Work</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/how_a_matrix_works" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>How a Matrix Works</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b8d55f3b data-v-b8d55f3b><div class="item" data-v-b8d55f3b><div class="indicator" data-v-b8d55f3b></div><a class="VPLink link link" href="/understanding_qmk" data-v-b8d55f3b><!--[--><p class="text" data-v-b8d55f3b>Understanding QMK</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><!--[--><!--]--><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><!--[--><!--]--><!--[--><!--]--><div class="VPDocAsideOutline" role="navigation" data-v-3f215769 data-v-935f8a84><div class="content" data-v-935f8a84><div class="outline-marker" data-v-935f8a84></div><div class="outline-title" role="heading" aria-level="2" data-v-935f8a84>On this page</div><nav aria-labelledby="doc-outline-aria-label" data-v-935f8a84><span class="visually-hidden" id="doc-outline-aria-label" data-v-935f8a84> Table of Contents for current page </span><ul class="VPDocOutlineItem root" data-v-935f8a84 data-v-b933a997><!--[--><!--]--></ul></nav></div></div><!--[--><!--]--><div class="spacer" data-v-3f215769></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><!--[--><!--]--><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _ChangeLog_20211127" data-v-39a288b8><div><h1 id="qmk-breaking-changes-2021-november-27-changelog" tabindex="-1">QMK Breaking Changes - 2021 November 27 Changelog <a class="header-anchor" href="#qmk-breaking-changes-2021-november-27-changelog" aria-label="Permalink to "QMK Breaking Changes - 2021 November 27 Changelog""></a></h1><h2 id="qmk-2000th-keyboard" tabindex="-1">2000 keyboards! <a class="header-anchor" href="#qmk-2000th-keyboard" aria-label="Permalink to "2000 keyboards! {#qmk-2000th-keyboard}""></a></h2><p>QMK had it's 2000th keyboard submitted during this breaking changes cycle.... and it only <em>just</em> made the cut-off!</p><div class="language-shell vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">shell</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">%</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> list-keyboards</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> |</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> wc</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -l</span></span>
|
||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">2003</span></span></code></pre></div><p>From the whole QMK team, a major thankyou to the community for embracing QMK as your preferred keyboard firmware!</p><h2 id="notable-features" tabindex="-1">Notable Features <a class="header-anchor" href="#notable-features" aria-label="Permalink to "Notable Features {#notable-features}""></a></h2><h3 id="expanded-pointing-device" tabindex="-1">Expanded Pointing Device support (<a href="https://github.com/qmk/qmk_firmware/pull/14343" target="_blank" rel="noreferrer">#14343</a>) <a class="header-anchor" href="#expanded-pointing-device" aria-label="Permalink to "Expanded Pointing Device support ([#14343](https://github.com/qmk/qmk_firmware/pull/14343)) {#expanded-pointing-device}""></a></h3><p>Pointing device support has been reworked and reimplemented to allow for easier integration of new peripherals.</p><p>Usages of <code>POINTING_DEVICE_ENABLE = yes</code> in <code>rules.mk</code> files now need to be accompanied by a corresponding <code>POINTING_DEVICE_DRIVER = ???</code> line, specifying which driver to use during the build. Existing keyboards have already been migrated across to the new usage pattern, so most likely no change is required by users.</p><p>QMK now has core-supplied support for the following pointing device peripherals:</p><table><thead><tr><th><code>rules.mk</code> line</th><th>Supported device</th></tr></thead><tbody><tr><td><code>POINTING_DEVICE_DRIVER = analog_joystick</code></td><td>Analog joysticks, such as PSP joysticks</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = adns5050</code></td><td>ADNS 5050 sensor</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = adns9800</code></td><td>ADNS 9800 laser sensor</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = cirque_pinnacle_i2c</code></td><td>Cirque touchpad, I2C mode</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = cirque_pinnacle_spi</code></td><td>Cirque Touchpad, SPI mode</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = pimoroni_trackball</code></td><td>Pimoroni Trackball</td></tr><tr><td><code>POINTING_DEVICE_DRIVER = pmw3360</code></td><td>PMW 3360</td></tr></tbody></table><p>See the new documentation for the <a href="./../features/pointing_device">Pointing Device</a> feature for more information on specific configuration for each driver.</p><h3 id="dynamic-tapping-term" tabindex="-1">Dynamic Tapping Term (<a href="https://github.com/qmk/qmk_firmware/pull/11036" target="_blank" rel="noreferrer">#11036</a>) <a class="header-anchor" href="#dynamic-tapping-term" aria-label="Permalink to "Dynamic Tapping Term ([#11036](https://github.com/qmk/qmk_firmware/pull/11036)) {#dynamic-tapping-term}""></a></h3><p>For people who are starting out with tapping keys, or for people who think tapping keys don't "feel right", it's sometimes quite difficult to determine what duration of tapping term to use to make things seem natural.</p><p>If you're in this stage of discovery, you can now add <code>DYNAMIC_TAPPING_TERM_ENABLE = yes</code> to your <code>rules.mk</code>, which enables the use of the following keycodes in your keymap:</p><table><thead><tr><th>Key</th><th>Description</th></tr></thead><tbody><tr><td><code>DT_PRNT</code></td><td>"Dynamic Tapping Term Print": Types the current tapping term, in milliseconds</td></tr><tr><td><code>DT_UP</code></td><td>"Dynamic Tapping Term Up": Increases the current tapping term by 5ms</td></tr><tr><td><code>DT_DOWN</code></td><td>"Dynamic Tapping Term Down": Decreases the current tapping term by 5ms</td></tr></tbody></table><p>Coupled with the use of <code>qmk console</code> or QMK Toolbox to show console output from your keyboard, you can tweak the tapping term dynamically in order to narrow down what "feels right" to you. Once you're happy, drop in the resulting number into your keymap's <code>config.h</code> and you're good to go!</p><h3 id="macros-in-keymap-json" tabindex="-1">Macros in JSON keymaps (<a href="https://github.com/qmk/qmk_firmware/pull/14374" target="_blank" rel="noreferrer">#14374</a>) <a class="header-anchor" href="#macros-in-keymap-json" aria-label="Permalink to "Macros in JSON keymaps ([#14374](https://github.com/qmk/qmk_firmware/pull/14374)) {#macros-in-keymap-json}""></a></h3><p>You can now define up to 32 macros in your <code>keymap.json</code> file, as used by <a href="./../newbs_building_firmware_configurator">QMK Configurator</a>, and <code>qmk compile</code>. You can define these macros in a list under the <code>macros</code> keyword, like this:</p><div class="language-json vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">json</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">{</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "keyboard"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"handwired/my_macropad"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "keymap"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"my_keymap"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "macros"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [ </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// first listed is QK_MACRO_0...</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"down"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"keycodes"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"LSFT"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]},</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "hello world1"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"up"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"keycodes"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"LSFT"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]}</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ],</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [ </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ...then QK_MACRO_1...</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"tap"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"keycodes"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"LCTL"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"LALT"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"DEL"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]}</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ],</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [ </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ...then QK_MACRO_2...</span></span>
|
||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "ding!"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"beep"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ],</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [ </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ...and QK_MACRO_3.</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"tap"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"keycodes"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"F1"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]},</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"delay"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"duration"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"1000"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">},</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"action"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"tap"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">"keycodes"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"PGDN"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]}</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ],</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "layout"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"LAYOUT_all"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> "layers"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">: [</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"QK_MACRO_0"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"QK_MACRO_1"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"QK_MACRO_2"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">"QK_MACRO_3"</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>In due course, <a href="https://config.qmk.fm/" target="_blank" rel="noreferrer">QMK Configurator</a> will pick up support for defining these in its UI, but for now the json is the only way to define macros.</p><h2 id="changes-requiring-user-action" tabindex="-1">Changes Requiring User Action <a class="header-anchor" href="#changes-requiring-user-action" aria-label="Permalink to "Changes Requiring User Action {#changes-requiring-user-action}""></a></h2><h3 id="updated-keyboard-codebases" tabindex="-1">Updated Keyboard Codebases <a class="header-anchor" href="#updated-keyboard-codebases" aria-label="Permalink to "Updated Keyboard Codebases {#updated-keyboard-codebases}""></a></h3><p>The following keyboards have had their source moved within QMK:</p><table><thead><tr><th>Old Keyboard Name</th><th>New Keyboard Name</th></tr></thead><tbody><tr><td>aozora/hotswap</td><td>aozora</td></tr><tr><td>gskt00</td><td>kapcave/gskt00</td></tr><tr><td>handwired/dtisaac01</td><td>dtisaac/dtisaac01</td></tr><tr><td>kprepublic/bm60poker</td><td>kprepublic/bm60hsrgb_poker/rev1</td></tr><tr><td>kprepublic/bm60rgb</td><td>kprepublic/bm60hsrgb/rev1</td></tr><tr><td>kprepublic/bm60rgb_iso</td><td>kprepublic/bm60hsrgb_iso/rev1</td></tr><tr><td>kprepublic/bm65iso</td><td>kprepublic/bm65hsrgb_iso</td></tr><tr><td>kprepublic/bm68rgb</td><td>kprepublic/bm68hsrgb</td></tr><tr><td>paladin64</td><td>kapcave/paladin64</td></tr><tr><td>portal_66</td><td>portal_66/soldered</td></tr><tr><td>signum/3_0/elitec</td><td>signum/3_0</td></tr><tr><td>tgr/jane</td><td>tgr/jane/v2</td></tr></tbody></table><h3 id="squeezing-space-from-avr" tabindex="-1">Squeezing space out of AVR (<a href="https://github.com/qmk/qmk_firmware/pull/15243" target="_blank" rel="noreferrer">#15243</a>) <a class="header-anchor" href="#squeezing-space-from-avr" aria-label="Permalink to "Squeezing space out of AVR ([#15243](https://github.com/qmk/qmk_firmware/pull/15243)) {#squeezing-space-from-avr}""></a></h3><p>The AVR platform has been problematic for some time, in the sense that it is severely resource-constrained -- this makes life difficult for anyone attempting to add new functionality such as display panels to their keymap code. The illustrious Drashna has contributed some newer documentation on how to attempt to free up some space on AVR-based keyboards that are in short supply.</p><p>Of course, there are much fewer constraints with ARM chips... 😉</p><h3 id="explicit-rgb-modes" tabindex="-1">Require explicit enabling of RGB Matrix modes (<a href="https://github.com/qmk/qmk_firmware/pull/15018" target="_blank" rel="noreferrer">#15018</a>) <a class="header-anchor" href="#explicit-rgb-modes" aria-label="Permalink to "Require explicit enabling of RGB Matrix modes ([#15018](https://github.com/qmk/qmk_firmware/pull/15018)) {#explicit-rgb-modes}""></a></h3><p>Related to the previous section -- RGB Matrix modes have now been made to be opt-in, rather than opt-out. As these animations are now opt-in, you may find that your keyboard no longer has all the RGB modes you're expecting -- you may need to configure and recompile your firmware and enable your animations of choice... with any luck they'll still fit in the space available.</p><p>Most keyboards keep their original functionality, but over time the QMK maintainers have found that removal of animations ends up being the quickest way to free up space... and some keyboards have had animations such as reactive effects disabled by default in order to still fit within the flash space available.</p><p>The full list of configurables to turn specific animations back on can be found at on the <a href="./../features/rgb_matrix#rgb-matrix-effects">RGB Matrix documentation</a> page.</p><h3 id="oled-task-refactor" tabindex="-1">OLED task refactoring (<a href="https://github.com/qmk/qmk_firmware/pull/14864" target="_blank" rel="noreferrer">#14864</a>) <a class="header-anchor" href="#oled-task-refactor" aria-label="Permalink to "OLED task refactoring ([#14864](https://github.com/qmk/qmk_firmware/pull/14864)) {#oled-task-refactor}""></a></h3><p>OLED display code was traditionally difficult to override in keymaps as they did not follow the standard pattern of <code>bool *_kb()</code> deferring to <code>bool *_user()</code> functions, allowing signalling to the higher level that processing had already been done.</p><p>This changes the standard OLED drawing function model to allow for a base implementation to be provided by a keyboard, but also still allow for keymap-level overrides without needing to modify the keyboard's code.</p><p>The old keymap code went something like this:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> oled_task_user</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // keymap drawing code</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>...but the new keymap code looks like this:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> oled_task_user</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // keymap drawing code</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> false</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Keyboard designers should now structure their keyboard-level drawing routines like the following, in order to allow for keymap overrides:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">bool</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> oled_task_kb</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Defer to the keymap if they want to override</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">!</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">oled_task_user</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">()) { </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> false</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">; }</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // default keyboard drawing code</span></span>
|
||
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> false</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="bootmagic-full-removal" tabindex="-1">Bootmagic Full Removal (<a href="https://github.com/qmk/qmk_firmware/pull/15002" target="_blank" rel="noreferrer">#15002</a>) <a class="header-anchor" href="#bootmagic-full-removal" aria-label="Permalink to "Bootmagic Full Removal ([#15002](https://github.com/qmk/qmk_firmware/pull/15002)) {#bootmagic-full-removal}""></a></h3><p>As noted during previous breaking changes cycles, QMK decided to deprecate the full Bootmagic feature and leave Bootmagic Lite as the only remaining option.</p><p>This removal is now complete!</p><p>This pull request changes the behavior of <code>BOOTMAGIC_ENABLE</code> such that specifying <code>lite</code> or <code>full</code> results in an error, allowing only <code>yes</code> or <code>no</code>, with <code>yes</code> mirroring historical <code>lite</code> functionality.</p><p>All use of the <code>lite</code> keyword within the repository has been migrated to <code>yes</code> -- any new submissions using <code>lite</code> will now fail to build and should be updated accordingly.</p><h4 id="bootmagic-full-deprecation-schedule-complete" tabindex="-1">Bootmagic Full Deprecation Schedule: Complete! <a class="header-anchor" href="#bootmagic-full-deprecation-schedule-complete" aria-label="Permalink to "Bootmagic Full Deprecation Schedule: Complete!""></a></h4><p>This is the historical timeline for the behavior of <code>BOOTMAGIC_ENABLE</code>:</p><ul><li>(done) From 2021 May 29, setting <code>BOOTMAGIC_ENABLE = yes</code> will enable Bootmagic Lite instead of full Bootmagic.</li><li>(done) From 2021 Aug 28, <code>BOOTMAGIC_ENABLE</code> must be either <code>yes</code>, <code>lite</code>, or <code>no</code> – setting <code>BOOTMAGIC_ENABLE = full</code> will cause compilation to fail.</li><li>(now) From 2021 Nov 27, <code>BOOTMAGIC_ENABLE</code> must be either <code>yes</code> or <code>no</code> – setting <code>BOOTMAGIC_ENABLE = lite</code> will cause compilation to fail.</li></ul><h3 id="remove-qwiic" tabindex="-1">Remove QWIIC_DRIVERS (<a href="https://github.com/qmk/qmk_firmware/pull/14174" target="_blank" rel="noreferrer">#14174</a>) <a class="header-anchor" href="#remove-qwiic" aria-label="Permalink to "Remove QWIIC_DRIVERS ([#14174](https://github.com/qmk/qmk_firmware/pull/14174)) {#remove-qwiic}""></a></h3><p>Due to minimal QWIIC adoption and other options for similar functionality, the QWIIC drivers were removed from QMK. Existing OLED usages have been migrated across to the normal QMK OLED driver instead.</p><h2 id="notable-core" tabindex="-1">Notable core changes <a class="header-anchor" href="#notable-core" aria-label="Permalink to "Notable core changes {#notable-core}""></a></h2><h3 id="new-mcu-support" tabindex="-1">New MCU Support <a class="header-anchor" href="#new-mcu-support" aria-label="Permalink to "New MCU Support {#new-mcu-support}""></a></h3><p>QMK firmware picked up support for a handful of new MCU families, potentially making it a bit easier to source components.</p><p>QMK firmware is now no longer limited to AVR and ARM - it also picked up support for our first RISC-V chip, the GD32VF103.</p><ul><li>Add support for RISC-V builds and GD32VF103 MCU (<a href="https://github.com/qmk/qmk_firmware/pull/12508" target="_blank" rel="noreferrer">#12508</a>)</li><li>Add HT32 support to core (<a href="https://github.com/qmk/qmk_firmware/pull/14388" target="_blank" rel="noreferrer">#14388</a>)</li><li>Westberrytech pr (<a href="https://github.com/qmk/qmk_firmware/pull/14422" target="_blank" rel="noreferrer">#14422</a>)</li><li>Initial pass of F405 support (<a href="https://github.com/qmk/qmk_firmware/pull/14584" target="_blank" rel="noreferrer">#14584</a>)</li></ul><h3 id="eeprom-changes" tabindex="-1">EEPROM Changes <a class="header-anchor" href="#eeprom-changes" aria-label="Permalink to "EEPROM Changes {#eeprom-changes}""></a></h3><p>There were a few EEPROM-related changes that landed during this breaking changes cycle, most prominently the long-awaited ability for the Drop boards to gain persistent storage. Any users of the Drop CTRL or Drop ALT should update QMK Toolbox as well -- coupled with a QMK firmware update settings should now be saved.</p><ul><li>massdrop alt/ctrl: support saving into nvm (<a href="https://github.com/qmk/qmk_firmware/pull/6068" target="_blank" rel="noreferrer">#6068</a>)</li><li>Implement F4 eeprom (<a href="https://github.com/qmk/qmk_firmware/pull/14195" target="_blank" rel="noreferrer">#14195</a>)</li><li>make the full 4096 bytes of EEPROM work on Teensy 3.6 (<a href="https://github.com/qmk/qmk_firmware/pull/12947" target="_blank" rel="noreferrer">#12947</a>)</li><li>Further tidy up of STM32 eeprom emulation (<a href="https://github.com/qmk/qmk_firmware/pull/14591" target="_blank" rel="noreferrer">#14591</a>)</li><li>Enable eeprom with F401xE ld (<a href="https://github.com/qmk/qmk_firmware/pull/14752" target="_blank" rel="noreferrer">#14752</a>)</li></ul><h3 id="compile-commands" tabindex="-1">Compilation Database <a class="header-anchor" href="#compile-commands" aria-label="Permalink to "Compilation Database {#compile-commands}""></a></h3><p>A clang-compatible compilation database generator has been added as an option in order to help development environments such as Visual Studio Code.</p><p>Running <code>qmk generate-compilation-database -kb <yourkb> -km <yourkeymap></code> from within the QMK firmware directory will generate a <code>compile_commands.json</code> file -- using a compatible IDE will likely see this and correctly start detecting the correct locations for source files as well as type and function information that are relevant to your build.</p><p>Do note that switching keyboards will require re-generation of this file.</p><ul><li>New CLI subcommand to create clang-compatible compilation database (<code>compile_commands.json</code>) (<a href="https://github.com/qmk/qmk_firmware/pull/14370" target="_blank" rel="noreferrer">#14370</a>)</li><li>compiledb: query include paths from gcc directly. (<a href="https://github.com/qmk/qmk_firmware/pull/14462" target="_blank" rel="noreferrer">#14462</a>)</li></ul><h3 id="codebase-restructure" tabindex="-1">Codebase restructure and cleanup <a class="header-anchor" href="#codebase-restructure" aria-label="Permalink to "Codebase restructure and cleanup {#codebase-restructure}""></a></h3><p>QMK continues on its restructuring journey, in order to make it easier to integrate newer features and add support for new hardware. This quarter's batch of changes include:</p><ul><li>add 'include keyboard_features.mk' into build_keyboard.mk (<a href="https://github.com/qmk/qmk_firmware/pull/8422" target="_blank" rel="noreferrer">#8422</a>)</li><li>Infer more when building features (<a href="https://github.com/qmk/qmk_firmware/pull/13890" target="_blank" rel="noreferrer">#13890</a>)</li><li>Move <code>tmk_core/common/<plat></code> (<a href="https://github.com/qmk/qmk_firmware/pull/13918" target="_blank" rel="noreferrer">#13918</a>)</li><li>Move feature suspend logic out of platform specific code (<a href="https://github.com/qmk/qmk_firmware/pull/14210" target="_blank" rel="noreferrer">#14210</a>)</li><li>Remove bin/qmk (<a href="https://github.com/qmk/qmk_firmware/pull/14231" target="_blank" rel="noreferrer">#14231</a>)</li><li>Move Audio drivers from quantum to platform drivers folder (<a href="https://github.com/qmk/qmk_firmware/pull/14308" target="_blank" rel="noreferrer">#14308</a>)</li><li>Remove Arduino-style <code>analogRead()</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14348" target="_blank" rel="noreferrer">#14348</a>)</li><li>Remove unreferenced IBM4704, Sony NEWS, NeXT keyboard code. (<a href="https://github.com/qmk/qmk_firmware/pull/14380" target="_blank" rel="noreferrer">#14380</a>)</li><li>Move Bluetooth config to common_features.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14404" target="_blank" rel="noreferrer">#14404</a>)</li><li>Relocate Adafruit BLE code (<a href="https://github.com/qmk/qmk_firmware/pull/14530" target="_blank" rel="noreferrer">#14530</a>)</li><li>Change <code>MK66F18</code> -> <code>MK66FX1M0</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14659" target="_blank" rel="noreferrer">#14659</a>)</li><li>Remove sysex API (<a href="https://github.com/qmk/qmk_firmware/pull/14723" target="_blank" rel="noreferrer">#14723</a>)</li><li>Basic keycode overhaul (<a href="https://github.com/qmk/qmk_firmware/pull/14726" target="_blank" rel="noreferrer">#14726</a>)</li><li>Remove SERIAL_LINK feature (<a href="https://github.com/qmk/qmk_firmware/pull/14727" target="_blank" rel="noreferrer">#14727</a>)</li><li>Move converter specific tmk_core protocols (<a href="https://github.com/qmk/qmk_firmware/pull/14743" target="_blank" rel="noreferrer">#14743</a>)</li><li>Align PS/2 GPIO defines (<a href="https://github.com/qmk/qmk_firmware/pull/14745" target="_blank" rel="noreferrer">#14745</a>)</li><li>Clean up LED/RGB Matrix driver config (<a href="https://github.com/qmk/qmk_firmware/pull/14760" target="_blank" rel="noreferrer">#14760</a>)</li><li>Update UART driver API (<a href="https://github.com/qmk/qmk_firmware/pull/14839" target="_blank" rel="noreferrer">#14839</a>)</li><li>Tidy up LCD_ENABLE/visualizer references (<a href="https://github.com/qmk/qmk_firmware/pull/14855" target="_blank" rel="noreferrer">#14855</a>)</li><li>Remove legacy Makefile functionality (<a href="https://github.com/qmk/qmk_firmware/pull/14858" target="_blank" rel="noreferrer">#14858</a>)</li><li>Begin to carve out platform/protocol API - Migrate keyboard_* calls (<a href="https://github.com/qmk/qmk_firmware/pull/14888" target="_blank" rel="noreferrer">#14888</a>)</li><li>Rename platform SRC variable (<a href="https://github.com/qmk/qmk_firmware/pull/14894" target="_blank" rel="noreferrer">#14894</a>)</li><li>Relocate PS2 code (<a href="https://github.com/qmk/qmk_firmware/pull/14895" target="_blank" rel="noreferrer">#14895</a>)</li><li>Move USE_CCACHE logic to common location (<a href="https://github.com/qmk/qmk_firmware/pull/14899" target="_blank" rel="noreferrer">#14899</a>)</li><li>Migrate makefile utilities to sub-directory (<a href="https://github.com/qmk/qmk_firmware/pull/14917" target="_blank" rel="noreferrer">#14917</a>)</li><li>Remove SERIAL_MOUSE (<a href="https://github.com/qmk/qmk_firmware/pull/14969" target="_blank" rel="noreferrer">#14969</a>)</li><li>Relocate protocol files within tmk_core/common/ (<a href="https://github.com/qmk/qmk_firmware/pull/14972" target="_blank" rel="noreferrer">#14972</a>)</li><li>More platform/protocol alignment (<a href="https://github.com/qmk/qmk_firmware/pull/14976" target="_blank" rel="noreferrer">#14976</a>)</li><li>Fix uart function prototypes (<a href="https://github.com/qmk/qmk_firmware/pull/15162" target="_blank" rel="noreferrer">#15162</a>)</li><li>Remove deprecated KEYMAP alias (<a href="https://github.com/qmk/qmk_firmware/pull/15037" target="_blank" rel="noreferrer">#15037</a>)</li><li>Move non-assignment code to post_rules.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14207" target="_blank" rel="noreferrer">#14207</a>)</li><li>Helix use <code>post_rules.mk</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14216" target="_blank" rel="noreferrer">#14216</a>)</li><li>Make ChibiOS PAL interactions less STM32 specific - Round 2 (<a href="https://github.com/qmk/qmk_firmware/pull/14456" target="_blank" rel="noreferrer">#14456</a>)</li></ul><hr><h2 id="full-changelist" tabindex="-1">Full changelist <a class="header-anchor" href="#full-changelist" aria-label="Permalink to "Full changelist""></a></h2><p>Core:</p><ul><li>massdrop alt/ctrl: support saving into nvm (<a href="https://github.com/qmk/qmk_firmware/pull/6068" target="_blank" rel="noreferrer">#6068</a>)</li><li>Made AVR backlight pwm resolution configurable (<a href="https://github.com/qmk/qmk_firmware/pull/7521" target="_blank" rel="noreferrer">#7521</a>)</li><li>add 'include keyboard_features.mk' into build_keyboard.mk (<a href="https://github.com/qmk/qmk_firmware/pull/8422" target="_blank" rel="noreferrer">#8422</a>)</li><li>New feature: <code>DYNAMIC_TAPPING_TERM_ENABLE</code> (<a href="https://github.com/qmk/qmk_firmware/pull/11036" target="_blank" rel="noreferrer">#11036</a>)</li><li>Add Retro Shift (Auto Shift for Tap Hold via Retro Tapping) and Custom Auto Shifts (<a href="https://github.com/qmk/qmk_firmware/pull/11059" target="_blank" rel="noreferrer">#11059</a>)</li><li>Add support for RISC-V builds and GD32VF103 MCU (<a href="https://github.com/qmk/qmk_firmware/pull/12508" target="_blank" rel="noreferrer">#12508</a>)</li><li>Add Fractal RGB matrix effects (<a href="https://github.com/qmk/qmk_firmware/pull/12670" target="_blank" rel="noreferrer">#12670</a>)</li><li>Added power tracking api (<a href="https://github.com/qmk/qmk_firmware/pull/12691" target="_blank" rel="noreferrer">#12691</a>)</li><li>haptic: Feature to disable it when usb port is not configured or suspended. (<a href="https://github.com/qmk/qmk_firmware/pull/12692" target="_blank" rel="noreferrer">#12692</a>)</li><li>make the full 4096 bytes of EEPROM work on Teensy 3.6 (<a href="https://github.com/qmk/qmk_firmware/pull/12947" target="_blank" rel="noreferrer">#12947</a>)</li><li>Add Support for USB programmable buttons (<a href="https://github.com/qmk/qmk_firmware/pull/12950" target="_blank" rel="noreferrer">#12950</a>)</li><li>[Tests] Increase QMK test coverage (<a href="https://github.com/qmk/qmk_firmware/pull/13789" target="_blank" rel="noreferrer">#13789</a>)</li><li>Add support for ISSI drivers on both sides of a split keyboard (<a href="https://github.com/qmk/qmk_firmware/pull/13842" target="_blank" rel="noreferrer">#13842</a>)</li><li>Infer more when building features (<a href="https://github.com/qmk/qmk_firmware/pull/13890" target="_blank" rel="noreferrer">#13890</a>)</li><li>Reimplements WPM feature to be smaller & precise (<a href="https://github.com/qmk/qmk_firmware/pull/13902" target="_blank" rel="noreferrer">#13902</a>)</li><li>Move <code>tmk_core/common/<plat></code> (<a href="https://github.com/qmk/qmk_firmware/pull/13918" target="_blank" rel="noreferrer">#13918</a>)</li><li>Improvements to handling of disconnected split keyboards. (<a href="https://github.com/qmk/qmk_firmware/pull/14033" target="_blank" rel="noreferrer">#14033</a>)</li><li>Add Pixel Rain RGB Matrix effect (<a href="https://github.com/qmk/qmk_firmware/pull/14155" target="_blank" rel="noreferrer">#14155</a>)</li><li>Remove QWIIC_DRIVERS (<a href="https://github.com/qmk/qmk_firmware/pull/14174" target="_blank" rel="noreferrer">#14174</a>)</li><li>Add LM() keys to the list of keys disabled by NO_HAPTIC_MOD (<a href="https://github.com/qmk/qmk_firmware/pull/14181" target="_blank" rel="noreferrer">#14181</a>)</li><li>Implement F4 eeprom (<a href="https://github.com/qmk/qmk_firmware/pull/14195" target="_blank" rel="noreferrer">#14195</a>)</li><li>define to AUTO_SHIFT_DISABLED_AT_STARTUP (<a href="https://github.com/qmk/qmk_firmware/pull/14201" target="_blank" rel="noreferrer">#14201</a>)</li><li>Move feature suspend logic out of platform specific code (<a href="https://github.com/qmk/qmk_firmware/pull/14210" target="_blank" rel="noreferrer">#14210</a>)</li><li>Remove bin/qmk (<a href="https://github.com/qmk/qmk_firmware/pull/14231" target="_blank" rel="noreferrer">#14231</a>)</li><li>Change keyboard level include guards to <code>pragma once</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14248" target="_blank" rel="noreferrer">#14248</a>)</li><li>i2c_master: Add support for reading/writing to 16-bit registers (<a href="https://github.com/qmk/qmk_firmware/pull/14289" target="_blank" rel="noreferrer">#14289</a>)</li><li>Move Audio drivers from quantum to platform drivers folder (<a href="https://github.com/qmk/qmk_firmware/pull/14308" target="_blank" rel="noreferrer">#14308</a>)</li><li>Add RGBW support to PWM and SPI drivers for ChibiOS (<a href="https://github.com/qmk/qmk_firmware/pull/14327" target="_blank" rel="noreferrer">#14327</a>)</li><li>Rework and expand Pointing Device support (<a href="https://github.com/qmk/qmk_firmware/pull/14343" target="_blank" rel="noreferrer">#14343</a>)</li><li>Remove Arduino-style <code>analogRead()</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14348" target="_blank" rel="noreferrer">#14348</a>)</li><li>Macros in JSON keymaps (<a href="https://github.com/qmk/qmk_firmware/pull/14374" target="_blank" rel="noreferrer">#14374</a>)</li><li>Remove unreferenced IBM4704, Sony NEWS, NeXT keyboard code. (<a href="https://github.com/qmk/qmk_firmware/pull/14380" target="_blank" rel="noreferrer">#14380</a>)</li><li>Add HT32 support to core (<a href="https://github.com/qmk/qmk_firmware/pull/14388" target="_blank" rel="noreferrer">#14388</a>)</li><li>Align ChibiOS I2C defs with other drivers (<a href="https://github.com/qmk/qmk_firmware/pull/14399" target="_blank" rel="noreferrer">#14399</a>)</li><li>Move Bluetooth config to common_features.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14404" target="_blank" rel="noreferrer">#14404</a>)</li><li>Westberrytech pr (<a href="https://github.com/qmk/qmk_firmware/pull/14422" target="_blank" rel="noreferrer">#14422</a>)</li><li>Refactor use of STM32_SYSCLK (<a href="https://github.com/qmk/qmk_firmware/pull/14430" target="_blank" rel="noreferrer">#14430</a>)</li><li>Migrate STM32_EEPROM_ENABLE to use EEPROM_DRIVER (<a href="https://github.com/qmk/qmk_firmware/pull/14433" target="_blank" rel="noreferrer">#14433</a>)</li><li>Refactor use of <em>STM32</em> defines (<a href="https://github.com/qmk/qmk_firmware/pull/14439" target="_blank" rel="noreferrer">#14439</a>)</li><li>Add i2c defaults for Convert to Proton C (<a href="https://github.com/qmk/qmk_firmware/pull/14470" target="_blank" rel="noreferrer">#14470</a>)</li><li>Use opendrain pin with external pullup again (<a href="https://github.com/qmk/qmk_firmware/pull/14474" target="_blank" rel="noreferrer">#14474</a>)</li><li>Add ability to use numpad digits for unicode mode UC_WIN (<a href="https://github.com/qmk/qmk_firmware/pull/14496" target="_blank" rel="noreferrer">#14496</a>)</li><li>Enable de-ghosting for RGB/LED matrix on all ISSI LED drivers (<a href="https://github.com/qmk/qmk_firmware/pull/14508" target="_blank" rel="noreferrer">#14508</a>)</li><li>Relocate Adafruit BLE code (<a href="https://github.com/qmk/qmk_firmware/pull/14530" target="_blank" rel="noreferrer">#14530</a>)</li><li>Initial pass of F405 support (<a href="https://github.com/qmk/qmk_firmware/pull/14584" target="_blank" rel="noreferrer">#14584</a>)</li><li>Further tidy up of STM32 eeprom emulation (<a href="https://github.com/qmk/qmk_firmware/pull/14591" target="_blank" rel="noreferrer">#14591</a>)</li><li>Remove GCC version check from song list inclusion (<a href="https://github.com/qmk/qmk_firmware/pull/14600" target="_blank" rel="noreferrer">#14600</a>)</li><li>Change <code>MK66F18</code> -> <code>MK66FX1M0</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14659" target="_blank" rel="noreferrer">#14659</a>)</li><li>Add ifndef to WS2812 timing constraints (<a href="https://github.com/qmk/qmk_firmware/pull/14678" target="_blank" rel="noreferrer">#14678</a>)</li><li>Reuse of EEPROM debounce logic (<a href="https://github.com/qmk/qmk_firmware/pull/14699" target="_blank" rel="noreferrer">#14699</a>)</li><li>Remove sysex API (<a href="https://github.com/qmk/qmk_firmware/pull/14723" target="_blank" rel="noreferrer">#14723</a>)</li><li>Basic keycode overhaul (<a href="https://github.com/qmk/qmk_firmware/pull/14726" target="_blank" rel="noreferrer">#14726</a>)</li><li>Remove SERIAL_LINK feature (<a href="https://github.com/qmk/qmk_firmware/pull/14727" target="_blank" rel="noreferrer">#14727</a>)</li><li>Enable CLI flashing via mdloader (<a href="https://github.com/qmk/qmk_firmware/pull/14729" target="_blank" rel="noreferrer">#14729</a>)</li><li>Correct the Turkish F '?' keycode (TR_QUES) (<a href="https://github.com/qmk/qmk_firmware/pull/14740" target="_blank" rel="noreferrer">#14740</a>)</li><li>Move converter specific tmk_core protocols (<a href="https://github.com/qmk/qmk_firmware/pull/14743" target="_blank" rel="noreferrer">#14743</a>)</li><li>Align PS/2 GPIO defines (<a href="https://github.com/qmk/qmk_firmware/pull/14745" target="_blank" rel="noreferrer">#14745</a>)</li><li>Improve Adafruit BLE configuration defines (<a href="https://github.com/qmk/qmk_firmware/pull/14749" target="_blank" rel="noreferrer">#14749</a>)</li><li>Enable eeprom with F401xE ld (<a href="https://github.com/qmk/qmk_firmware/pull/14752" target="_blank" rel="noreferrer">#14752</a>)</li><li>Clean up LED/RGB Matrix driver config (<a href="https://github.com/qmk/qmk_firmware/pull/14760" target="_blank" rel="noreferrer">#14760</a>)</li><li>Initial USB2422 driver (<a href="https://github.com/qmk/qmk_firmware/pull/14835" target="_blank" rel="noreferrer">#14835</a>)</li><li>Update UART driver API (<a href="https://github.com/qmk/qmk_firmware/pull/14839" target="_blank" rel="noreferrer">#14839</a>)</li><li>Split out arm_atsam shift register logic (<a href="https://github.com/qmk/qmk_firmware/pull/14848" target="_blank" rel="noreferrer">#14848</a>)</li><li>Split out HAPTIC_ENABLE to have separate DRIVER option (<a href="https://github.com/qmk/qmk_firmware/pull/14854" target="_blank" rel="noreferrer">#14854</a>)</li><li>Tidy up LCD_ENABLE/visualizer references (<a href="https://github.com/qmk/qmk_firmware/pull/14855" target="_blank" rel="noreferrer">#14855</a>)</li><li>Remove legacy Makefile functionality (<a href="https://github.com/qmk/qmk_firmware/pull/14858" target="_blank" rel="noreferrer">#14858</a>)</li><li>Add support for deferred executors. (<a href="https://github.com/qmk/qmk_firmware/pull/14859" target="_blank" rel="noreferrer">#14859</a>)</li><li>Change OLED task function to be boolean (<a href="https://github.com/qmk/qmk_firmware/pull/14864" target="_blank" rel="noreferrer">#14864</a>)</li><li>Add a new led driver for Keychron's keyboards. (<a href="https://github.com/qmk/qmk_firmware/pull/14872" target="_blank" rel="noreferrer">#14872</a>)</li><li>Begin to carve out platform/protocol API - Migrate keyboard_* calls (<a href="https://github.com/qmk/qmk_firmware/pull/14888" target="_blank" rel="noreferrer">#14888</a>)</li><li>Rename platform SRC variable (<a href="https://github.com/qmk/qmk_firmware/pull/14894" target="_blank" rel="noreferrer">#14894</a>)</li><li>Relocate PS2 code (<a href="https://github.com/qmk/qmk_firmware/pull/14895" target="_blank" rel="noreferrer">#14895</a>)</li><li>Move USE_CCACHE logic to common location (<a href="https://github.com/qmk/qmk_firmware/pull/14899" target="_blank" rel="noreferrer">#14899</a>)</li><li>Migrate makefile utilities to sub-directory (<a href="https://github.com/qmk/qmk_firmware/pull/14917" target="_blank" rel="noreferrer">#14917</a>)</li><li>Remove legacy handling for ErgoDox Infinity handedness (<a href="https://github.com/qmk/qmk_firmware/pull/14919" target="_blank" rel="noreferrer">#14919</a>)</li><li>Align usbasp flashing behaviour (<a href="https://github.com/qmk/qmk_firmware/pull/14928" target="_blank" rel="noreferrer">#14928</a>)</li><li>Optimize matrix scanning by removing variable shifts (<a href="https://github.com/qmk/qmk_firmware/pull/14947" target="_blank" rel="noreferrer">#14947</a>)</li><li>Stop-gap forward-port Drop LED features for CTRL and ALT (<a href="https://github.com/qmk/qmk_firmware/pull/14967" target="_blank" rel="noreferrer">#14967</a>)</li><li>Remove SERIAL_MOUSE (<a href="https://github.com/qmk/qmk_firmware/pull/14969" target="_blank" rel="noreferrer">#14969</a>)</li><li>Relocate protocol files within tmk_core/common/ (<a href="https://github.com/qmk/qmk_firmware/pull/14972" target="_blank" rel="noreferrer">#14972</a>)</li><li>Move LTO logic from common.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14973" target="_blank" rel="noreferrer">#14973</a>)</li><li>More platform/protocol alignment (<a href="https://github.com/qmk/qmk_firmware/pull/14976" target="_blank" rel="noreferrer">#14976</a>)</li><li>Add support to persist MD LED framework settings (<a href="https://github.com/qmk/qmk_firmware/pull/14980" target="_blank" rel="noreferrer">#14980</a>)</li><li>Enable configuration of PWM frequency for IS31FL3733B (<a href="https://github.com/qmk/qmk_firmware/pull/14983" target="_blank" rel="noreferrer">#14983</a>)</li><li>Remove <code>BOOTMAGIC_ENABLE = lite</code> option (<a href="https://github.com/qmk/qmk_firmware/pull/15002" target="_blank" rel="noreferrer">#15002</a>)</li><li>Manually format develop (<a href="https://github.com/qmk/qmk_firmware/pull/15003" target="_blank" rel="noreferrer">#15003</a>)</li><li>Require explicit enabling of RGB Matrix modes (<a href="https://github.com/qmk/qmk_firmware/pull/15018" target="_blank" rel="noreferrer">#15018</a>)</li><li>Remove deprecated KEYMAP alias (<a href="https://github.com/qmk/qmk_firmware/pull/15037" target="_blank" rel="noreferrer">#15037</a>)</li><li>Fix uart function prototypes (<a href="https://github.com/qmk/qmk_firmware/pull/15162" target="_blank" rel="noreferrer">#15162</a>)</li><li>Rename RGB fractal (<a href="https://github.com/qmk/qmk_firmware/pull/15174" target="_blank" rel="noreferrer">#15174</a>)</li><li>Format code according to conventions (<a href="https://github.com/qmk/qmk_firmware/pull/15195" target="_blank" rel="noreferrer">#15195</a>)</li><li>Format code according to conventions (<a href="https://github.com/qmk/qmk_firmware/pull/15196" target="_blank" rel="noreferrer">#15196</a>)</li><li>Add uint to char functions (<a href="https://github.com/qmk/qmk_firmware/pull/15244" target="_blank" rel="noreferrer">#15244</a>)</li><li>[Tests] Increase QMK test coverage take 2 (<a href="https://github.com/qmk/qmk_firmware/pull/15269" target="_blank" rel="noreferrer">#15269</a>)</li><li>Tidy up adjustable ws2812 timing (<a href="https://github.com/qmk/qmk_firmware/pull/15299" target="_blank" rel="noreferrer">#15299</a>)</li><li>Add script for performing compilation size regression investigations. (<a href="https://github.com/qmk/qmk_firmware/pull/15303" target="_blank" rel="noreferrer">#15303</a>)</li><li>WB32F3G71 config migration with removal of unnecessary items. (<a href="https://github.com/qmk/qmk_firmware/pull/15309" target="_blank" rel="noreferrer">#15309</a>)</li><li>Re-add encoder tests (<a href="https://github.com/qmk/qmk_firmware/pull/15312" target="_blank" rel="noreferrer">#15312</a>)</li></ul><p>CLI:</p><ul><li>Add check for non-assignment code in rules.mk (<a href="https://github.com/qmk/qmk_firmware/pull/12108" target="_blank" rel="noreferrer">#12108</a>)</li><li>Export list of <code>develop</code> PRs to be merged into <code>master</code> (<a href="https://github.com/qmk/qmk_firmware/pull/13944" target="_blank" rel="noreferrer">#13944</a>)</li><li>remove qmk console, which is now part of the global cli (<a href="https://github.com/qmk/qmk_firmware/pull/14206" target="_blank" rel="noreferrer">#14206</a>)</li><li>New CLI subcommand to create clang-compatible compilation database (<code>compile_commands.json</code>) (<a href="https://github.com/qmk/qmk_firmware/pull/14370" target="_blank" rel="noreferrer">#14370</a>)</li><li>compiledb: query include paths from gcc directly. (<a href="https://github.com/qmk/qmk_firmware/pull/14462" target="_blank" rel="noreferrer">#14462</a>)</li></ul><p>Submodule updates:</p><ul><li>Update to ChibiOS 20.3.4, support builds against trunk (<a href="https://github.com/qmk/qmk_firmware/pull/14208" target="_blank" rel="noreferrer">#14208</a>)</li><li>Update ChibiOS-Contrib (<a href="https://github.com/qmk/qmk_firmware/pull/14408" target="_blank" rel="noreferrer">#14408</a>)</li><li>Update ChibiOS-Contrib (<a href="https://github.com/qmk/qmk_firmware/pull/14419" target="_blank" rel="noreferrer">#14419</a>)</li><li>Purge uGFX. (<a href="https://github.com/qmk/qmk_firmware/pull/14720" target="_blank" rel="noreferrer">#14720</a>)</li></ul><p>Keyboards:</p><ul><li>Add support for PaladinPad, Arya pcb and move keyboards by KapCave into their own directory (<a href="https://github.com/qmk/qmk_firmware/pull/14194" target="_blank" rel="noreferrer">#14194</a>)</li><li>Move non-assignment code to post_rules.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14207" target="_blank" rel="noreferrer">#14207</a>)</li><li>Helix use <code>post_rules.mk</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14216" target="_blank" rel="noreferrer">#14216</a>)</li><li>handwired/symmetric70_proto use post_rules.mk (<a href="https://github.com/qmk/qmk_firmware/pull/14235" target="_blank" rel="noreferrer">#14235</a>)</li><li>Add Adelais PCB. Adelais RGB rev.3, Adelais rev. 4 APM32F103, Adelais AVR rev. 1 (<a href="https://github.com/qmk/qmk_firmware/pull/14252" target="_blank" rel="noreferrer">#14252</a>)</li><li>GMMK Pro keymap (<a href="https://github.com/qmk/qmk_firmware/pull/14389" target="_blank" rel="noreferrer">#14389</a>)</li><li>Migrate boston_meetup/2019 away from QWIIC_DRIVERS (<a href="https://github.com/qmk/qmk_firmware/pull/14413" target="_blank" rel="noreferrer">#14413</a>)</li><li>Migrate hadron away from QWIIC_DRIVERS (<a href="https://github.com/qmk/qmk_firmware/pull/14415" target="_blank" rel="noreferrer">#14415</a>)</li><li>Enable Proton C defaults for SplitKB Kyria (<a href="https://github.com/qmk/qmk_firmware/pull/14490" target="_blank" rel="noreferrer">#14490</a>)</li><li>Set USB max power consumption of kint* controllers to 100mA (<a href="https://github.com/qmk/qmk_firmware/pull/14546" target="_blank" rel="noreferrer">#14546</a>)</li><li>Remove complex <code>fn_actions</code> macros (<a href="https://github.com/qmk/qmk_firmware/pull/14662" target="_blank" rel="noreferrer">#14662</a>)</li><li>New Keyboard: TGR Jane CE (<a href="https://github.com/qmk/qmk_firmware/pull/14713" target="_blank" rel="noreferrer">#14713</a>)</li><li>Migrate satisfaction75 away from QWIIC_DRIVERS (<a href="https://github.com/qmk/qmk_firmware/pull/14747" target="_blank" rel="noreferrer">#14747</a>)</li><li>add Lefty keyboard (<a href="https://github.com/qmk/qmk_firmware/pull/14898" target="_blank" rel="noreferrer">#14898</a>)</li><li>overnumpad controller: Add support for turning off solenoid enable in low power. (<a href="https://github.com/qmk/qmk_firmware/pull/15021" target="_blank" rel="noreferrer">#15021</a>)</li><li>Reduce compile size for melgeek mach80 (<a href="https://github.com/qmk/qmk_firmware/pull/15034" target="_blank" rel="noreferrer">#15034</a>)</li><li>Update updated KPrepublic boards to be prepared for the update (<a href="https://github.com/qmk/qmk_firmware/pull/15040" target="_blank" rel="noreferrer">#15040</a>)</li><li>rename kprepublic bm keyboards to have a standardized naming format (<a href="https://github.com/qmk/qmk_firmware/pull/15047" target="_blank" rel="noreferrer">#15047</a>)</li><li>matrix/abelx - Update ChibiOS conf files (<a href="https://github.com/qmk/qmk_firmware/pull/15130" target="_blank" rel="noreferrer">#15130</a>)</li><li>Disable console on Keebio foldkb and iris rev3 (<a href="https://github.com/qmk/qmk_firmware/pull/15260" target="_blank" rel="noreferrer">#15260</a>)</li><li>Disable console on Sofle default keymap (<a href="https://github.com/qmk/qmk_firmware/pull/15261" target="_blank" rel="noreferrer">#15261</a>)</li><li>Disable features on SplitKB boards to fit under size (<a href="https://github.com/qmk/qmk_firmware/pull/15262" target="_blank" rel="noreferrer">#15262</a>)</li><li>Enable LTO on viktus/sp_mini via keymap (<a href="https://github.com/qmk/qmk_firmware/pull/15263" target="_blank" rel="noreferrer">#15263</a>)</li></ul><p>Keyboard fixes:</p><ul><li>Fix number of elements in info.json does not match errors (<a href="https://github.com/qmk/qmk_firmware/pull/14213" target="_blank" rel="noreferrer">#14213</a>)</li><li>Fix typos from 14248 (<a href="https://github.com/qmk/qmk_firmware/pull/14261" target="_blank" rel="noreferrer">#14261</a>)</li><li>Stream cheap via fixes/updates (<a href="https://github.com/qmk/qmk_firmware/pull/14325" target="_blank" rel="noreferrer">#14325</a>)</li><li>Map <code>PRODUCT</code> define to <code>keyboard_name</code> (<a href="https://github.com/qmk/qmk_firmware/pull/14372" target="_blank" rel="noreferrer">#14372</a>)</li><li>Fix BT rules for dosa40rgb (<a href="https://github.com/qmk/qmk_firmware/pull/14497" target="_blank" rel="noreferrer">#14497</a>)</li><li>Fix typo in mechloving adelais header files (<a href="https://github.com/qmk/qmk_firmware/pull/14590" target="_blank" rel="noreferrer">#14590</a>)</li><li>Fix for mechlovin/adelais/standard_led/arm/rev4 (<a href="https://github.com/qmk/qmk_firmware/pull/14639" target="_blank" rel="noreferrer">#14639</a>)</li><li>Fix OLED timeout on recent qwiic migrations (<a href="https://github.com/qmk/qmk_firmware/pull/14775" target="_blank" rel="noreferrer">#14775</a>)</li><li>Fix OLED timeout on satisfaction75 after migration from QWIIC (<a href="https://github.com/qmk/qmk_firmware/pull/14780" target="_blank" rel="noreferrer">#14780</a>)</li><li>Fix Compile issues for lefty (<a href="https://github.com/qmk/qmk_firmware/pull/14982" target="_blank" rel="noreferrer">#14982</a>)</li><li>Fix missing return for oled task on Lefty (<a href="https://github.com/qmk/qmk_firmware/pull/15010" target="_blank" rel="noreferrer">#15010</a>)</li><li>Fix missing return for oled task on Arabica37 (<a href="https://github.com/qmk/qmk_firmware/pull/15011" target="_blank" rel="noreferrer">#15011</a>)</li><li>Fix missing return for oled task in drashna userspace (<a href="https://github.com/qmk/qmk_firmware/pull/15012" target="_blank" rel="noreferrer">#15012</a>)</li><li>Fix size issues on pistachio pro via keymap (<a href="https://github.com/qmk/qmk_firmware/pull/15017" target="_blank" rel="noreferrer">#15017</a>)</li><li>Fix keycode collision in craftwalk keymap (<a href="https://github.com/qmk/qmk_firmware/pull/15055" target="_blank" rel="noreferrer">#15055</a>)</li><li>Fix compilation issues for yanghu Unicorne (<a href="https://github.com/qmk/qmk_firmware/pull/15068" target="_blank" rel="noreferrer">#15068</a>)</li><li>Fixup broken build after #15040 (<a href="https://github.com/qmk/qmk_firmware/pull/15073" target="_blank" rel="noreferrer">#15073</a>)</li><li>Fix compilation issues for Lime (<a href="https://github.com/qmk/qmk_firmware/pull/15116" target="_blank" rel="noreferrer">#15116</a>)</li><li>Fix additional board sizes for RGB Matrix (<a href="https://github.com/qmk/qmk_firmware/pull/15170" target="_blank" rel="noreferrer">#15170</a>)</li><li>Fix bandominedoni via keymap compilation (<a href="https://github.com/qmk/qmk_firmware/pull/15171" target="_blank" rel="noreferrer">#15171</a>)</li><li>Fix handful of boards compiling too large due to RGB matrix changes (<a href="https://github.com/qmk/qmk_firmware/pull/15184" target="_blank" rel="noreferrer">#15184</a>)</li><li>Fix oled_task_user for ffkeebs/puca (<a href="https://github.com/qmk/qmk_firmware/pull/15185" target="_blank" rel="noreferrer">#15185</a>)</li><li>More headroom. (<a href="https://github.com/qmk/qmk_firmware/pull/15301" target="_blank" rel="noreferrer">#15301</a>)</li><li>More headroom. (<a href="https://github.com/qmk/qmk_firmware/pull/15302" target="_blank" rel="noreferrer">#15302</a>)</li></ul><p>Others:</p><ul><li>Clean up some code block languages (<a href="https://github.com/qmk/qmk_firmware/pull/14434" target="_blank" rel="noreferrer">#14434</a>)</li><li>Clarify "nested" and "rolling" key sequences (<a href="https://github.com/qmk/qmk_firmware/pull/14655" target="_blank" rel="noreferrer">#14655</a>)</li><li>CI: Create GitHub Actions unit test workflow (<a href="https://github.com/qmk/qmk_firmware/pull/15223" target="_blank" rel="noreferrer">#15223</a>)</li><li>Squeezing space out of AVR (<a href="https://github.com/qmk/qmk_firmware/pull/15243" target="_blank" rel="noreferrer">#15243</a>)</li></ul><p>Bugs:</p><ul><li>Fix parallel builds w/ LTO on systems where make is not GNU make. (<a href="https://github.com/qmk/qmk_firmware/pull/13955" target="_blank" rel="noreferrer">#13955</a>)</li><li>fix automatic directory for qmk lint (<a href="https://github.com/qmk/qmk_firmware/pull/14215" target="_blank" rel="noreferrer">#14215</a>)</li><li>RN42 Bluetooth typo fix (<a href="https://github.com/qmk/qmk_firmware/pull/14421" target="_blank" rel="noreferrer">#14421</a>)</li><li>fix typo in backlight code from #14439 (<a href="https://github.com/qmk/qmk_firmware/pull/14442" target="_blank" rel="noreferrer">#14442</a>)</li><li>fix compilation issues with USB programmable buttons (<a href="https://github.com/qmk/qmk_firmware/pull/14454" target="_blank" rel="noreferrer">#14454</a>)</li><li>Fix descriptor for USB Programmable Buttons (<a href="https://github.com/qmk/qmk_firmware/pull/14455" target="_blank" rel="noreferrer">#14455</a>)</li><li>Make ChibiOS PAL interactions less STM32 specific - Round 2 (<a href="https://github.com/qmk/qmk_firmware/pull/14456" target="_blank" rel="noreferrer">#14456</a>)</li><li>fix logical minimum in Programmable Button rdesc (<a href="https://github.com/qmk/qmk_firmware/pull/14464" target="_blank" rel="noreferrer">#14464</a>)</li><li>Fix i2c_readReg16 (<a href="https://github.com/qmk/qmk_firmware/pull/14730" target="_blank" rel="noreferrer">#14730</a>)</li><li>Put back eeconfig_update_ functions (<a href="https://github.com/qmk/qmk_firmware/pull/14751" target="_blank" rel="noreferrer">#14751</a>)</li><li>Fix misplaced endif in led_matrix_drivers.c (<a href="https://github.com/qmk/qmk_firmware/pull/14785" target="_blank" rel="noreferrer">#14785</a>)</li><li>Fix builds for ChibiOS + Cortex-M0[+] (<a href="https://github.com/qmk/qmk_firmware/pull/14879" target="_blank" rel="noreferrer">#14879</a>)</li><li>Fix ccache default (<a href="https://github.com/qmk/qmk_firmware/pull/14906" target="_blank" rel="noreferrer">#14906</a>)</li><li>Fix issues with Oneshot disabling (<a href="https://github.com/qmk/qmk_firmware/pull/14934" target="_blank" rel="noreferrer">#14934</a>)</li><li>Fix develop after recent changes (<a href="https://github.com/qmk/qmk_firmware/pull/14975" target="_blank" rel="noreferrer">#14975</a>)</li><li>Fix up issues shown by clang-format of vusb (<a href="https://github.com/qmk/qmk_firmware/pull/15004" target="_blank" rel="noreferrer">#15004</a>)</li><li>Fix unterminated ifdef in ISSI 3733 driver (<a href="https://github.com/qmk/qmk_firmware/pull/15014" target="_blank" rel="noreferrer">#15014</a>)</li><li>Fix build failures caused by #12947. (<a href="https://github.com/qmk/qmk_firmware/pull/15019" target="_blank" rel="noreferrer">#15019</a>)</li><li>Fixup LED matrix. (<a href="https://github.com/qmk/qmk_firmware/pull/15020" target="_blank" rel="noreferrer">#15020</a>)</li><li>Revert to old init order for host driver (<a href="https://github.com/qmk/qmk_firmware/pull/15029" target="_blank" rel="noreferrer">#15029</a>)</li><li>Fixup #15029 (<a href="https://github.com/qmk/qmk_firmware/pull/15031" target="_blank" rel="noreferrer">#15031</a>)</li><li>RISC-V toolchain and picolibc fixes (<a href="https://github.com/qmk/qmk_firmware/pull/15109" target="_blank" rel="noreferrer">#15109</a>)</li><li>gcc10 LTO - Only specify adhlns assembler options at link time (<a href="https://github.com/qmk/qmk_firmware/pull/15115" target="_blank" rel="noreferrer">#15115</a>)</li><li>Add needed include to pointing_device.c (<a href="https://github.com/qmk/qmk_firmware/pull/15167" target="_blank" rel="noreferrer">#15167</a>)</li><li>Fix missing variable for Backlight Breathing (<a href="https://github.com/qmk/qmk_firmware/pull/15199" target="_blank" rel="noreferrer">#15199</a>)</li><li>Revert backlight pins on function call (<a href="https://github.com/qmk/qmk_firmware/pull/15205" target="_blank" rel="noreferrer">#15205</a>)</li><li>Fix timer include in override_wiring.c (<a href="https://github.com/qmk/qmk_firmware/pull/15221" target="_blank" rel="noreferrer">#15221</a>)</li><li>fix broken macro in transport.h (<a href="https://github.com/qmk/qmk_firmware/pull/15239" target="_blank" rel="noreferrer">#15239</a>)</li><li>Short term bodge for PRODUCT warning (<a href="https://github.com/qmk/qmk_firmware/pull/15240" target="_blank" rel="noreferrer">#15240</a>)</li><li>Remove use of __flash due to LTO issues (<a href="https://github.com/qmk/qmk_firmware/pull/15268" target="_blank" rel="noreferrer">#15268</a>)</li><li>Documentation typo fix (<a href="https://github.com/qmk/qmk_firmware/pull/15298" target="_blank" rel="noreferrer">#15298</a>)</li><li>[Core] Hotfix for HOLD_ON_OTHER_KEY_PRESS after #11059 (<a href="https://github.com/qmk/qmk_firmware/pull/15307" target="_blank" rel="noreferrer">#15307</a>)</li><li>Fix call to pointing_device_handle_buttons (<a href="https://github.com/qmk/qmk_firmware/pull/15313" target="_blank" rel="noreferrer">#15313</a>)</li><li>[Develop] Fix ploopy readme typos (<a href="https://github.com/qmk/qmk_firmware/pull/15316" target="_blank" rel="noreferrer">#15316</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><!----></div><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link next" href="/newbs" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Next page</span><span class="title" data-v-09de1c0f>Introduction</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"changelog_20220226.md\":\"BWO5r_ec\",\"api_development_environment.md\":\"EhJClb9f\",\"drivers_adc.md\":\"DzU8txf8\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"drivers_apa102.md\":\"Cl7Xer3S\",\"changelog_20211127.md\":\"ClUawWkq\",\"configurator_architecture.md\":\"DEFTvTlS\",\"drivers_is31fl3737.md\":\"BgIEmU0V\",\"cli_commands.md\":\"DGx-qNiE\",\"features_auto_shift.md\":\"B9HLt3QM\",\"drivers_flash.md\":\"DhWcHp8S\",\"drivers_serial.md\":\"CnlLG_H1\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"feature_macros.md\":\"By1M5R8G\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"changelog_20210227.md\":\"BWOtCaeS\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"ref_functions.md\":\"BVI2uXSN\",\"reference_configurator_support.md\":\"FaBQzIj6\",\"reference_glossary.md\":\"CXMuxToT\",\"reference_info_json.md\":\"D2_8zSnw\",\"reference_keymap_extras.md\":\"D-__wuxf\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"config_options.md\":\"DvMeqlpB\",\"squeezing_avr.md\":\"BmcLYKOr\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"one_shot_keys.md\":\"QR09rSb-\",\"support.md\":\"Bj3JfaeV\",\"other_eclipse.md\":\"C-zqyJO9\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"syllabus.md\":\"B_ARGkLg\",\"other_vscode.md\":\"Di3vOySR\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"features_unicode.md\":\"CsON-fJH\",\"features_wpm.md\":\"BYf-Xc1H\",\"flashing.md\":\"BSZF2RCy\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"getting_started_github.md\":\"OYq7IT7B\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"getting_started_introduction.md\":\"BOJreqSs\",\"porting_your_keyboard_to_qmk.md\":\"CIbOxKQC\",\"pr_checklist.md\":\"9utxnOgJ\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"changelog_20221126.md\":\"DpbrnXeC\",\"newbs_flashing.md\":\"u-7lrNOy\",\"features_bluetooth.md\":\"CiAjl875\",\"changelog_20230827.md\":\"NSPhmB6l\",\"getting_started_make_guide.md\":\"BjUuEnSh\",\"hand_wire.md\":\"GiNX60kU\",\"hardware_drivers.md\":\"BUnx48D9\",\"drivers_is31fl3236.md\":\"BsbsN_Nu\",\"features_key_lock.md\":\"IjFq9dYs\",\"feature_userspace.md\":\"BsmY9yWw\",\"features_leader_key.md\":\"DBQTnBRh\",\"index.md\":\"BFvlZFTs\",\"isp_flashing_guide.md\":\"BiuBpOKX\",\"keycodes.md\":\"CDjPwWHi\",\"newbs_building_firmware_workflow.md\":\"DpLVwA7x\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"drivers_is31fl3741.md\":\"DzsuNWJt\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"api_overview.md\":\"0FPaUsMb\",\"drivers_gpio.md\":\"C5PvyJVh\",\"features_programmable_button.md\":\"D332w_PT\",\"changelog_20230528.md\":\"nX9R48zP\",\"changelog_20240225.md\":\"B4-WrXj6\",\"cli.md\":\"BLzAdA6l\",\"drivers_is31fl3746a.md\":\"BFczK5c-\",\"quantum_painter_qff.md\":\"kLNwshez\",\"api_docs.md\":\"CRoD6CbL\",\"features_ps2_mouse.md\":\"CL_pA9sk\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3BRmm\",\"newbs_git_using_your_master_branch.md\":\"B9DxZCl8\",\"data_driven_config.md\":\"BvLQ7P20\",\"features_rawhid.md\":\"bKKG3KCa\",\"changelog_20200829.md\":\"CoqrOffn\",\"drivers_audio.md\":\"mqaz6p5N\",\"custom_matrix.md\":\"DMnRw_5l\",\"features_rgblight.md\":\"O1OG9fO_\",\"features_repeat_key.md\":\"2ulQYjgy\",\"changelog_20220827.md\":\"DjPthqDk\",\"features_key_overrides.md\":\"C02U5_E5\",\"hardware_keyboard_guidelines.md\":\"CJevsanE\",\"drivers_is31fl3731.md\":\"_mTT68lh\",\"keycodes_basic.md\":\"CHIeCvwn\",\"changelog_20240526.md\":\"DAmAEDG5\",\"api_development_overview.md\":\"Dcey4ntL\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"changelog_20210828.md\":\"DNbHIuuM\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"arm_debugging.md\":\"BH-H2Ukz\",\"features_sequencer.md\":\"DkgqNCsQ\",\"features_stenography.md\":\"Bb_IhUGl\",\"features_combo.md\":\"C-GfDyXJ\",\"features_space_cadet.md\":\"DmNfYRVJ\",\"documentation_templates.md\":\"Bhkum0wD\",\"tap_hold.md\":\"DD8WTSla\",\"changelog_20201128.md\":\"7XXL02Bn\",\"breaking_changes.md\":\"y7zfo29K\",\"newbs_getting_started.md\":\"DD4a5qPC\",\"faq_general.md\":\"BOlGsWSk\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"drivers_eeprom.md\":\"DMr_G_5d\",\"breaking_changes_history.md\":\"CJNU0o77\",\"feature_layers.md\":\"8GwBUTZN\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"features_backlight.md\":\"D7R4FkYo\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"drivers_is31fl3218.md\":\"C7Rok4l6\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"keycodes_magic.md\":\"CGO3hgMm\",\"drivers_i2c.md\":\"Cuj87reB\",\"drivers_aw20216s.md\":\"CgKehEzB\",\"features_joystick.md\":\"CW0gZHec\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_led_matrix.md\":\"BTOvgNVe\",\"features_led_indicators.md\":\"BI857zKH\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_mouse_keys.md\":\"DIChRnuA\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_encoders.md\":\"BY--6WYQ\",\"features_midi.md\":\"u3tHPteB\",\"features_oled_driver.md\":\"D9wJVdL1\",\"features_audio.md\":\"DWNYte3W\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"keymap.md\":\"Y4Fei1Ty\",\"capabilities.md\":\"DgKwcj5n\",\"changelog_20240825.md\":\"DV_RdVWK\",\"mod_tap.md\":\"C7wRKLcf\",\"understanding_qmk.md\":\"f-Bc_eHQ\",\"newbs.md\":\"-YYNd3dT\",\"newbs_building_firmware.md\":\"DnVUK9it\",\"cli_development.md\":\"3xFA2OvS\",\"features_caps_word.md\":\"BDQGM0-x\",\"keycodes_us_ansi_shifted.md\":\"Cs78SDfM\",\"unit_testing.md\":\"u3fgbGUj\",\"features_split_keyboard.md\":\"C-blnyD_\",\"contributing.md\":\"CgMx5YLW\",\"features_rgb_matrix.md\":\"BE6vKO90\",\"features_secure.md\":\"BX7jFvW5\",\"newbs_learn_more_resources.md\":\"Dj1s2BDG\",\"newbs_external_userspace.md\":\"pD9Lc-a5\",\"features_st7565.md\":\"MoajNurJ\",\"features_autocorrect.md\":\"DHRDcuho\",\"capabilities_inc.md\":\"Ca9zpMce\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"features_pointing_device.md\":\"DP6-XwL6\",\"newbs_git_resynchronize_a_branch.md\":\"YGDefQFx\",\"feature_eeprom.md\":\"a0eoTZm7\",\"drivers_is31fl3733.md\":\"B2SurzgJ\",\"changelog_20200229.md\":\"DNsowwM1\",\"drivers_is31fl3736.md\":\"Cr5SQU0k\",\"breaking_changes_instructions.md\":\"C99NYDjO\",\"drivers_is31fl3729.md\":\"uZAm-59P\",\"feature_converters.md\":\"DcwmzUcD\",\"drivers_is31fl3742a.md\":\"CKPjB5T1\",\"drivers_is31fl3743a.md\":\"9TiNS_bm\",\"drivers_is31fl3745.md\":\"CpCpR0Np\",\"feature_layouts.md\":\"qcy8hNMO\",\"cli_configuration.md\":\"CGSB128P\",\"drivers_spi.md\":\"tJVeIT7e\",\"features_command.md\":\"Byl9YoT7\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"features_hd44780.md\":\"15K40o_e\",\"features_os_detection.md\":\"DZKTWvSd\",\"features_tri_layer.md\":\"DdnBVinw\",\"features_send_string.md\":\"vM68un4v\",\"faq_build.md\":\"DL_WezA1\",\"features_swap_hands.md\":\"DOhgGQf9\",\"drivers_snled27351.md\":\"Cq725B0_\",\"drivers_uart.md\":\"BNBs-m3h\",\"easy_maker.md\":\"DAfbIK4w\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"faq_misc.md\":\"qGrhOTu4\",\"faq_keymap.md\":\"BsEmEZTo\",\"faq_debug.md\":\"DuThValw\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"custom_quantum_functions.md\":\"Br1xUGGa\",\"quantum_painter.md\":\"BK_I9g4h\",\"features_tap_dance.md\":\"Bfnmm10t\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"QMK Firmware\",\"description\":\"Documentation for QMK Firmware\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":{\"light\":\"/qmk-logo-light.svg\",\"dark\":\"/qmk-logo-dark.svg\"},\"title\":\"QMK Firmware\",\"nav\":[{\"text\":\"Home\",\"link\":\"/\"}],\"search\":{\"provider\":\"local\"},\"sidebar\":[{\"text\":\"Tutorial\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/newbs\"},{\"text\":\"Setup\",\"link\":\"/newbs_getting_started\"},{\"text\":\"Building Your First Firmware\",\"link\":\"/newbs_building_firmware\"},{\"text\":\"Flashing Firmware\",\"link\":\"/newbs_flashing\"},{\"text\":\"Getting Help/Support\",\"link\":\"/support\"},{\"text\":\"External Userspace\",\"link\":\"/newbs_external_userspace\"},{\"text\":\"Other Resources\",\"link\":\"/newbs_learn_more_resources\"},{\"text\":\"Syllabus\",\"link\":\"/syllabus\"}]},{\"text\":\"FAQs\",\"items\":[{\"text\":\"General FAQ\",\"link\":\"/faq_general\"},{\"text\":\"Build/Compile QMK\",\"link\":\"/faq_build\"},{\"text\":\"Troubleshooting QMK\",\"link\":\"/faq_misc\"},{\"text\":\"Debugging QMK\",\"link\":\"/faq_debug\"},{\"text\":\"Keymap FAQ\",\"link\":\"/faq_keymap\"},{\"text\":\"Squeezing Space from AVR\",\"link\":\"/squeezing_avr\"},{\"text\":\"Glossary\",\"link\":\"/reference_glossary\"}]},{\"text\":\"Configurator\",\"items\":[{\"text\":\"Overview\",\"link\":\"/newbs_building_firmware_configurator\"},{\"text\":\"Step by Step\",\"link\":\"/configurator_step_by_step\"},{\"text\":\"Troubleshooting\",\"link\":\"/configurator_troubleshooting\"},{\"text\":\"Architecture\",\"link\":\"/configurator_architecture\"},{\"text\":\"QMK API\",\"items\":[{\"text\":\"Overview\",\"link\":\"/api_overview\"},{\"text\":\"API Documentation\",\"link\":\"/api_docs\"},{\"text\":\"Keyboard Support\",\"link\":\"/reference_configurator_support\"},{\"text\":\"Adding Default Keymaps\",\"link\":\"/configurator_default_keymaps\"}]}]},{\"text\":\"CLI\",\"items\":[{\"text\":\"Overview\",\"link\":\"/cli\"},{\"text\":\"Configuration\",\"link\":\"/cli_configuration\"},{\"text\":\"Commands\",\"link\":\"/cli_commands\"},{\"text\":\"Tab Completion\",\"link\":\"/cli_tab_complete\"}]},{\"text\":\"Using QMK\",\"items\":[{\"text\":\"Guides\",\"items\":[{\"text\":\"Customizing Functionality\",\"link\":\"/custom_quantum_functions\"},{\"text\":\"Driver Installation with Zadig\",\"link\":\"/driver_installation_zadig\"},{\"text\":\"Keymap Overview\",\"link\":\"/keymap\"},{\"text\":\"Development Environments\",\"items\":[{\"text\":\"Docker Guide\",\"link\":\"/getting_started_docker\"}]},{\"text\":\"Flashing\",\"link\":\"/flashing\"},{\"text\":\"IDEs\",\"items\":[{\"text\":\"Using Eclipse with QMK\",\"link\":\"/other_eclipse\"},{\"text\":\"Using VSCode with QMK\",\"link\":\"/other_vscode\"}]},{\"text\":\"Git Best Practices\",\"items\":[{\"text\":\"Introduction\",\"link\":\"/newbs_git_best_practices\"},{\"text\":\"Your Fork\",\"link\":\"/newbs_git_using_your_master_branch\"},{\"text\":\"Merge Conflicts\",\"link\":\"/newbs_git_resolving_merge_conflicts\"},{\"text\":\"Fixing Your Branch\",\"link\":\"/newbs_git_resynchronize_a_branch\"}]}]},{\"text\":\"Simple Keycodes\",\"items\":[{\"text\":\"Full List\",\"link\":\"/keycodes\"},{\"text\":\"Basic Keycodes\",\"link\":\"/keycodes_basic\"},{\"text\":\"Language-Specific Keycodes\",\"link\":\"/reference_keymap_extras\"},{\"text\":\"Modifier Keys\",\"link\":\"/feature_advanced_keycodes\"},{\"text\":\"Quantum Keycodes\",\"link\":\"/quantum_keycodes\"},{\"text\":\"Magic Keycodes\",\"link\":\"/keycodes_magic\"}]},{\"text\":\"Advanced Keycodes\",\"items\":[{\"text\":\"Command\",\"link\":\"/features/command\"},{\"text\":\"Dynamic Macros\",\"link\":\"/features/dynamic_macros\"},{\"text\":\"Grave Escape\",\"link\":\"/features/grave_esc\"},{\"text\":\"Leader Key\",\"link\":\"/features/leader_key\"},{\"text\":\"Mod-Tap\",\"link\":\"/mod_tap\"},{\"text\":\"Macros\",\"link\":\"/feature_macros\"},{\"text\":\"Mouse Keys\",\"link\":\"/features/mouse_keys\"},{\"text\":\"Programmable Button\",\"link\":\"/features/programmable_button\"},{\"text\":\"Repeat Key\",\"link\":\"/features/repeat_key\"},{\"text\":\"Space Cadet Shift\",\"link\":\"/features/space_cadet\"},{\"text\":\"US ANSI Shifted Keys\",\"link\":\"/keycodes_us_ansi_shifted\"}]},{\"text\":\"Software Features\",\"items\":[{\"text\":\"Auto Shift\",\"link\":\"/features/auto_shift\"},{\"text\":\"Autocorrect\",\"link\":\"/features/autocorrect\"},{\"text\":\"Caps Word\",\"link\":\"/features/caps_word\"},{\"text\":\"Combos\",\"link\":\"/features/combo\"},{\"text\":\"Debounce API\",\"link\":\"/feature_debounce_type\"},{\"text\":\"Digitizer\",\"link\":\"/features/digitizer\"},{\"text\":\"EEPROM\",\"link\":\"/feature_eeprom\"},{\"text\":\"Key Lock\",\"link\":\"/features/key_lock\"},{\"text\":\"Key Overrides\",\"link\":\"/features/key_overrides\"},{\"text\":\"Layers\",\"link\":\"/feature_layers\"},{\"text\":\"One Shot Keys\",\"link\":\"/one_shot_keys\"},{\"text\":\"OS Detection\",\"link\":\"/features/os_detection\"},{\"text\":\"Raw HID\",\"link\":\"/features/rawhid\"},{\"text\":\"Secure\",\"link\":\"/features/secure\"},{\"text\":\"Send String\",\"link\":\"/features/send_string\"},{\"text\":\"Sequencer\",\"link\":\"/features/sequencer\"},{\"text\":\"Swap Hands\",\"link\":\"/features/swap_hands\"},{\"text\":\"Tap Dance\",\"link\":\"/features/tap_dance\"},{\"text\":\"Tap-Hold Configuration\",\"link\":\"/tap_hold\"},{\"text\":\"Tri Layer\",\"link\":\"/features/tri_layer\"},{\"text\":\"Unicode\",\"link\":\"/features/unicode\"},{\"text\":\"Userspace\",\"link\":\"/feature_userspace\"},{\"text\":\"WPM Calculation\",\"link\":\"/features/wpm\"}]},{\"text\":\"Hardware Features\",\"items\":[{\"text\":\"Displays\",\"items\":[{\"text\":\"Quantum Painter\",\"link\":\"quantum_painter\",\"items\":[{\"text\":\"Quantum Painter LVGL Integration\",\"link\":\"/quantum_painter_lvgl\"}]},{\"text\":\"HD44780 LCD Driver\",\"link\":\"/features/hd44780\"},{\"text\":\"ST7565 LCD Driver\",\"link\":\"/features/st7565\"},{\"text\":\"OLED Driver\",\"link\":\"/features/oled_driver\"}]},{\"text\":\"Lighting\",\"items\":[{\"text\":\"Backlight\",\"link\":\"/features/backlight\"},{\"text\":\"LED Matrix\",\"link\":\"/features/led_matrix\"},{\"text\":\"RGB Lighting\",\"link\":\"/features/rgblight\"},{\"text\":\"RGB Matrix\",\"link\":\"/features/rgb_matrix\"}]},{\"text\":\"Audio\",\"link\":\"/features/audio\"},{\"text\":\"Bluetooth\",\"link\":\"/features/bluetooth\"},{\"text\":\"Bootmagic Lite\",\"link\":\"/features/bootmagic\"},{\"text\":\"Converters\",\"link\":\"/feature_converters\"},{\"text\":\"Custom Matrix\",\"link\":\"/custom_matrix\"},{\"text\":\"DIP Switch\",\"link\":\"/features/dip_switch\"},{\"text\":\"Encoders\",\"link\":\"/features/encoders\"},{\"text\":\"Haptic Feedback\",\"link\":\"/features/haptic_feedback\"},{\"text\":\"Joystick\",\"link\":\"/features/joystick\"},{\"text\":\"LED Indicators\",\"link\":\"/features/led_indicators\"},{\"text\":\"MIDI\",\"link\":\"/features/midi\"},{\"text\":\"Pointing Device\",\"link\":\"/features/pointing_device\"},{\"text\":\"PS/2 Mouse\",\"link\":\"/features/ps2_mouse\"},{\"text\":\"Split Keyboard\",\"link\":\"/features/split_keyboard\"},{\"text\":\"Stenography\",\"link\":\"/features/stenography\"}]},{\"text\":\"Keyboard Building\",\"items\":[{\"text\":\"Easy Maker for One Offs\",\"link\":\"/easy_maker\"},{\"text\":\"Porting Keyboards\",\"link\":\"/porting_your_keyboard_to_qmk\"},{\"text\":\"Hand Wiring Guide\",\"link\":\"/hand_wire\"},{\"text\":\"ISP Flashing Guide\",\"link\":\"/isp_flashing_guide\"}]}]},{\"text\":\"Developing QMK\",\"items\":[{\"text\":\"PR Checklist\",\"link\":\"/pr_checklist\"},{\"text\":\"Breaking Changes\",\"items\":[{\"text\":\"Overview\",\"link\":\"/breaking_changes\"},{\"text\":\"My Pull Request Was Flagged\",\"link\":\"/breaking_changes_instructions\"},{\"text\":\"Most Recent ChangeLog\",\"link\":\"/ChangeLog/20240825\"},{\"text\":\"Past Breaking Changes\",\"link\":\"/breaking_changes_history\"},{\"text\":\"Deprecation Policy\",\"link\":\"/support_deprecation_policy\"}]},{\"text\":\"C Development\",\"items\":[{\"text\":\"ARM Debugging Guide\",\"link\":\"/arm_debugging\"},{\"text\":\"Coding Conventions\",\"link\":\"/coding_conventions_c\"},{\"text\":\"Compatible Microcontrollers\",\"link\":\"/compatible_microcontrollers\"},{\"text\":\"Drivers\",\"link\":\"hardware_drivers\",\"items\":[{\"text\":\"ADC Driver\",\"link\":\"/drivers/adc\"},{\"text\":\"APA102 Driver\",\"link\":\"/drivers/apa102\"},{\"text\":\"Audio Driver\",\"link\":\"/drivers/audio\"},{\"text\":\"EEPROM Driver\",\"link\":\"/drivers/eeprom\"},{\"text\":\"Flash Driver\",\"link\":\"/drivers/flash\"},{\"text\":\"I2C Driver\",\"link\":\"/drivers/i2c\"},{\"text\":\"'serial' Driver\",\"link\":\"/drivers/serial\"},{\"text\":\"SPI Driver\",\"link\":\"/drivers/spi\"},{\"text\":\"UART Driver\",\"link\":\"/drivers/uart\"},{\"text\":\"WS2812 Driver\",\"link\":\"/drivers/ws2812\"}]},{\"text\":\"GPIO Controls\",\"link\":\"/drivers/gpio\"},{\"text\":\"Keyboard Guidelines\",\"link\":\"/hardware_keyboard_guidelines\"}]},{\"text\":\"Python Development\",\"items\":[{\"text\":\"Coding Conventions\",\"link\":\"/coding_conventions_python\"},{\"text\":\"QMK CLI Development\",\"link\":\"/cli_development\"}]},{\"text\":\"Configurator Development\",\"items\":[{\"text\":\"QMK API\",\"items\":[{\"text\":\"Development Environment\",\"link\":\"/api_development_environment\"},{\"text\":\"Architecture Overview\",\"link\":\"/api_development_overview\"}]}]},{\"text\":\"Hardware Platform Development\",\"items\":[{\"text\":\"Arm/ChibiOS\",\"items\":[{\"text\":\"Selecting an MCU\",\"link\":\"/platformdev_selecting_arm_mcu\"},{\"text\":\"Early initialization\",\"link\":\"/platformdev_chibios_earlyinit\"},{\"text\":\"Raspberry Pi RP2040\",\"link\":\"/platformdev_rp2040\"},{\"text\":\"Proton C\",\"link\":\"/platformdev_proton_c\"},{\"text\":\"WeAct Blackpill F4x1\",\"link\":\"/platformdev_blackpill_f4x1\"}]}]},{\"text\":\"QMK Reference\",\"items\":[{\"text\":\"Contributing to QMK\",\"link\":\"/contributing\"},{\"text\":\"Config Options\",\"link\":\"/config_options\"},{\"text\":\"Data Driven Configuration\",\"link\":\"/data_driven_config\"},{\"text\":\"Make Documentation\",\"link\":\"/getting_started_make_guide\"},{\"text\":\"Documentation Best Practices\",\"link\":\"/documentation_best_practices\"},{\"text\":\"Documentation Templates\",\"link\":\"/documentation_templates\"},{\"text\":\"Community Layouts\",\"link\":\"/feature_layouts\"},{\"text\":\"Unit Testing\",\"link\":\"/unit_testing\"},{\"text\":\"Useful Functions\",\"link\":\"/ref_functions\"},{\"text\":\"info.json Format\",\"link\":\"/reference_info_json\"}]},{\"text\":\"For a Deeper Understanding\",\"items\":[{\"text\":\"How Keyboards Work\",\"link\":\"/how_keyboards_work\"},{\"text\":\"How a Matrix Works\",\"link\":\"/how_a_matrix_works\"},{\"text\":\"Understanding QMK\",\"link\":\"/understanding_qmk\"}]}]}],\"socialLinks\":[{\"icon\":{\"svg\":\"<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.84375 C 30.738281 3.375 29.9375 3 29 3 Z M 41 5 C 42.667969 5 44 6.332031 44 8 C 44 9.667969 42.667969 11 41 11 C 39.332031 11 38 9.667969 38 8 C 38 6.332031 39.332031 5 41 5 Z M 25 15 C 30.609375 15 35.675781 16.613281 39.28125 19.1875 C 42.886719 21.761719 45 25.226563 45 29 C 45 32.773438 42.886719 36.238281 39.28125 38.8125 C 35.675781 41.386719 30.609375 43 25 43 C 19.390625 43 14.324219 41.386719 10.71875 38.8125 C 7.113281 36.238281 5 32.773438 5 29 C 5 25.226563 7.113281 21.761719 10.71875 19.1875 C 14.324219 16.613281 19.390625 15 25 15 Z M 7.5 16.9375 C 8.203125 16.9375 8.914063 17.148438 9.53125 17.59375 C 7.527344 19.03125 5.886719 20.769531 4.75 22.71875 C 3.582031 21.296875 3.660156 19.339844 5 18 C 5.714844 17.285156 6.609375 16.9375 7.5 16.9375 Z M 42.5 16.9375 C 43.390625 16.9375 44.285156 17.285156 45 18 C 46.339844 19.339844 46.417969 21.296875 45.25 22.71875 C 44.113281 20.769531 42.472656 19.03125 40.46875 17.59375 C 41.085938 17.148438 41.796875 16.9375 42.5 16.9375 Z M 17 22 C 14.800781 22 13 23.800781 13 26 C 13 28.199219 14.800781 30 17 30 C 19.199219 30 21 28.199219 21 26 C 21 23.800781 19.199219 22 17 22 Z M 33 22 C 30.800781 22 29 23.800781 29 26 C 29 28.199219 30.800781 30 33 30 C 35.199219 30 37 28.199219 37 26 C 37 23.800781 35.199219 22 33 22 Z M 17 24 C 18.117188 24 19 24.882813 19 26 C 19 27.117188 18.117188 28 17 28 C 15.882813 28 15 27.117188 15 26 C 15 24.882813 15.882813 24 17 24 Z M 33 24 C 34.117188 24 35 24.882813 35 26 C 35 27.117188 34.117188 28 33 28 C 31.882813 28 31 27.117188 31 26 C 31 24.882813 31.882813 24 33 24 Z M 34.15625 33.84375 C 34.101563 33.851563 34.050781 33.859375 34 33.875 C 33.683594 33.9375 33.417969 34.144531 33.28125 34.4375 C 33.28125 34.4375 32.757813 35.164063 31.4375 36 C 30.117188 36.835938 28.058594 37.6875 25 37.6875 C 21.941406 37.6875 19.882813 36.835938 18.5625 36 C 17.242188 35.164063 16.71875 34.4375 16.71875 34.4375 C 16.492188 34.082031 16.066406 33.90625 15.65625 34 C 15.332031 34.082031 15.070313 34.316406 14.957031 34.632813 C 14.84375 34.945313 14.894531 35.292969 15.09375 35.5625 C 15.09375 35.5625 15.863281 36.671875 17.46875 37.6875 C 19.074219 38.703125 21.558594 39.6875 25 39.6875 C 28.441406 39.6875 30.925781 38.703125 32.53125 37.6875 C 34.136719 36.671875 34.90625 35.5625 34.90625 35.5625 C 35.207031 35.273438 35.296875 34.824219 35.128906 34.441406 C 34.960938 34.058594 34.574219 33.820313 34.15625 33.84375 Z\\\"/></svg>\"},\"link\":\"https://reddit.com/r/olkb\"},{\"icon\":\"discord\",\"link\":\"https://discord.gg/qmk\"},{\"icon\":\"github\",\"link\":\"https://github.com/qmk/qmk_firmware\"}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":true}");</script>
|
||
|
||
</body>
|
||
</html> |