mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
16 lines
12 KiB
JavaScript
16 lines
12 KiB
JavaScript
|
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js";
|
|||
|
|
const __pageData = JSON.parse('{"title":"Bootloader Driver Installation with Zadig","description":"","frontmatter":{},"headers":[],"relativePath":"driver_installation_zadig.md","filePath":"driver_installation_zadig.md"}');
|
|||
|
|
const _sfc_main = { name: "driver_installation_zadig.md" };
|
|||
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="bootloader-driver-installation-with-zadig" tabindex="-1">Bootloader Driver Installation with Zadig <a class="header-anchor" href="#bootloader-driver-installation-with-zadig" aria-label="Permalink to "Bootloader Driver Installation with Zadig""></a></h1><p>QMK presents itself to the host as a regular HID keyboard device, and as such requires no special drivers. However, in order to flash your keyboard on Windows, the bootloader device that appears when you reset the board often <em>does</em>.</p><p>There are two notable exceptions: the Caterina bootloader, usually seen on Pro Micros, and the HalfKay bootloader shipped with PJRC Teensys, appear as a serial port and a generic HID device respectively, and so do not require a driver.</p><p>We recommend the use of the <a href="https://zadig.akeo.ie/" target="_blank" rel="noreferrer">Zadig</a> utility. If you have set up the development environment with MSYS2, the <code>qmk_install.sh</code> script will have already installed the drivers for you.</p><h2 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-label="Permalink to "Installation""></a></h2><p>Put your keyboard into bootloader mode, either by hitting the <code>QK_BOOT</code> keycode (which may be on a different layer), or by pressing the reset switch that's usually located on the underside of the board. If your keyboard has neither, try holding Escape or Space+<code>B</code> as you plug it in (see the <a href="./features/bootmagic">Bootmagic Lite</a> docs for more details). Some boards use <a href="./features/command">Command</a> instead of Bootmagic; in this case, you can enter bootloader mode by hitting Left Shift+Right Shift+<code>B</code> or Left Shift+Right Shift+Escape at any point while the keyboard is plugged in. Some keyboards may have specific instructions for entering the bootloader. For example, the <a href="./features/bootmagic">Bootmagic Lite</a> key (default: Escape) might be on a different key, e.g. Left Control; or the magic combination for Command (default: Left Shift+Right Shift) might require you to hold something else, e.g. Left Control+Right Control. Refer to the board's README file if you are unsure.</p><p>To put a device in bootloader mode with USBaspLoader, tap the <code>RESET</code> button while holding down the <code>BOOT</code> button. Alternatively, hold <code>BOOT</code> while inserting the USB cable.</p><p>Zadig should automatically detect the bootloader device, but you may sometimes need to check <strong>Options → List All Devices</strong> and select the device from the dropdown instead.</p><div class="warning custom-block"><p class="custom-block-title">WARNING</p><p>If Zadig lists one or more devices with the <code>HidUsb</code> driver, your keyboard is probably not in bootloader mode. The arrow will be colored orange and you will be asked to confirm modifying a system driver. <strong>Do not</strong> proceed if this is the case!</p></div><p>If the arrow appears green, select the driver, and click <strong>Install Driver</strong>. See the <a href="#list-of-known-bootloaders">list of known bootloaders</a> for the correct driver to install.</p><p><img src="https://i.imgur.com/b8VgXzx.png" alt="Zadig with a bootloader driver correctly installed"></p><p>Finally, unplug and replug the keyboard to make sure the new driver has been loaded. If you are using the QMK Toolbox to flash, exit and restart it too, as it can sometimes fail to recognize the driver change.</p><h2 id="recovering-from-installation-to-wrong-device" tabindex="-1">Recovering from Installation to Wrong Device <a class="header-anchor" href="#recovering-from-installation-to-wrong-device" aria-label="Permalink to "Recovering from Installation to Wrong Device""></a></h2><p>If you find that you can no longer type with the keyboard, you may have accidentally replaced the driver for the keyboard itself instead of for the bootloader. This can happen when the keyboard is not in the boo
|
|||
|
|
const _hoisted_36 = [
|
|||
|
|
_hoisted_1
|
|||
|
|
];
|
|||
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|||
|
|
return openBlock(), createElementBlock("div", null, _hoisted_36);
|
|||
|
|
}
|
|||
|
|
const driver_installation_zadig = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|||
|
|
export {
|
|||
|
|
__pageData,
|
|||
|
|
driver_installation_zadig as default
|
|||
|
|
};
|