qmk_firmware/assets/faq_misc.md.CrAryH8S.js

16 lines
11 KiB
JavaScript
Raw Normal View History

import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.Clpp4x2N.js";
const __pageData = JSON.parse('{"title":"Miscellaneous FAQ","description":"","frontmatter":{},"headers":[],"relativePath":"faq_misc.md","filePath":"faq_misc.md"}');
const _sfc_main = { name: "faq_misc.md" };
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="miscellaneous-faq" tabindex="-1">Miscellaneous FAQ <a class="header-anchor" href="#miscellaneous-faq" aria-label="Permalink to &quot;Miscellaneous FAQ&quot;"></a></h1><h2 id="testing" tabindex="-1">How do I test my keyboard? <a class="header-anchor" href="#testing" aria-label="Permalink to &quot;How do I test my keyboard? {#testing}&quot;"></a></h2><p>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="_blank" rel="noreferrer">QMK Configurator</a>&#39;s test mode to check your keyboard, even if it doesn&#39;t run QMK.</p><h2 id="safety-considerations" tabindex="-1">Safety Considerations <a class="header-anchor" href="#safety-considerations" aria-label="Permalink to &quot;Safety Considerations&quot;"></a></h2><p>You probably don&#39;t want to &quot;brick&quot; your keyboard, making it impossible to rewrite firmware onto it. Here are some of the parameters to show what things are (and likely aren&#39;t) too risky.</p><ul><li>If your keyboard map does not include QK_BOOT, then, to get into DFU mode, you will need to press the reset button on the PCB, which requires unscrewing the bottom.</li><li>Messing with tmk_core / common files might make the keyboard inoperable</li><li>Too large a .hex file is trouble; <code>make dfu</code> will erase the block, test the size (oops, wrong order!), which errors out, failing to flash the keyboard, leaving it in DFU mode. <ul><li>To this end, note that the maximum .hex file size on e.g. Planck is 7000h (28672 decimal)</li></ul></li></ul><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>Linking: .build/planck_rev4_cbbrowne.elf [OK]</span></span>\n<span class="line"><span>Creating load file for Flash: .build/planck_rev4_cbbrowne.hex [OK]</span></span>\n<span class="line"><span></span></span>\n<span class="line"><span>Size after:</span></span>\n<span class="line"><span> text data bss dec hex filename</span></span>\n<span class="line"><span> 0 22396 0 22396 577c planck_rev4_cbbrowne.hex</span></span></code></pre></div><ul><li>The above file is of size 22396/577ch, which is less than 28672/7000h</li><li>As long as you have a suitable alternative .hex file around, you can retry, loading that one</li><li>Some of the options you might specify in your keyboard&#39;s Makefile consume extra memory; watch out for BOOTMAGIC_ENABLE, MOUSEKEY_ENABLE, EXTRAKEY_ENABLE, CONSOLE_ENABLE</li><li>DFU tools do /not/ allow you to write into the bootloader (unless you throw in an extra fruit salad of options), so there is little risk there.</li><li>EEPROM has around a 100000 (100k) write cycle. You shouldn&#39;t rewrite the firmware repeatedly and continually; that&#39;ll burn the EEPROM eventually.</li></ul><h2 id="nkro-doesn-t-work" tabindex="-1">NKRO Doesn&#39;t work <a class="header-anchor" href="#nkro-doesn-t-work" aria-label="Permalink to &quot;NKRO Doesn&#39;t work&quot;"></a></h2><p>First you have to compile firmware with the build option <code>NKRO_ENABLE</code> in <strong>Makefile</strong>.</p><p>Try <code>Magic</code> <strong>N</strong> command(<code>LShift+RShift+N</code> by default) when <strong>NKRO</strong> still doesn&#39;t work. You can use this command to toggle between <strong>NKRO</strong> and <strong>6KRO</strong> mode temporarily. In some situations <strong>NKRO</strong> doesn&#39;t work and you will need to switch to <strong>6KRO</strong> mode, in particular when you are in BIOS.</p><h2 id="trackpoint-needs-reset-circuit-ps-2-mouse-support" tabindex="-1">TrackPoint Needs Reset Circuit (PS/2 Mouse Support) <a class="header-anchor" href="#trackpoint-needs-reset-circuit-ps-2-mouse-support" aria-label="P
const _hoisted_42 = [
_hoisted_1
];
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
return openBlock(), createElementBlock("div", null, _hoisted_42);
}
const faq_misc = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
export {
__pageData,
faq_misc as default
};