qmk_firmware/ChangeLog/20231126.html

30 lines
145 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>QMK Breaking Changes - 2023 November 26 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.Blu7LvN2.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.BR6AtNKq.js">
<link rel="modulepreload" href="/assets/ChangeLog_20231126.md.D2Ok5QAf.lean.js">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-5d98c3a5><!--[--><!--]--><!--[--><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><!--]--><!----><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar has-sidebar top" data-v-ae24b3ad data-v-ccf7ddec><div class="wrapper" data-v-ccf7ddec><div class="container" data-v-ccf7ddec><div class="title" data-v-ccf7ddec><div class="VPNavBarTitle has-sidebar" data-v-ccf7ddec data-v-ab179fa1><a class="title" href="/" data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><div class="content" data-v-ccf7ddec><div class="content-body" data-v-ccf7ddec><!--[--><!--]--><div class="VPNavBarSearch search" data-v-ccf7ddec><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-ccf7ddec data-v-7f418b0f><span id="main-nav-aria-label" class="visually-hidden" data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="./" tabindex="0" data-v-7f418b0f data-v-9c663999><!--[--><span data-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-ccf7ddec data-v-e6aabb21><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title="Switch to dark theme" aria-checked="false" data-v-e6aabb21 data-v-d1f28634 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><!--[--><span class="vpi-sun sun" data-v-d1f28634></span><span class="vpi-moon moon" data-v-d1f28634></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-ccf7ddec data-v-0394ad82 data-v-7bc22406><!--[--><a class="VPSocialLink no-icon" href="https://reddit.com/r/olkb" aria-label target="_blank" rel="noopener" data-v-7bc22406 data-v-eee4e7cb><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 50 50" width="50px" height="50px"><path d="M 29 3 C 28.0625 3 27.164063 3.382813 26.5 4 C 25.835938 4.617188 25.363281 5.433594 25 6.40625 C 24.355469 8.140625 24.085938 10.394531 24.03125 13.03125 C 19.234375 13.179688 14.820313 14.421875 11.28125 16.46875 C 10.214844 15.46875 8.855469 14.96875 7.5 14.96875 C 6.089844 14.96875 4.675781 15.511719 3.59375 16.59375 C 1.425781 18.761719 1.425781 22.238281 3.59375 24.40625 L 3.84375 24.65625 C 3.3125 26.035156 3 27.488281 3 29 C 3 33.527344 5.566406 37.585938 9.5625 40.4375 C 13.558594 43.289063 19.007813 45 25 45 C 30.992188 45 36.441406 43.289063 40.4375 40.4375 C 44.433594 37.585938 47 33.527344 47 29 C 47 27.488281 46.6875 26.035156 46.15625 24.65625 L 46.40625 24.40625 C 48.574219 22.238281 48.574219 18.761719 46.40625 16.59375 C 45.324219 15.511719 43.910156 14.96875 42.5 14.96875 C 41.144531 14.96875 39.785156 15.46875 38.71875 16.46875 C 35.195313 14.433594 30.800781 13.191406 26.03125 13.03125 C 26.09375 10.546875 26.363281 8.46875 26.875 7.09375 C 27.164063 6.316406 27.527344 5.757813 27.875 5.4375 C 28.222656 5.117188 28.539063 5 29 5 C 29.460938 5 29.683594 5.125 30.03125 5.40625 C 30.378906 5.6875 30.785156 6.148438 31.3125 6.6875 C 32.253906 7.652344 33.695313 8.714844 36.09375 8.9375 C 36.539063 11.238281 38.574219 13 41 13 C 43.75 13 46 10.75 46 8 C 46 5.25 43.75 3 41 3 C 38.605469 3 36.574219 4.710938 36.09375 6.96875 C 34.3125 6.796875 33.527344 6.109375 32.75 5.3125 C 32.300781 4.851563 31.886719
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> case</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> KC_A ... KC_EXSEL:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> case</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> KC_LEFT_CTRL ... KC_RIGHT_GUI:</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> /* do stuff with basic and modifier keycodes */</span></span></code></pre></div><p>Becomes:</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;"> switch</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (keycode) {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> case</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> BASIC_KEYCODE_RANGE:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> case</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> MODIFIER_KEYCODE_RANGE:</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> /* do stuff with basic and modifier keycodes */</span></span></code></pre></div><h3 id="quantum-painter-oled-support" tabindex="-1">Quantum Painter OLED support (<a href="https://github.com/qmk/qmk_firmware/pull/19997" target="_blank" rel="noreferrer">#19997</a>) <a class="header-anchor" href="#quantum-painter-oled-support" aria-label="Permalink to &quot;Quantum Painter OLED support ([#19997](https://github.com/qmk/qmk_firmware/pull/19997)) {#quantum-painter-oled-support}&quot;"></a></h3><p>Quantum Painter has picked up support for SH1106 displays -- commonly seen as 128x64 OLEDs. Support for both I2C and SPI displays is available.</p><p>If you&#39;re already using OLED through <code>OLED_DRIVER_ENABLE = yes</code> or equivalent in <code>info.json</code> and wish to use Quantum Painter instead, you&#39;ll need to disable the old OLED system, instead enabling Quantum Painter as well as enabling the appropriate SH1106 driver. See the <a href="./../quantum_painter#quantum-painter-drivers">Quantum Painter driver documentation</a> for more details. The old OLED driver is still available, and keymaps do not require migrating to Quantum Painter if you don&#39;t want to do so.</p><h3 id="rgb-led-lighting-driver-naming-and-cleanup-21890-21891-21892-21903-21904-21905-21918-21929-21938-22004-22008-22009-22071-22090-22099-22126-22133-22163-22200-22308-22309-22311-22325-22365-22379-22380-22381-22383-22436" tabindex="-1">RGB/LED lighting driver naming and cleanup (<a href="https://github.com/qmk/qmk_firmware/pull/21890" target="_blank" rel="noreferrer">#21890</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21891" target="_blank" rel="noreferrer">#21891</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21892" target="_blank" rel="noreferrer">#21892</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21903" target="_blank" rel="noreferrer">#21903</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21904" target="_blank" rel="noreferrer">#21904</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21905" target="_blank" rel="noreferrer">#21905</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21918" target="_blank" rel="noreferrer">#21918</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21929" target="_blank" rel="noreferrer">#21929</a>, <a href="https://github.com/qmk/qmk_firmware/pull/21938" target="_blank" rel="noreferrer">#21938</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22004" target="_blank" rel="noreferrer">#22004</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22008" target="_blank" rel="noreferrer">#22008</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22009" target="_blank" rel="noreferrer">#22009</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22071" target="_blank" rel="noreferrer">#22071</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22090" target="_blank" rel="noreferrer">#22090</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22099" target="_blank" rel="noreferrer">#22099</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22126" target="_blank" rel="noreferrer">#22126</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22133" target="_blank" rel="noreferrer">#22133</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22163" target="_blank" rel="noreferrer">#22163</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22200" target="_blank" rel="noreferrer">#22200</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22308" target="_blank" rel="noreferrer">#22308</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22309" target="_blank" rel="noreferrer">#22309</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22311" target="_blank" rel="noreferrer">#22311</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22325" target="_blank" rel="noreferrer">#22325</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22365" target="_blank" rel="noreferrer">#22365</a>, <a href="https://github.com/qmk/qmk_firmware/pull/22379" target="_blank" rel="norefe
<script>window.__VP_HASH_MAP__=JSON.parse("{\"breaking_changes_history.md\":\"CkzdD6x8\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"cli.md\":\"BLzAdA6l\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"cli_development.md\":\"3xFA2OvS\",\"api_development_environment.md\":\"EhJClb9f\",\"api_development_overview.md\":\"Dcey4ntL\",\"capabilities_inc.md\":\"Ca9zpMce\",\"changelog_20240526.md\":\"DAmAEDG5\",\"capabilities.md\":\"DgKwcj5n\",\"api_docs.md\":\"CRoD6CbL\",\"api_overview.md\":\"0FPaUsMb\",\"cli_configuration.md\":\"CGSB128P\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"arm_debugging.md\":\"BH-H2Ukz\",\"changelog_20221126.md\":\"DpbrnXeC\",\"changelog_20240225.md\":\"B4-WrXj6\",\"changelog_20230827.md\":\"NSPhmB6l\",\"config_options.md\":\"DvMeqlpB\",\"configurator_architecture.md\":\"DEFTvTlS\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"custom_matrix.md\":\"DMnRw_5l\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20230528.md\":\"nX9R48zP\",\"changelog_20201128.md\":\"7XXL02Bn\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20190830.md\":\"Drtq3lMy\",\"contributing.md\":\"DLsp4vSA\",\"changelog_20220827.md\":\"DjPthqDk\",\"changelog_20211127.md\":\"ClUawWkq\",\"breaking_changes.md\":\"BtdqWQlY\",\"changelog_20210828.md\":\"DNbHIuuM\",\"cli_commands.md\":\"DGx-qNiE\",\"changelog_20200229.md\":\"DNsowwM1\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"changelog_20200829.md\":\"CoqrOffn\",\"custom_quantum_functions.md\":\"DrUNiV1i\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"data_driven_config.md\":\"BvLQ7P20\",\"feature_layers.md\":\"8GwBUTZN\",\"easy_maker.md\":\"DAfbIK4w\",\"faq_build.md\":\"DL_WezA1\",\"faq_debug.md\":\"DuThValw\",\"faq_general.md\":\"BC3pFw4U\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"drivers_gpio.md\":\"C5PvyJVh\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_serial.md\":\"qxjytVdM\",\"feature_eeprom.md\":\"a0eoTZm7\",\"faq_keymap.md\":\"BsEmEZTo\",\"feature_converters.md\":\"DFKin1io\",\"drivers_i2c.md\":\"Cuj87reB\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"faq_misc.md\":\"qGrhOTu4\",\"drivers_flash.md\":\"DhWcHp8S\",\"drivers_audio.md\":\"mqaz6p5N\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"documentation_templates.md\":\"Bhkum0wD\",\"drivers_adc.md\":\"DzU8txf8\",\"drivers_eeprom.md\":\"B_6soqar\",\"drivers_uart.md\":\"BNBs-m3h\",\"features_bluetooth.md\":\"CiAjl875\",\"features_caps_word.md\":\"BDQGM0-x\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"features_command.md\":\"Byl9YoT7\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_stenography.md\":\"Bb_IhUGl\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"newbs_git_resynchronize_a_branch.md\":\"YGDefQFx\",\"newbs_building_firmware_workflow.md\":\"DpLVwA7x\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"newbs.md\":\"-YYNd3dT\",\"newbs_flashing.md\":\"B42m5Wln\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_hd44780.md\":\"15K40o_e\",\"features_audio.md\":\"DWNYte3W\",\"features_encoders.md\":\"B2SX3hG2\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_led_indicators.md\":\"CCZhjHe9\",\"features_midi.md\":\"u3tHPteB\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_joystick.md\":\"CW0gZHec\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_os_detection.md\":\"DZKTWvSd\",\"features_mouse_keys.md\":\"C3P3pYuE\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"features_st7565.md\":\"MoajNurJ\",\"features_repeat_key.md\":\"C3eWDUWn\",\"features_swap_hands.md\":\"DOhgGQf9\",\"features_wpm.md\":\"BYf-Xc1H\",\"flashi
</body>
</html>