qmk_firmware/assets/faq_keymap.md.BsEmEZTo.js

16 lines
16 KiB
JavaScript
Raw Normal View History

import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js";
const __pageData = JSON.parse('{"title":"Keymap FAQ","description":"","frontmatter":{},"headers":[],"relativePath":"faq_keymap.md","filePath":"faq_keymap.md"}');
const _sfc_main = { name: "faq_keymap.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="keymap-faq" tabindex="-1">Keymap FAQ <a class="header-anchor" href="#keymap-faq" aria-label="Permalink to &quot;Keymap FAQ&quot;"></a></h1><p>This page covers questions people often have about keymaps. If you haven&#39;t you should read <a href="./keymap">Keymap Overview</a> first.</p><h2 id="what-keycodes-can-i-use" tabindex="-1">What Keycodes Can I Use? <a class="header-anchor" href="#what-keycodes-can-i-use" aria-label="Permalink to &quot;What Keycodes Can I Use?&quot;"></a></h2><p>See <a href="./keycodes">Keycodes</a> for an index of keycodes available to you. These link to more extensive documentation when available.</p><p>Keycodes are actually defined in <a href="https://github.com/qmk/qmk_firmware/blob/master/quantum/keycode.h" target="_blank" rel="noreferrer">quantum/keycode.h</a>.</p><h2 id="what-are-the-default-keycodes" tabindex="-1">What Are the Default Keycodes? <a class="header-anchor" href="#what-are-the-default-keycodes" aria-label="Permalink to &quot;What Are the Default Keycodes?&quot;"></a></h2><p>There are 3 standard keyboard layouts in use around the world- ANSI, ISO, and JIS. North America primarily uses ANSI, Europe and Africa primarily use ISO, and Japan uses JIS. Regions not mentioned typically use either ANSI or ISO. The keycodes corresponding to these layouts are shown here:</p><p><img src="https://i.imgur.com/5wsh5wM.png" alt="Keyboard Layout Image"></p><h2 id="how-can-i-make-custom-names-for-complex-keycodes" tabindex="-1">How Can I Make Custom Names For Complex Keycodes? <a class="header-anchor" href="#how-can-i-make-custom-names-for-complex-keycodes" aria-label="Permalink to &quot;How Can I Make Custom Names For Complex Keycodes?&quot;"></a></h2><p>Sometimes, for readability&#39;s sake, it&#39;s useful to define custom names for some keycodes. People often define custom names using <code>#define</code>. For example:</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;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> FN_CAPS</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(_FL, KC_CAPS)</span></span>\n<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> ALT_TAB</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> LALT</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(KC_TAB)</span></span></code></pre></div><p>This will allow you to use <code>FN_CAPS</code> and <code>ALT_TAB</code> in your keymap, keeping it more readable.</p><h2 id="my-keymap-doesn-t-update-when-i-flash-it" tabindex="-1">My Keymap Doesn&#39;t Update When I Flash It <a class="header-anchor" href="#my-keymap-doesn-t-update-when-i-flash-it" aria-label="Permalink to &quot;My Keymap Doesn&#39;t Update When I Flash It&quot;"></a></h2><p>This is usually due to VIA, and has to do with how it deals with keymaps.</p><p>On first run, the VIA code in the firmware will copy the keymap from flash memory into EEPROM so that it can be rewritten at runtime by the VIA app. From this point QMK will use the keymap stored in EEPROM instead of flash, and so updates to your <code>keymap.c</code> will not be reflected.</p><p>The simple fix for this is to clear the EEPROM. You can do this in several ways:</p><ul><li>Hold the Bootmagic Lite key (usually top left/Escape) while plugging the board in, which will also place the board into bootloader mode; then unplug and replug the board.</li><li>Press the <code>QK_CLEAR_EEPROM</code>/<code>EE_CLR</code> keycode if it is accessible on your keymap.</li><li>Place the board into bootloader mode and hit the &quot;Clear EEPROM&quot; button. This may not be available for all bootloaders, and you
const _hoisted_65 = [
_hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
return openBlock(), createElementBlock("div", null, _hoisted_65);
}
const faq_keymap = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
__pageData,
faq_keymap as default
};