mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-02-27 01:56:43 +00:00
16 lines
15 KiB
JavaScript
16 lines
15 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":"Debugging FAQ","description":"","frontmatter":{},"headers":[],"relativePath":"faq_debug.md","filePath":"faq_debug.md"}');
|
|||
|
|
const _sfc_main = { name: "faq_debug.md" };
|
|||
|
|
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="debugging-faq" tabindex="-1">Debugging FAQ <a class="header-anchor" href="#debugging-faq" aria-label="Permalink to "Debugging FAQ""></a></h1><p>This page details various common questions people have about troubleshooting their keyboards.</p><h2 id="debugging" tabindex="-1">Debugging <a class="header-anchor" href="#debugging" aria-label="Permalink to "Debugging {#debugging}""></a></h2><p>Your keyboard will output debug information if you have <code>CONSOLE_ENABLE = yes</code> in your <code>rules.mk</code>. By default the output is very limited, but you can turn on debug mode to increase the amount of debug output. Use the <code>DB_TOGG</code> keycode in your keymap, use the <a href="./features/command">Command</a> feature to enable debug mode, or add the following code to your keymap.</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;">void</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> keyboard_post_init_user</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Customise these values to desired behaviour</span></span>\n<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> debug_enable</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>\n<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> debug_matrix</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">true</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> //debug_keyboard=true;</span></span>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> //debug_mouse=true;</span></span>\n<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h2 id="debugging-tools" tabindex="-1">Debugging Tools <a class="header-anchor" href="#debugging-tools" aria-label="Permalink to "Debugging Tools""></a></h2><p>Various tools are available to debug your keyboard.</p><h3 id="debugging-with-qmk-toolbox" tabindex="-1">Debugging With QMK Toolbox <a class="header-anchor" href="#debugging-with-qmk-toolbox" aria-label="Permalink to "Debugging With QMK Toolbox""></a></h3><p>For compatible platforms, <a href="https://github.com/qmk/qmk_toolbox" target="_blank" rel="noreferrer">QMK Toolbox</a> can be used to display debug messages from your keyboard.</p><h3 id="debugging-with-qmk-cli" tabindex="-1">Debugging with QMK CLI <a class="header-anchor" href="#debugging-with-qmk-cli" aria-label="Permalink to "Debugging with QMK CLI""></a></h3><p>Prefer a terminal based solution? The <a href="./cli_commands#qmk-console">QMK CLI console command</a> can be used to display debug messages from your keyboard.</p><h3 id="debugging-with-hid-listen" tabindex="-1">Debugging With hid_listen <a class="header-anchor" href="#debugging-with-hid-listen" aria-label="Permalink to "Debugging With hid_listen""></a></h3><p>Something stand-alone? <a href="https://www.pjrc.com/teensy/hid_listen.html" target="_blank" rel="noreferrer">hid_listen</a>, provided by PJRC, can also be used to display debug messages. Prebuilt binaries for Windows,Linux,and MacOS are available.</p><h2 id="debug-api" tabindex="-1">Sending Your Own Debug Messages <a class="he
|
|||
|
|
const _hoisted_44 = [
|
|||
|
|
_hoisted_1
|
|||
|
|
];
|
|||
|
|
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
|||
|
|
return openBlock(), createElementBlock("div", null, _hoisted_44);
|
|||
|
|
}
|
|||
|
|
const faq_debug = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
|||
|
|
export {
|
|||
|
|
__pageData,
|
|||
|
|
faq_debug as default
|
|||
|
|
};
|