qmk_firmware/hand_wire.html

31 lines
124 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>Hand-Wiring Guide | 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.No8zk9aC.css" as="style">
<script type="module" src="/assets/app.CCoOhqDj.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.CQFLh8V5.js">
<link rel="modulepreload" href="/assets/hand_wire.md.CcI1spCv.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="/qmk-logo-dark.svg" alt data-v-8426fc1a><!--]--><!--[--><img class="VPImage light logo" src="/qmk-logo-light.svg" alt data-v-8426fc1a><!--]--><!--]--><!--]--><span data-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></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
<span class="line"><span>Ψ Importing gh62.json.</span></span>
<span class="line"><span></span></span>
<span class="line"><span>⚠ Support here is basic - Consider using &#39;qmk new-keyboard&#39; instead</span></span>
<span class="line"><span>Ψ Imported a new keyboard named gh62.</span></span>
<span class="line"><span>Ψ To start working on things, `cd` into keyboards/gh62,</span></span>
<span class="line"><span>Ψ or open the directory in your preferred text editor.</span></span>
<span class="line"><span>Ψ And build with qmk compile -kb gh62 -km default.</span></span></code></pre></div><h2 id="flashing-the-firmware" tabindex="-1">Flashing the Firmware <a class="header-anchor" href="#flashing-the-firmware" aria-label="Permalink to &quot;Flashing the Firmware&quot;"></a></h2><p>Install <a href="https://github.com/qmk/qmk_toolbox" target="_blank" rel="noreferrer">QMK Toolbox</a>.</p><p><img src="https://raw.githubusercontent.com/noroadsleft/qmk_images/master/docs/hand_wire/qmk_toolbox.png" alt="QMK Toolbox" title="QMK Toolbox 0.0.16 on Windows 8.1"></p><p>Under &quot;Local File&quot; navigate to your newly created .hex file. Under &quot;Microcontroller&quot;, select the corresponding one for your controller board (common ones available <a href="#common-microcontroller-boards">here</a>).</p><p>Plug in your keyboard and press the reset button (or short the Reset and Ground pins if there is no button) and click the &quot;Flash&quot; button in QMK toolbox.</p><h2 id="testing-your-firmware" tabindex="-1">Testing Your Firmware <a class="header-anchor" href="#testing-your-firmware" aria-label="Permalink to &quot;Testing Your Firmware&quot;"></a></h2><p>Use a website such as <a href="https://config.qmk.fm/#/test" target="_blank" rel="noreferrer">QMK Configurator&#39;s Keyboard Tester</a>, <a href="https://www.keyboardtester.com/tester.html" target="_blank" rel="noreferrer">Keyboard Tester</a>, or <a href="https://keyboardchecker.com/" target="_blank" rel="noreferrer">Keyboard Checker</a> or just open a text editor and try typing - you should get the characters that you put into your keymap. Test each key, and make a note of the ones that aren&#39;t working. Here&#39;s a quick trouble-shooting guide for non-working keys:</p><ol><li>Flip the keyboard back over and short the keyswitch&#39;s contacts with a piece wire - this will eliminate the possibility of the keyswitch being bad and needing to be replaced.</li><li>Check the solder points on the keyswitch - these need to be plump and whole. If you touch it with a moderate amount of force and it comes apart, it&#39;s not strong enough.</li><li>Check the solder joints on the diode - if the diode is loose, part of your row may register, while the other may not.</li><li>Check the solder joints on the columns - if your column wiring is loose, part or all of the column may not work.</li><li>Check the solder joints on both sides of the wires going to/from the Teensy - the wires need to be fully soldered and connect to both sides.</li><li>Check the <code>&lt;project_name&gt;.h</code> file for errors and incorrectly placed <code>KC_NO</code>s - if you&#39;re unsure where they should be, instead duplicate a k<em>xy</em> variable.</li><li>Check to make sure you actually compiled the firmware and flashed the Teensy correctly. Unless you got error messages in the terminal, or a pop-up during flashing, you probably did everything correctly.</li><li>Use a multimeter to check that the switch is actually closing when actuated (completing the circuit when pressed down).</li></ol><p>If you&#39;ve done all of these things, keep in mind that sometimes you might have had multiple things affecting the keyswitch, so it doesn&#39;t hurt to test the keyswitch by shorting it out at the end.</p><h2 id="finishing-up" tabindex="-1">Finishing up <a class="header-anchor" href="#finishing-up" aria-label="Permalink to &quot;Finishing up&quot;"></a></h2><p>Once you have confirmed that the keyboard is working, if you have used a seperate (non handwire specific) controller you will want to secure it in place. This can be done in many different ways e.g. hot glue, double sided sticky tape, 3D printed caddy, electrical tape.</p><p>If you found this fullfilling you could experiment by adding additional features such as <a href="https://geekhack.org/index.php?topic=94258.0" target="_blank" rel="noreferrer">in switch LEDs</a>, <a href="https://www.reddit.com/r/MechanicalKeyboards/comments/5s1l5u/photoskeyboard_science_i_made_a_handwired_rgb/" target="_blank" rel="noreferrer">in switch RGB<
<script>window.__VP_HASH_MAP__=JSON.parse("{\"drivers_uart.md\":\"BNBs-m3h\",\"changelog_20211127.md\":\"ClUawWkq\",\"feature_macros.md\":\"By1M5R8G\",\"changelog_20210529.md\":\"CR1YNfZX\",\"changelog_20240225.md\":\"B4-WrXj6\",\"faq_keymap.md\":\"BsEmEZTo\",\"faq_misc.md\":\"qGrhOTu4\",\"api_development_overview.md\":\"Dcey4ntL\",\"capabilities_inc.md\":\"Ca9zpMce\",\"api_overview.md\":\"0FPaUsMb\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"feature_converters.md\":\"DFKin1io\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"feature_layouts.md\":\"qcy8hNMO\",\"changelog_20210828.md\":\"DNbHIuuM\",\"cli_commands.md\":\"DGx-qNiE\",\"changelog_20200829.md\":\"CoqrOffn\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"changelog_20190830.md\":\"Drtq3lMy\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"drivers_serial.md\":\"qxjytVdM\",\"changelog_20200229.md\":\"DNsowwM1\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"contributing.md\":\"DLsp4vSA\",\"data_driven_config.md\":\"BvLQ7P20\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"custom_quantum_functions.md\":\"DrUNiV1i\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_adc.md\":\"DzU8txf8\",\"custom_matrix.md\":\"DMnRw_5l\",\"drivers_audio.md\":\"mqaz6p5N\",\"changelog_20220827.md\":\"DjPthqDk\",\"changelog_20230827.md\":\"NSPhmB6l\",\"feature_userspace.md\":\"BsmY9yWw\",\"changelog_20210227.md\":\"BWOtCaeS\",\"capabilities.md\":\"DgKwcj5n\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"drivers_eeprom.md\":\"B_6soqar\",\"cli_development.md\":\"3xFA2OvS\",\"api_development_environment.md\":\"EhJClb9f\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"faq_build.md\":\"DL_WezA1\",\"changelog_20240526.md\":\"iGLFD0SP\",\"faq_debug.md\":\"DuThValw\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"api_docs.md\":\"CRoD6CbL\",\"cli.md\":\"BLzAdA6l\",\"cli_configuration.md\":\"CGSB128P\",\"arm_debugging.md\":\"BH-H2Ukz\",\"feature_eeprom.md\":\"a0eoTZm7\",\"configurator_architecture.md\":\"DEFTvTlS\",\"feature_layers.md\":\"8GwBUTZN\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"features_backlight.md\":\"D7R4FkYo\",\"features_autocorrect.md\":\"DHRDcuho\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"features_bluetooth.md\":\"CiAjl875\",\"changelog_20230528.md\":\"nX9R48zP\",\"drivers_flash.md\":\"DhWcHp8S\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"getting_started_introduction.md\":\"BOJreqSs\",\"index.md\":\"B4QYzvHE\",\"hardware_keyboard_guidelines.md\":\"CJevsanE\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"isp_flashing_guide.md\":\"BiuBpOKX\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3BRmm\",\"features_grave_esc.md\":\"mUNEjUYS\",\"changelog_20220226.md\":\"BWO5r_ec\",\"config_options.md\":\"DvMeqlpB\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_hd44780.md\":\"15K40o_e\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_key_lock.md\":\"IjFq9dYs\",\"features_led_indicators.md\":\"CCZhjHe9\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_midi.md\":\"u3tHPteB\",\"features_mouse_keys.md\":\"C3P3pYuE\",\"features_led_matrix.md\":\"CrqL4fqO\",\"features_programmable_button.md\":\"D332w_PT\",\"features_ps2_mouse.md\":\"CL_pA9sk\",\"features_oled_driver.md\":\"D9wJVdL1\",\"features_pointing_device.md\":\"DP6-XwL6\",\"features_repeat_key.md\":\"C3eWDUWn\",\"features_sequencer.md\":\"DkgqNCsQ\",\"features_st7565.md\":\"MoajNurJ\",\"features_audio.md\":\"DWNYte3W\",\"features_stenography.md\":\"Bb_IhUGl\",\"features_send_string.md\":\"vM68un4v\",\"features_auto_shift.md\":\"B9HLt3QM\",\"features_swap_hands.md\":\"DOhgGQf9\",\"faq_general.md\":\"BC3pFw4U\",\"features_wpm.md\":\"BYf-Xc1H\",\"keycodes.md\":\"hkOkKJ
</body>
</html>