qmk_firmware/newbs_flashing.html

39 lines
107 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>Flashing Your Keyboard | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
<link rel="preload stylesheet" href="/assets/style.DWuET1QV.css" as="style">
<script type="module" src="/assets/app.BaY98A1A.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.qgcIJObk.js">
<link rel="modulepreload" href="/assets/newbs_flashing.md.B42m5Wln.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>*** Attempting to flash, please don&#39;t remove device</span></span>
<span class="line"><span>&gt;&gt;&gt; dfu-programmer.exe atmega32u4 erase --force</span></span>
<span class="line"><span> Erasing flash... Success</span></span>
<span class="line"><span> Checking memory from 0x0 to 0x6FFF... Empty.</span></span>
<span class="line"><span>&gt;&gt;&gt; dfu-programmer.exe atmega32u4 flash &quot;D:\Git\qmk_firmware\gh60_satan_default.hex&quot;</span></span>
<span class="line"><span> Checking memory from 0x0 to 0x3F7F... Empty.</span></span>
<span class="line"><span> 0% 100% Programming 0x3F80 bytes...</span></span>
<span class="line"><span> [&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;] Success</span></span>
<span class="line"><span> 0% 100% Reading 0x7000 bytes...</span></span>
<span class="line"><span> [&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;&gt;] Success</span></span>
<span class="line"><span> Validating... Success</span></span>
<span class="line"><span> 0x3F80 bytes written into 0x7000 bytes memory (56.70%).</span></span>
<span class="line"><span>&gt;&gt;&gt; dfu-programmer.exe atmega32u4 reset</span></span>
<span class="line"><span> </span></span>
<span class="line"><span>*** DFU device disconnected: Atmel Corp: ATmega32U4 (03EB:2FF4:0000)</span></span></code></pre></div><h2 id="flash-your-keyboard-from-the-command-line" tabindex="-1">Flash your Keyboard from the Command Line <a class="header-anchor" href="#flash-your-keyboard-from-the-command-line" aria-label="Permalink to &quot;Flash your Keyboard from the Command Line&quot;"></a></h2><p>This has been made pretty simple compared to what it used to be. When you are ready to compile and flash your firmware, open up your terminal window and run the flash command:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> flash</span></span></code></pre></div><p>If you did not configure your keyboard/keymap name in the CLI according to the <a href="./newbs_getting_started">Configure your build environment</a> section, or you have multiple keyboards, you can specify the keyboard and keymap:</p><div class="language-sh vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">qmk</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> flash</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -kb</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">my_keyboar</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">d</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -km</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> &lt;</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">my_keyma</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">p</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">&gt;</span></span></code></pre></div><p>This will check the keyboard&#39;s configuration, and then attempt to flash it based on the specified bootloader. This means that you don&#39;t need to know which bootloader that your keyboard uses. Just run the command, and let the command do the heavy lifting.</p><p>However, this does rely on the bootloader being set by the keyboard. If this information is not configured, or you&#39;re using a board that doesn&#39;t have a supported target to flash it, you will see this error:</p><div class="language- vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang"></span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span>WARNING: This board&#39;s bootloader is not specified or is not supported by the &quot;:flash&quot; target at this time.</span></span></code></pre></div><p>In this case, you&#39;ll have to fall back on specifying the bootloader. See the <a href="./flashing">Flashing Firmware</a> Guide for more details.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If your bootloader is not detected by <code>qmk flash</code>, try running <code>qmk doctor</code> for suggestions on how to fix common problems.</p></div><h2 id="test-it-out" tabindex="-1">Test It Out! <a class="header-anchor" href="#test-it-out" aria-label="Permalink to &quot;Test It Out!&quot;"></a></h2><p>Congrats! Your custom firmware has been programmed to your keyboard and you&#39;re ready to test it out!</p><p>With a little bit of luck everything will work perfectly, but if not there are steps that will help you figure out what&#39;s wrong. Testing your keyboard is usually pretty straightforward. Press every single key and make sure it sends the keys you expect. You can use <a href="https://config.qmk.fm/#/test/" target="_bla
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200530.md\":\"Dk-vRpTQ\",\"changelog_20200229.md\":\"DNsowwM1\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"changelog_20230528.md\":\"BMuuw__T\",\"arm_debugging.md\":\"BH-H2Ukz\",\"feature_key_lock.md\":\"DBAH_Fju\",\"cli_commands.md\":\"DCpejdln\",\"faq_debug.md\":\"uJtFRvCN\",\"changelog_20210828.md\":\"X99NaKjy\",\"capabilities_inc.md\":\"Ca9zpMce\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_digitizer.md\":\"D7mG1fUR\",\"feature_led_matrix.md\":\"xGxJCIdk\",\"feature_dip_switch.md\":\"BRm_919T\",\"custom_matrix.md\":\"DMnRw_5l\",\"changelog_20230827.md\":\"CkGh7Wzq\",\"eeprom_driver.md\":\"CJGhJYmK\",\"changelog_20210227.md\":\"BWOtCaeS\",\"audio_driver.md\":\"YKqJ1wkZ\",\"feature_secure.md\":\"DTio1NtX\",\"feature_rawhid.md\":\"_qE_L8rS\",\"configurator_architecture.md\":\"DEFTvTlS\",\"changelog_20200829.md\":\"CoqrOffn\",\"feature_audio.md\":\"CSdy-B0q\",\"feature_space_cadet.md\":\"BadigqA6\",\"changelog_20201128.md\":\"7XXL02Bn\",\"api_overview.md\":\"0FPaUsMb\",\"changelog_20190830.md\":\"Drtq3lMy\",\"feature_stenography.md\":\"7-PPOa0f\",\"changelog_20220528.md\":\"BdSPPJS6\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"apa102_driver.md\":\"DGTINeKZ\",\"feature_st7565.md\":\"C5ELVDfx\",\"changelog_20221126.md\":\"BOpHhXi2\",\"feature_split_keyboard.md\":\"dSXqGTcC\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"cli_configuration.md\":\"CGSB128P\",\"hand_wire.md\":\"CieyXSH7\",\"newbs_learn_more_resources.md\":\"Dj1s2BDG\",\"changelog_20210529.md\":\"CR1YNfZX\",\"keycodes_basic.md\":\"CHIeCvwn\",\"other_eclipse.md\":\"C-zqyJO9\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"feature_bootmagic.md\":\"CHslUBOY\",\"pr_checklist.md\":\"B5cKcG_-\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"keycodes.md\":\"OXRg0uVR\",\"unit_testing.md\":\"u3fgbGUj\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"ws2812_driver.md\":\"DXixRTSx\",\"changelog_20220226.md\":\"Ee8ZP8S1\",\"quantum_painter_qff.md\":\"kLNwshez\",\"ref_functions.md\":\"BqUSY2Jo\",\"platformdev_rp2040.md\":\"Ca0zZxM4\",\"feature_command.md\":\"DyD1wEzr\",\"changelog_20220827.md\":\"I6ja7C5w\",\"isp_flashing_guide.md\":\"DfzdHli4\",\"feature_autocorrect.md\":\"MXySdvB8\",\"feature_encoders.md\":\"DzEjkR0q\",\"feature_key_overrides.md\":\"DXeoCP3-\",\"feature_eeprom.md\":\"vdeTTfI0\",\"feature_layers.md\":\"DHhp24oY\",\"feature_layouts.md\":\"qcy8hNMO\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"squeezing_avr.md\":\"BmcLYKOr\",\"capabilities.md\":\"D_J-XtW-\",\"reference_info_json.md\":\"DLkUuXVh\",\"feature_led_indicators.md\":\"CZMu7H5E\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"feature_midi.md\":\"6rA7lbe-\",\"changelog_20230226.md\":\"CEQKb2Sw\",\"feature_advanced_keycodes.md\":\"jN1BLaPG\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"feature_os_detection.md\":\"DZib_QdQ\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"feature_hd44780.md\":\"yQt2vqod\",\"changelog_20240526.md\":\"iGLFD0SP\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"feature_combo.md\":\"BFcSajDz\",\"documentation_templates.md\":\"Bhkum0wD\",\"feature_programmable_button.md\":\"BP5-HUlT\",\"feature_converters.md\":\"Bmv29bqN\",\"contributing.md\":\"DLsp4vSA\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"feature_backlight.md\":\"DBI0guDv\",\"feature_send_string.md\":\"ucKdf_1f\",\"feature_repeat_key.md\":\"D8sTeKpj\",\"api_development_overview.md\":\"Dcey4ntL\",\"feature_pointing_device.md\":\"D8bKydDH\",\"feature_sequencer.md\":\"B9A4Z8EN\",\"api_docs.md\":\"CRoD6CbL\",\"index.md\":\"Q8qZBSI9\",\"support.md\":\"CwJ_H6Qx\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"reference_configurator_support.md\":\"FaBQzIj6\",\"flash_driver.md\":\"BTZjpIxy\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"getting_started_docker
</body>
</html>