mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
31 lines
102 KiB
HTML
31 lines
102 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>Frequently Asked Build Questions | 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.R_mF0amW.css" as="style">
|
|||
|
|
|
|||
|
|
<script type="module" src="/assets/app.BYXWzDH8.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.vwpNwX24.js">
|
|||
|
|
<link rel="modulepreload" href="/assets/faq_build.md.Bryo1ywz.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="/badge-community-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/badge-community-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><!----><!--[--><!--]--></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.843
|
|||
|
|
$ sudo dfu-programmer atmega32u4 flash your.hex
|
|||
|
|
$ sudo dfu-programmer atmega32u4 reset
|
|||
|
|
</code></pre><p>or just:</p><pre><code>$ sudo make <keyboard>:<keymap>:flash
|
|||
|
|
</code></pre><p>Note that running <code>make</code> with <code>sudo</code> is generally <em><strong>not</strong></em> a good idea, and you should use one of the former methods, if possible.</p><h3 id="linux-udev-rules" tabindex="-1">Linux <code>udev</code> Rules <a class="header-anchor" href="#linux-udev-rules" aria-label="Permalink to "Linux `udev` Rules {#linux-udev-rules}""></a></h3><p>On Linux, you'll need proper privileges to communicate with the bootloader device. You can either use <code>sudo</code> when flashing firmware (not recommended), or place <a href="https://github.com/qmk/qmk_firmware/tree/master/util/udev/50-qmk.rules" target="_blank" rel="noreferrer">this file</a> into <code>/etc/udev/rules.d/</code>.</p><p>Once added, run the following:</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>sudo udevadm control --reload-rules</span></span>
|
|||
|
|
<span class="line"><span>sudo udevadm trigger</span></span></code></pre></div><p><strong>Note:</strong> With older versions of ModemManager (< 1.12), filtering only works when not in strict mode. The following commands can update that setting:</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>printf '[Service]\nExecStart=\nExecStart=/usr/sbin/ModemManager --filter-policy=default' | sudo tee /etc/systemd/system/ModemManager.service.d/policy.conf</span></span>
|
|||
|
|
<span class="line"><span>sudo systemctl daemon-reload</span></span>
|
|||
|
|
<span class="line"><span>sudo systemctl restart ModemManager</span></span></code></pre></div><h3 id="serial-device-is-not-detected-in-bootloader-mode-on-linux" tabindex="-1">Serial device is not detected in bootloader mode on Linux <a class="header-anchor" href="#serial-device-is-not-detected-in-bootloader-mode-on-linux" aria-label="Permalink to "Serial device is not detected in bootloader mode on Linux""></a></h3><p>Make sure your kernel has appropriate support for your device. If your device uses USB ACM, such as Pro Micro (Atmega32u4), make sure to include <code>CONFIG_USB_ACM=y</code>. Other devices may require <code>USB_SERIAL</code> and any of its sub options.</p><h2 id="unknown-device-for-dfu-bootloader" tabindex="-1">Unknown Device for DFU Bootloader <a class="header-anchor" href="#unknown-device-for-dfu-bootloader" aria-label="Permalink to "Unknown Device for DFU Bootloader""></a></h2><p>Issues encountered when flashing keyboards on Windows are most often due to having the wrong drivers installed for the bootloader, or none at all.</p><p>Re-running the QMK installation script (<code>./util/qmk_install.sh</code> from the <code>qmk_firmware</code> directory in MSYS2 or WSL) or reinstalling the QMK Toolbox may fix the issue. Alternatively, you can download and run the <a href="https://github.com/qmk/qmk_driver_installer" target="_blank" rel="noreferrer"><code>qmk_driver_installer</code></a> package manually.</p><p>If that doesn't work, then you may need to download and run Zadig. See <a href="./driver_installation_zadig">Bootloader Driver Installation with Zadig</a> for more detailed information.</p><h2 id="usb-vid-and-pid" tabindex="-1">USB VID and PID <a class="header-anchor" href="#usb-vid-and-pid" aria-label="Permalink to "USB VID and PID""></a></h2><p>You can use any ID you want with editing <code>config.h</code>. Using any presumably unused ID will be no problem in fact except for very low chance of collision with other product.</p><p>Most boards in QMK use <code>0xFEED</code> as the vendor ID. You should look through other keyboards to make sure you pick a unique Product ID.</p><p>Also see this. <a href="https://github.com/tmk/tmk_keyboard/issues/150" target="_blank" rel="noreferrer">https://github.com/tmk/tmk_keyboard/issues/150</a></p><p>You can buy a really unique VID:PID here. I don't think you need this for personal use.</p><ul><li><a href="https://www.obdev.at/products/vusb/license.html" target="_blank" rel="noreferrer">https://www.obdev.at/products/vusb/license.html</a></li><li><a href="https://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1" target="_blank" rel="noreferrer">https://www.mcselec.com/index.php?page=shop.product_details&flypage=shop.flypage&product_id=92&option=com_phpshop&Itemid=1</a></li></ul><h3 id="i-just-flashed-my-keyboard-and-it-does-nothing-keypresses-don-t-register-it-s-also-arm-rev6-planck-clueboard-60-hs60v2-etc-feb-2019" tabindex="-1">I just flashed my keyboard and it does nothing/keypresses don't register - it's also ARM (rev6 planck, clueboard 60, hs60v2, etc...) (Feb 2019) <a class="header-anchor" href="#i-just-flashed-my-keyboard-and-it-does-nothing-keypresses-don-t-register-it-s-also-arm-rev6-planck-clueboard-60-hs60v2-etc-feb-2019" aria-label="Permalink to "I just flashed my keyboard and it does nothing/keypresses don't register - it's also ARM (rev6 planck, clueboard 60, hs60v2, etc...) (Feb 2019)""></a></h3><p>Due to how EEPROM works on ARM based chips, saved settings may no longer be valid. This affects the default layers, and <em>may</em>, under certain circumstances we are still figuring out, make the keyboard unusable. Resetting the EEPROM will correct this.</p><p><a href="https://cdn.discordapp.com/attachments/473506116718952450/539284620861243409/planck_rev6_default.bin" target="_blank" rel="noreferrer">Planck rev6 reset EEPROM</a> can be used to force an eeprom reset. After flashing this
|
|||
|
|
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20210227.md\":\"BWOtCaeS\",\"feature_os_detection.md\":\"DZib_QdQ\",\"feature_led_indicators.md\":\"CZMu7H5E\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"changelog_20201128.md\":\"7XXL02Bn\",\"feature_hd44780.md\":\"yQt2vqod\",\"changelog_20200229.md\":\"DNsowwM1\",\"feature_mouse_keys.md\":\"Iyt3Hb3p\",\"apa102_driver.md\":\"DGTINeKZ\",\"adc_driver.md\":\"DGNSFJQa\",\"api_development_environment.md\":\"EhJClb9f\",\"api_overview.md\":\"0FPaUsMb\",\"api_development_overview.md\":\"Dcey4ntL\",\"changelog_20210828.md\":\"X99NaKjy\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"capabilities_inc.md\":\"Ca9zpMce\",\"audio_driver.md\":\"YKqJ1wkZ\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"capabilities.md\":\"D_J-XtW-\",\"changelog_20240225.md\":\"CGDoAFQ4\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"cli.md\":\"BLzAdA6l\",\"cli_commands.md\":\"CyobrwxG\",\"cli_configuration.md\":\"DE7-bdby\",\"cli_tab_complete.md\":\"B7wjrflU\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"configurator_architecture.md\":\"DEFTvTlS\",\"config_options.md\":\"D0qoSxZG\",\"changelog_20220827.md\":\"I6ja7C5w\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"changelog_20210529.md\":\"CR1YNfZX\",\"documentation_templates.md\":\"Bhkum0wD\",\"easy_maker.md\":\"BLadB4D_\",\"eeprom_driver.md\":\"CJGhJYmK\",\"driver_installation_zadig.md\":\"BIO-iq8r\",\"faq_build.md\":\"Bryo1ywz\",\"feature_secure.md\":\"DTio1NtX\",\"faq_general.md\":\"BC3pFw4U\",\"feature_bluetooth.md\":\"bG-tYvch\",\"changelog_20221126.md\":\"BOpHhXi2\",\"hardware_keyboard_guidelines.md\":\"Bvlp0QQ-\",\"faq_debug.md\":\"uJtFRvCN\",\"how_a_matrix_works.md\":\"kbkC_Qqf\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"i2c_driver.md\":\"sPsXYlGc\",\"feature_audio.md\":\"CZCAuU3V\",\"feature_backlight.md\":\"DBI0guDv\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"feature_send_string.md\":\"ucKdf_1f\",\"feature_rawhid.md\":\"_qE_L8rS\",\"feature_digitizer.md\":\"D7mG1fUR\",\"feature_auto_shift.md\":\"Dqbx4mPc\",\"documentation_best_practices.md\":\"D_UwEt1C\",\"feature_autocorrect.md\":\"MXySdvB8\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"feature_key_overrides.md\":\"DXeoCP3-\",\"changelog_20220226.md\":\"Ee8ZP8S1\",\"getting_started_make_guide.md\":\"fsRi0mqX\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"gpio_control.md\":\"BXAY05Da\",\"hand_wire.md\":\"DrA6YbSw\",\"isp_flashing_guide.md\":\"DfzdHli4\",\"feature_macros.md\":\"CqZWbmVr\",\"feature_caps_word.md\":\"DFEidvi5\",\"feature_encoders.md\":\"DzEjkR0q\",\"faq_misc.md\":\"qGrhOTu4\",\"feature_layers.md\":\"DHhp24oY\",\"getting_started_introduction.md\":\"BOJreqSs\",\"flashing_bootloadhid.md\":\"fHtXqWj8\",\"feature_ps2_mouse.md\":\"DgKRvSpd\",\"newbs_flashing.md\":\"phca4mvb\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"newbs_building_firmware_workflow.md\":\"YeGfwwbu\",\"getting_started_github.md\":\"OYq7IT7B\",\"feature_key_lock.md\":\"DBAH_Fju\",\"keycodes.md\":\"OXRg0uVR\",\"newbs_building_firmware.md\":\"D-rVQJMN\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3BRmm\",\"newbs_building_firmware_configurator.md\":\"yyo-1QDE\",\"newbs_git_resynchronize_a_branch.md\":\"YGDefQFx\",\"newbs_git_using_your_master_branch.md\":\"B9DxZCl8\",\"faq_keymap.md\":\"BNm1UZCq\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"keycodes_basic.md\":\"CHIeCvwn\",\"newbs_external_userspace.md\":\"pD9Lc-a5\",\"newbs_getting_started.md\":\"bEdEplPb\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs.md\":\"DnEWW2K4\",\"keycodes_us_ansi_shifted.md\":\"Cs78SDfM\",\"support.md\":\"CwJ_H6Qx\",\"support_deprecation_policy.md\":\"CCo4ljiw\",\"flashing.md\":\"CGYYQUk5\",\"keymap.md\":\"DG7FvBbs\",\"other_eclipse.md\":\"C-zqyJO9\",\"uart_driver.md\":\"Cby_2B9q\",\"syllabus.md\":\"0-MOMJnE\",\"feature_leader_key.md\":\"Bmrl3zQy\",\"contributing.md\":\
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|