qmk_firmware/feature_converters.html

30 lines
113 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>Converters | 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.BQjPZ5OS.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.BEU6ITQ7.js">
<link rel="modulepreload" href="/assets/feature_converters.md.DFKin1io.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
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Proton C code</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#else</span></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pro Micro code</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#endif</span></span></code></pre></div><h3 id="pin-compatibility" tabindex="-1">Pin Compatibility <a class="header-anchor" href="#pin-compatibility" aria-label="Permalink to &quot;Pin Compatibility&quot;"></a></h3><p>To ensure compatibility, provide validation, and enable future workflows, a keyboard should declare its <code>pin compatibility</code>. For legacy reasons, this is currently assumed to be <code>promicro</code>. The following pin compatibility interfaces are currently defined:</p><table><thead><tr><th>Pin Compatibility</th><th>Notes</th></tr></thead><tbody><tr><td><code>promicro</code></td><td>Includes RX/TX LEDs</td></tr><tr><td><code>elite_c</code></td><td>Includes bottom row pins, no LEDs</td></tr></tbody></table><p>To declare the base for conversions, add this line to your keyboard&#39;s <code>rules.mk</code>:</p><div class="language-makefile vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">makefile</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">PIN_COMPATIBLE = elite_c</span></span></code></pre></div><h2 id="pro-micro" tabindex="-1">Pro Micro <a class="header-anchor" href="#pro-micro" aria-label="Permalink to &quot;Pro Micro&quot;"></a></h2><p>If a board currently supported in QMK uses a <a href="https://www.sparkfun.com/products/12640" target="_blank" rel="noreferrer">Pro Micro</a> (or compatible board), the supported alternative controllers are:</p><table><thead><tr><th>Device</th><th>Target</th></tr></thead><tbody><tr><td><a href="https://qmk.fm/proton-c/" target="_blank" rel="noreferrer">Proton C</a></td><td><code>proton_c</code></td></tr><tr><td><a href="https://learn.adafruit.com/adafruit-kb2040" target="_blank" rel="noreferrer">Adafruit KB2040</a></td><td><code>kb2040</code></td></tr><tr><td><a href="https://www.sparkfun.com/products/18288" target="_blank" rel="noreferrer">SparkFun Pro Micro - RP2040</a></td><td><code>promicro_rp2040</code></td></tr><tr><td><a href="https://boardsource.xyz/store/628b95b494dfa308a6581622" target="_blank" rel="noreferrer">Blok</a></td><td><code>blok</code></td></tr><tr><td><a href="https://nullbits.co/bit-c-pro" target="_blank" rel="noreferrer">Bit-C PRO</a></td><td><code>bit_c_pro</code></td></tr><tr><td><a href="https://github.com/megamind4089/STeMCell" target="_blank" rel="noreferrer">STeMCell</a></td><td><code>stemcell</code></td></tr><tr><td><a href="https://shop.custommk.com/products/bonsai-c4-microcontroller-board" target="_blank" rel="noreferrer">customMK Bonsai C4</a></td><td><code>bonsai_c4</code></td></tr><tr><td><a href="https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040" target="_blank" rel="noreferrer">Elite-Pi</a></td><td><code>elite_pi</code></td></tr><tr><td><a href="https://keeb.supply/products/0xcb-helios" target="_blank" rel="noreferrer">0xCB Helios</a></td><td><code>helios</code></td></tr><tr><td><a href="https://splitkb.com/products/liatris" target="_blank" rel="noreferrer">Liatris</a></td><td><code>liatris</code></td></tr><tr><td><a href="https://splitkb.com/products/imera" target="_blank" rel="noreferrer">Imera</a></td><td><code>imera</code></td></tr><tr><td><a href="https://github.com/ci-bus/michi-promicro-rp2040" target="_blank" rel="noreferrer">Michi</a></td><td><code>michi</code></td></tr></tbody></table><p>Converter summary:</p><table><thead><tr><th>Target</th><th>Argument</th><th><code>rules.mk</code></th><th>Condition</th></tr></thead><tbody><tr><td><code>proton_c</code></td><td><code>-e CONVERT_TO=proton_c</code></td><td><code>CONVERT_TO=proton_c</code></td><td><code>#ifdef CONVERT_TO_PROTON_C</code></td></tr><tr><td><code>kb2040</code></td><td><code>-e CONVERT_TO=kb2040</code></td><td><code>CONVERT_TO=kb2040</code></td><td><code>#ifdef CONVERT_TO_KB2040</code></td></tr><tr><td><code>promicro_rp2040</code></td><td><code>-e CONVERT_TO=promicro_rp2040</code></td><td><code>CONVERT_TO=promicro_rp2
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// If VBUS detection is unused, we can send RXLED to the Vbus detect pin instead</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> B0</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> PAL_LINE</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(GPIOA, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">9</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span></code></pre></div><h3 id="rp2040_ce" tabindex="-1">RP2040 Community Edition - Elite-Pi, Helios, and Liatris <a class="header-anchor" href="#rp2040_ce" aria-label="Permalink to &quot;RP2040 Community Edition - Elite-Pi, Helios, and Liatris {#rp2040_ce}&quot;"></a></h3><p>Feature set is identical to <a href="#kb2040">Adafruit KB2040</a>. VBUS detection is enabled by default for superior split keyboard support. For more information, refer to the <a href="./platformdev_rp2040#rp2040_ce">Community Edition pinout</a> docs.</p><h2 id="elite-c" tabindex="-1">Elite-C <a class="header-anchor" href="#elite-c" aria-label="Permalink to &quot;Elite-C&quot;"></a></h2><p>If a board currently supported in QMK uses an <a href="https://keeb.io/products/elite-c-low-profile-version-usb-c-pro-micro-replacement-atmega32u4" target="_blank" rel="noreferrer">Elite-C</a>, the supported alternative controllers are:</p><table><thead><tr><th>Device</th><th>Target</th></tr></thead><tbody><tr><td><a href="https://github.com/megamind4089/STeMCell" target="_blank" rel="noreferrer">STeMCell</a></td><td><code>stemcell</code></td></tr><tr><td><a href="https://keeb.io/products/elite-pi-usb-c-pro-micro-replacement-rp2040" target="_blank" rel="noreferrer">Elite-Pi</a></td><td><code>elite_pi</code></td></tr><tr><td><a href="https://keeb.supply/products/0xcb-helios" target="_blank" rel="noreferrer">0xCB Helios</a></td><td><code>helios</code></td></tr><tr><td><a href="https://splitkb.com/products/liatris" target="_blank" rel="noreferrer">Liatris</a></td><td><code>liatris</code></td></tr></tbody></table><p>Converter summary:</p><table><thead><tr><th>Target</th><th>Argument</th><th><code>rules.mk</code></th><th>Condition</th></tr></thead><tbody><tr><td><code>stemcell</code></td><td><code>-e CONVERT_TO=stemcell</code></td><td><code>CONVERT_TO=stemcell</code></td><td><code>#ifdef CONVERT_TO_STEMCELL</code></td></tr><tr><td><code>rp2040_ce</code></td><td><code>-e CONVERT_TO=rp2040_ce</code></td><td><code>CONVERT_TO=rp2040_ce</code></td><td><code>#ifdef CONVERT_TO_RP2040_CE</code></td></tr><tr><td><code>elite_pi</code></td><td><code>-e CONVERT_TO=elite_pi</code></td><td><code>CONVERT_TO=elite_pi</code></td><td><code>#ifdef CONVERT_TO_ELITE_PI</code></td></tr><tr><td><code>helios</code></td><td><code>-e CONVERT_TO=helios</code></td><td><code>CONVERT_TO=helios</code></td><td><code>#ifdef CONVERT_TO_HELIOS</code></td></tr><tr><td><code>liatris</code></td><td><code>-e CONVERT_TO=liatris</code></td><td><code>CONVERT_TO=liatris</code></td><td><code>#ifdef CONVERT_TO_LIATRIS</code></td></tr></tbody></table><h3 id="stemcell-stemcell-elite" tabindex="-1">STeMCell {#stemcell}_elite <a class="header-anchor" href="#stemcell-stemcell-elite" aria-label="Permalink to &quot;STeMCell {#stemcell}_elite&quot;"></a></h3><p>Identical to <a href="#stemcell">Pro Micro - STeMCell</a> with support for the additional bottom row of pins.</p><h3 id="rp2040_ce_elite" tabindex="-1">RP2040 Community Edition <a class="header-anchor" href="#rp2040_ce_elite" aria-label="Permalink to &quot;RP2040 Community Edition {#rp2040_ce_elite}&quot;"></a></h3><p>Identical to <a href="#rp2040_ce">Pro Micro - RP2040 Community Edition</a> with support for the additional bottom row of pins.</p></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-09de1c0f><!--[--><!--]--><!----><nav class="prev-next" data-v-09de1c0f><div class="pager" data-v-09de1c0f><a class="VPLink link pager-link prev" href="/features/bootmagic" data-v-09de1c0f><!--[--><span class="desc" data-v-09de1c0f>Previous page</span><span class="title" data-v-09de1c0f>Bootmagic Lite</span><!-
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"changelog_20211127.md\":\"ClUawWkq\",\"features_rawhid.md\":\"bKKG3KCa\",\"features_send_string.md\":\"vM68un4v\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20230827.md\":\"NSPhmB6l\",\"capabilities.md\":\"DgKwcj5n\",\"feature_layouts.md\":\"qcy8hNMO\",\"api_development_environment.md\":\"EhJClb9f\",\"changelog_20200829.md\":\"CoqrOffn\",\"api_development_overview.md\":\"Dcey4ntL\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"faq_general.md\":\"BOlGsWSk\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"contributing.md\":\"CgMx5YLW\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"easy_maker.md\":\"DAfbIK4w\",\"features_autocorrect.md\":\"DHRDcuho\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"drivers_eeprom.md\":\"B_6soqar\",\"features_stenography.md\":\"Bb_IhUGl\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"one_shot_keys.md\":\"QR09rSb-\",\"custom_matrix.md\":\"DMnRw_5l\",\"changelog_20230528.md\":\"nX9R48zP\",\"changelog_20190830.md\":\"Drtq3lMy\",\"cli.md\":\"BLzAdA6l\",\"other_vscode.md\":\"Di3vOySR\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_encoders.md\":\"DMlIJGGa\",\"features_grave_esc.md\":\"mUNEjUYS\",\"features_auto_shift.md\":\"B9HLt3QM\",\"features_joystick.md\":\"CW0gZHec\",\"features_key_lock.md\":\"IjFq9dYs\",\"features_hd44780.md\":\"15K40o_e\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"custom_quantum_functions.md\":\"Br1xUGGa\",\"features_midi.md\":\"u3tHPteB\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_led_indicators.md\":\"CCZhjHe9\",\"features_oled_driver.md\":\"D9wJVdL1\",\"porting_your_keyboard_to_qmk.md\":\"CGlGdFj4\",\"features_pointing_device.md\":\"DP6-XwL6\",\"features_programmable_button.md\":\"D332w_PT\",\"features_repeat_key.md\":\"C3eWDUWn\",\"features_ps2_mouse.md\":\"CL_pA9sk\",\"changelog_20220226.md\":\"BWO5r_ec\",\"features_rgb_matrix.md\":\"l4JPh3s9\",\"api_overview.md\":\"0FPaUsMb\",\"breaking_changes.md\":\"BtdqWQlY\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"breaking_changes_instructions.md\":\"C99NYDjO\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"config_options.md\":\"DvMeqlpB\",\"configurator_architecture.md\":\"DEFTvTlS\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"drivers_serial.md\":\"CnlLG_H1\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"features_caps_word.md\":\"BDQGM0-x\",\"drivers_audio.md\":\"mqaz6p5N\",\"features_command.md\":\"Byl9YoT7\",\"pr_checklist.md\":\"9utxnOgJ\",\"features_digitizer.md\":\"DGIGZFVx\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"documentation_templates.md\":\"Bhkum0wD\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"features_sequencer.md\":\"DkgqNCsQ\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"features_dip_switch.md\":\"DtBOdc98\",\"data_driven_config.md\":\"BvLQ7P20\",\"arm_debugging.md\":\"BH-H2Ukz\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"features_space_cadet.md\":\"DmNfYRVJ\",\"drivers_adc.md\":\"DzU8txf8\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_spi.md\":\"tJVeIT7e\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20220827.md\":\"DjPthqDk\",\"cli_configuration.md\":\"CGSB128P\",\"drivers_flash.md\":\"DhWcHp8S\",\"cli_development.md\":\"3xFA2OvS\",\"drivers_gpio.md\":\"C5PvyJVh\",\"changelog_20210828.md\":\"DNbHIuuM\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"drivers_uart.md\":\"BNBs-m3h\",\"faq_debug.md\":\"DuThValw\",\"features_swap_hands.md\":\"DOhgGQf9\",\"features_st7565.md\":\"MoajNurJ\",\"features_tri_layer.md\":\"DdnBVinw\",\"feature_eeprom.md\":\"a0eoTZm7\",\"getting_started_github.md\":\"OYq7IT7B\",\"getting_started_introduction.md\":\"BOJreqSs\",\"features_tap_dance.md\":\"CKLVpnIn\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"hardwa
</body>
</html>