2024-05-30 02:02:10 +00:00
<!DOCTYPE html>
< html lang = "en-US" dir = "ltr" >
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "width=device-width,initial-scale=1" >
< title > Adding Your Keyboard to QMK | QMK Firmware< / title >
< meta name = "description" content = "Documentation for QMK Firmware" >
< meta name = "generator" content = "VitePress v1.1.3" >
2024-05-31 00:38:24 +00:00
< link rel = "preload stylesheet" href = "/assets/style.No8zk9aC.css" as = "style" >
2024-05-30 02:02:10 +00:00
2024-11-17 15:07:13 +00:00
< script type = "module" src = "/assets/app.CfqZzuJx.js" > < / script >
2024-05-30 02:02:10 +00:00
< link rel = "preload" href = "/assets/inter-roman-latin.Di8DUHzh.woff2" as = "font" type = "font/woff2" crossorigin = "" >
2024-11-17 15:07:13 +00:00
< link rel = "modulepreload" href = "/assets/chunks/theme.BRt4GB_o.js" >
2024-09-24 08:56:37 +00:00
< link rel = "modulepreload" href = "/assets/chunks/framework.B9AX-CPi.js" >
2024-11-12 02:22:17 +00:00
< link rel = "modulepreload" href = "/assets/porting_your_keyboard_to_qmk.md.GXDU4XR5.lean.js" >
2024-05-30 02:02:10 +00:00
< 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 >
2024-11-09 19:05:30 +00:00
< 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 4
2024-05-30 02:02:10 +00:00
< span class = "line" > < span > Ψ Generating a new QMK keyboard directory< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Name Your Keyboard Project< / span > < / span >
< span class = "line" > < span > For more infomation, see:< / span > < / span >
< span class = "line" > < span > https://docs.qmk.fm/hardware_keyboard_guidelines#naming-your-keyboardproject< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > keyboard Name? mycoolkeeb< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Attribution< / span > < / span >
< span class = "line" > < span > Used for maintainer, copyright, etc< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Your GitHub Username? [jsmith] < / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > More Attribution< / span > < / span >
< span class = "line" > < span > Used for maintainer, copyright, etc< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Your Real Name? [John Smith] < / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Pick Base Layout< / span > < / span >
< span class = "line" > < span > As a starting point, one of the common layouts can be used to bootstrap the process< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > Default Layout? < / span > < / span >
< span class = "line" > < span > 1. 60_ansi< / span > < / span >
< span class = "line" > < span > ...< / span > < / span >
< span class = "line" > < span > 50. tkl_iso< / span > < / span >
< span class = "line" > < span > 51. none of the above< / span > < / span >
< span class = "line" > < span > Please enter your choice: [51] < / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > What Powers Your Project< / span > < / span >
< span class = "line" > < span > For more infomation, see:< / span > < / span >
< span class = "line" > < span > https://docs.qmk.fm/#/compatible_microcontrollers< / span > < / span >
< span class = "line" > < span > < / span > < / span >
< span class = "line" > < span > MCU? < / span > < / span >
< span class = "line" > < span > 1. atmega32u4< / span > < / span >
< span class = "line" > < span > ...< / span > < / span >
< span class = "line" > < span > 22. STM32F303< / span > < / span >
< span class = "line" > < span > Please enter your choice: [12]< / span > < / span >
< span class = "line" > < span > Ψ Created a new keyboard called mycoolkeeb.< / span > < / span >
< span class = "line" > < span > Ψ To start working on things, `cd` into keyboards/mycoolkeeb,< / 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 mycoolkeeb -km default.< / span > < / span > < / code > < / pre > < / div > < p > This will create all the files needed to support your new keyboard, and populate the settings with default values. Now you just need to customize it for your keyboard.< / p > < h2 id = "readme-md" tabindex = "-1" > < code > readme.md< / code > < a class = "header-anchor" href = "#readme-md" aria-label = "Permalink to "`readme.md`"" > < / a > < / h2 > < p > This is where you' ll describe your keyboard. Please follow the < a href = "./documentation_templates#keyboard-readmemd-template" > Keyboard Readme Template< / a > when writing your < code > readme.md< / code > . You' re encouraged to place an image at the top of your < code > readme.md< / code > , please use an external service such as < a href = "https://imgur.com" target = "_blank" rel = "noreferrer" > Imgur< / a > to host the images.< / p > < h2 id = "info-json" tabindex = "-1" > < code > info.json< / code > < a class = "header-anchor" href = "#info-json" aria-label = "Permalink to "`info.json`"" > < / a > < / h2 > < p > The < code > info.json< / code > file is where you configure the hardware and feature set for your keyboard. There are a lot of options that can be placed in that file, too many to list here. For a complete overview of available options see the < a href = "./reference_info_json" > Data Driven Configuration Options< / a > page.< / p > < h3 id = "hardware-configuration" tabindex = "-1" > Hardware Configuration < a class = "header-anchor" href = "#hardware-configuration" aria-label = "Permalink to "Hardware Configuration"" > < / a > < / h3 > < p > At the top of the < code > info.json< / code > you' ll find USB related settings. These control how your keyboard appears to the Operating System. If you don' t have a good reason to change you should leave the < code > usb.vid< / code > as < code > 0xFEED< / code > . For the < code > usb.pid< / code > you should pick a number that is not yet in use.< / p > < p > Do change the < code > manufacturer< / code > and < code > keyboard_name< / code > lines to accurately reflect your keyboard.< / p > < div class = "language-json vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > json< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " keyboard_name" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " my_awesome_keyboard" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ,< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " maintainer" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " You" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ,< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " usb" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " vid" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " 0xFEED" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ,< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " pid" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " 0x0000" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ,< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " device_version" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " 1.0.0" < / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span > < / code > < / pre > < / div > < div class = "tip custom-block" > < p class = "custom-block-title" > TIP< / p > < p > Windows and macOS will display the < code > manufacturer< / code > and < code > keyboard_name< / code > in the list of USB devices. < code > lsusb< / code > on Linux instead prefers the values in the list maintained by the < a href = "http://www.linux-usb.org/usb-ids.html" target = "_blank" rel = "noreferrer" > USB ID Repository< / a > . By default, it will only use < code > manufacturer< / code > and < code > keyboard_name< / code > if the list does not contain that < code > usb.vid< / code > / < code > usb.pid< / code > . < code > sudo lsusb -v< / code > will show the values reported by the device, and they are also present in kernel logs after plugging it in.< / p > < / div > < h3 id = "matrix-configuration" tabindex = "-1" > Matrix Configuration < a class = "header-anchor" href = "#matrix-configuration" aria-label = "Permalink to "Matrix Configuration"" > < / a > < / h3 > < p > The next section of the < code > info< / code > file deals with your keyboard' s matrix. The first thing you should define is which pins on your MCU are connected to rows and columns. To do so simply specify the names of those pins:< / p > < div class = "language-json vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > json< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " matrix_pins" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " cols" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C1" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C2" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C3" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C4" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ],< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " rows" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D1" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D2" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D3" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D4" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ]< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span > < / code > < / pre > < / div > < p > The size of the < code > matrix_pins.cols< / code > and < code > matrix_pins.rows< / code > arrays infer the size of the matrix (previously < code > MATRIX_ROWS< / code > and < code > MATRIX_COLS< / code > ).< / p > < p > Finally, you can specify the direction your diodes point. This can be < code > COL2ROW< / code > or < code > ROW2COL< / code > .< / p > < div class = "language-json vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > json< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " diode_direction" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " ROW2COL" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ,< / span > < / span > < / code > < / pre > < / div > < h4 id = "direct-pin-matrix" tabindex = "-1" > Direct Pin Matrix < a class = "header-anchor" href = "#direct-pin-matrix" aria-label = "Permalink to "Direct Pin Matrix"" > < / a > < / h4 > < p > To configure a keyboard where each switch is connected to a separate pin and ground instead of sharing row and column pins, use < code > matrix_pins.direct< / code > . The mapping defines the pins of each switch in rows and columns, from left to right. The size of the < code > matrix_pins.direct< / code > array infers the size of the matrix. Use < code > NO_PIN< / code > to fill in blank spaces. Overrides the behaviour of < code > diode_direction< / code > , < code > matrix_pins.cols< / code > and < code > matrix_pins.rows< / code > .< / p > < div class = "language-json vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > json< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " matrix_pins" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " direct" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " F1" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " E6" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B0" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B2" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B3" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ],< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " F5" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " F0" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B1" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B7" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D2" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ],< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " F6" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " F7" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C7" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D5" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " D3" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ],< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > [< / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B5" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " C6" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " B6" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " NO_PIN" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " NO_PIN" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ]< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ]< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span > < / code > < / pre > < / div > < h3 id = "layout-macros" tabindex = "-1" > Layout macros < a class = "header-anchor" href = "#layout-macros" aria-label = "Permalink to "Layout macros"" > < / a > < / h3 > < p > Next is configuring Layout Macro(s). These define the physical arrangement of keys, and its position within the matrix that a switch are connected to. This allows you to have a physical arrangement of keys that differs from the wiring matrix.< / p > < div class = "language-json vp-adaptive-theme" > < button title = "Copy Code" class = "copy" > < / button > < span class = "lang" > json< / span > < pre class = "shiki shiki-themes github-light github-dark vp-code" > < code > < span class = "line" > < span style = "--shiki-light:#032F62;--shiki-dark:#9ECBFF;" > " layouts" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " LAYOUT_ortho_4x4" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : {< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " layout" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 0< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 1< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 2< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > },< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > { < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " matrix" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : [< / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ], < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " x" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > , < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > " y" < / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > : < / span > < span style = "--shiki-light:#005CC5;--shiki-dark:#79B8FF;" > 3< / span > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > ]< / span > < / span >
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span >
2024-11-12 02:22:17 +00:00
< span class = "line" > < span style = "--shiki-light:#24292E;--shiki-dark:#E1E4E8;" > }< / span > < / span > < / code > < / pre > < / div > < p > In the above example,< / p > < ul > < li > < code > LAYOUT_ortho_4x4< / code > defines the name of the layout macro < ul > < li > It must conform to the < a href = "./hardware_keyboard_guidelines#keyboard-name-h" > layout guidelines< / a > < / li > < / ul > < / li > < li > < code > " matrix" : [0, 0]< / code > defines the electrical position< / li > < / ul > < div class = "tip custom-block" > < p class = "custom-block-title" > TIP< / p > < p > See also: < a href = "./features/split_keyboard#layout-macro" > Split Keyboard Layout Macro< / a > and < a href = "./understanding_qmk#matrix-to-physical-layout-map" > Matrix to Physical Layout< / a > .< / p > < / div > < h2 id = "additional-configuration" tabindex = "-1" > Additional Configuration < a class = "header-anchor" href = "#additional-configuration" aria-label = "Permalink to "Additional Configuration"" > < / a > < / h2 > < p > There are a lot of features that can be turned on or off, configured or tuned. Some of these have yet to be migrated over to < a href = "./data_driven_config" > Data Driven Configuration< / a > . The following sections cover the process for when an < code > info.json< / code > option is unavailable.< / p > < h3 id = "configuration-options" tabindex = "-1" > Configuration Options < a class = "header-anchor" href = "#configuration-options" aria-label = "Permalink to "Configuration Options"" > < / a > < / h3 > < p > For available options for < code > config.h< / code > , you should see the < a href = "./config_options#the-configh-file" > Config Options< / a > page for more details.< / p > < h3 id = "build-options" tabindex = "-1" > Build Options < a class = "header-anchor" href = "#build-options" aria-label = "Permalink to "Build Options"" > < / a > < / h3 > < p > For available options for < code > rules.mk< / code > , see the < a href = "./config_options#feature-options" > Config Options< / a > page for a detailed list and description.< / p > < / div > < / div > < / main > < footer class = "VPDocFooter" data-v-39a288b8 data-v-09de1c0f > <!-- [ --> <!-- ] --> < div class = "edit-info" data-v-09de1c0f > < div class = "edit-link" data-v-09de1c0f > < a class = "VPLink link vp-external-link-icon no-icon edit-link-button" href = "https://github.com/qmk/qmk_firmware/edit/master/docs/porting_your_keyboard_to_qmk.md" target = "_blank" rel = "noreferrer" data-v-09de1c0f > <!-- [ --> < span class = "vpi-square-pen edit-link-icon" data-v-09de1c0f > < / span > Edit this page<!-- ] --> < / a > < / div > <!-- --> < / div > < nav class = "prev-next" data-v-09de1c0f > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link prev" href = "/easy_maker" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Previous page< / span > < span class = "title" data-v-09de1c0f > Easy Maker for One Offs< / span > <!-- ] --> < / a > < / div > < div class = "pager" data-v-09de1c0f > < a class = "VPLink link pager-link next" href = "/hand_wire" data-v-09de1c0f > <!-- [ --> < span class = "desc" data-v-09de1c0f > Next page< / span > < span class = "title" data-v-09de1c0f > Hand Wiring Guide< / span > <!-- ] --> < / a > < / div > < / nav > < / footer > <!-- [ --> <!-- ] --> < / div > < / div > < / div > <!-- [ --> <!-- ] --> < / div > < / div > <!-- --> <!-- [ --> <!-- ] --> < / div > < / div >
2024-11-17 15:07:13 +00:00
< script > w i n d o w . _ _ V P _ H A S H _ M A P _ _ = J S O N . p a r s e ( " { \ " c h a n g e l o g _ 2 0 1 9 0 8 3 0 . m d \ " : \ " D 5 G v 0 x M 2 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 2 2 9 . m d \ " : \ " T B l k C y r 5 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 5 3 0 . m d \ " : \ " T I s D 4 I J 6 \ " , \ " c h a n g e l o g _ 2 0 2 0 0 8 2 9 . m d \ " : \ " D L R i c 7 T T \ " , \ " c h a n g e l o g _ 2 0 2 0 1 1 2 8 . m d \ " : \ " B a _ r F l x l \ " , \ " c h a n g e l o g _ 2 0 2 1 0 2 2 7 . m d \ " : \ " D v q X E R X t \ " , \ " c h a n g e l o g _ 2 0 2 1 0 5 2 9 . m d \ " : \ " D 6 J 1 R i d B \ " , \ " c h a n g e l o g _ 2 0 2 1 0 8 2 8 . m d \ " : \ " C 3 l F g q 5 A \ " , \ " c h a n g e l o g _ 2 0 2 1 1 1 2 7 . m d \ " : \ " K a w n p m K g \ " , \ " c h a n g e l o g _ 2 0 2 2 0 2 2 6 . m d \ " : \ " K L n m R n 9 F \ " , \ " c h a n g e l o g _ 2 0 2 2 0 5 2 8 . m d \ " : \ " B o u e 4 2 e A \ " , \ " c h a n g e l o g _ 2 0 2 2 0 8 2 7 . m d \ " : \ " B m G j S t e F \ " , \ " c h a n g e l o g _ 2 0 2 2 1 1 2 6 . m d \ " : \ " B 7 I F y k h d \ " , \ " c h a n g e l o g _ 2 0 2 3 0 2 2 6 . m d \ " : \ " t w C b P T 9 A \ " , \ " c h a n g e l o g _ 2 0 2 3 0 5 2 8 . m d \ " : \ " B z L L a F N h \ " , \ " c h a n g e l o g _ 2 0 2 3 0 8 2 7 . m d \ " : \ " B r h C S h V H \ " , \ " c h a n g e l o g _ 2 0 2 3 1 1 2 6 . m d \ " : \ " D V L m 2 e G v \ " , \ " c h a n g e l o g _ 2 0 2 4 0 2 2 5 . m d \ " : \ " C X S 3 F g K U \ " , \ " c h a n g e l o g _ 2 0 2 4 0 5 2 6 . m d \ " : \ " B M 7 f x Q B p \ " , \ " c h a n g e l o g _ 2 0 2 4 0 8 2 5 . m d \ " : \ " B D F Y 9 w p G \ " , \ " c a p a b i l i t i e s . m d \ " : \ " a _ N b g g 0 n \ " , \ " c a p a b i l i t i e s _ i n c . m d \ " : \ " C o r - l D I x \ " , \ " a p i _ d e v e l o p m e n t _ e n v i r o n m e n t . m d \ " : \ " p C Q R K F _ M \ " , \ " a p i _ d e v e l o p m e n t _ o v e r v i e w . m d \ " : \ " D i l Q x E a F \ " , \ " a p i _ d o c s . m d \ " : \ " C C H P m 9 P h \ " , \ " a p i _ o v e r v i e w . m d \ " : \ " B o 6 l - c 6 6 \ " , \ " a r m _ d e b u g g i n g . m d \ " : \ " D c r p f i y I \ " , \ " b r e a k i n g _ c h a n g e s . m d \ " : \ " T L I j t w O p \ " , \ " b r e a k i n g _ c h a n g e s _ h i s t o r y . m d \ " : \ " B 0 4 W e U P k \ " , \ " b r e a k i n g _ c h a n g e s _ i n s t r u c t i o n s . m d \ " : \ " y 3 u 4 r u Q J \ " , \ " c h i b i o s _ u p g r a d e _ i n s t r u c t i o n s . m d \ " : \ " p 6 u Z F 4 k P \ " , \ " c l i . m d \ " : \ " D 3 U Y W D O B \ " , \ " c l i _ c o m m a n d s . m d \ " : \ " D r l Y P V W R \ " , \ " c l i _ c o n f i g u r a t i o n . m d \ " : \ " g f t m l - G J \ " , \ " c l i _ d e v e l o p m e n t . m d \ " : \ " C V 5 X 2 u 0 i \ " , \ " c l i _ t a b _ c o m p l e t e . m d \ " : \ " B j h R 5 T F S \ " , \ " c o d i n g _ c o n v e n t i o n s _ c . m d \ " : \ " D D X r s q 6 j \ " , \ " c o d i n g _ c o n v e n t i o n s _ p y t h o n . m d \ " : \ " B p e Q I i J 8 \ " , \ " c o m p a t i b l e _ m i c r o c o n t r o l l e r s . m d \ " : \ " 1 j G d B N N O \ " , \ " c o n f i g _ o p t i o n s . m d \ " : \ " C 7 m T Z b M l \ " , \ " c o n f i g u r a t o r _ a r c h i t e c t u r e . m d \ " : \ " - 1 I a m g a M \ " , \ " c o n f i g u r a t o r _ d e f a u l t _ k e y m a p s . m d \ " : \ " p - G t 5 p n 7 \ " , \ " c o n f i g u r a t o r _ s t e p _ b y _ s t e p . m d \ " : \ " B Q X I 9 u d F \ " , \ " c o n f i g u r a t o r _ t r o u b l e s h o o t i n g . m d \ " : \ " A 5 M E d d 6 g \ " , \ " c o n t r i b u t i n g . m d \ " : \ " C J p S A - c 9 \ " , \ " c u s t o m _ m a t r i x . m d \ " : \ " B B j T 2 8 g r \ " , \ " c u s t o m _ q u a n t u m _ f u n c t i o n s . m d \ " : \ " 7 W t z p 8 l 7 \ " , \ " d a t a _ d r i v e n _ c o n f i g . m d \ " : \ " f J s S 9 Z q H \ " , \ " d o c u m e n t a t i o n _ b e s t _ p r a c t i c e s . m d \ " : \ " D G 9 1 a P m N \ " , \ " d o c u m e n t a t i o n _ t e m p l a t e s . m d \ " : \ " C 2 - r I f Q 7 \ " , \ " d r i v e r _ i n s t a l l a t i o n _ z a d i g . m d \ " : \ " C f s F e 7 C B \ " , \ " d r i v e r s _ a d c . m d \ " : \ " D E z k L X s b \ " , \ " d r i v e r s _ a p a 1 0 2 . m d \ " : \ " D Z y C h 2 H s \ " , \ " d r i v e r s _ a u d i o . m d \ " : \ " C u 5 C 6 1 s R \ " , \ " d r i v e r s _ a w 2 0 2 1 6 s . m d \ " : \ " C R G Z z 1 x Z \ " , \ " d r i v e r s _ e e p r o m . m d \ " : \ " D 2 I p 1 O A Y \ " , \ " d r i v e r s _ f l a s h . m d \ " : \ " B g L 2 P t m D \ " , \ " d r i v e r s _ g p i o . m d \ " : \ " C 4 g p R c o R \ " , \ " d r i v e r s _ i 2 c . m d \ " : \ " B A q 7 K L g N \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 1 8 . m d \ " : \ " D g f D K i 5 r \ " , \ " d r i v e r s _ i s 3 1 f l 3 2 3 6 . m d \ " : \ " D O 7 F G j N M \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 2 9 . m d \ " : \ " B m F D _ Y G z \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 1 . m d \ " : \ " k 9 w X g e x F \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 3 . m d \ " : \ " C T o v y g 7 g \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 6 . m d \ " : \ " C - i b q m v t \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 3 7 . m d \ " : \ " D u W 4 Y c q u \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 1 . m d \ " : \ " B d 8 t D E G h \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 2 a . m d \ " : \ " o 6 1 0 3 t 5 c \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 3 a . m d \ " : \ " e 2 x E X Y V f \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 5 . m d \ " : \ " C 0 V y p s O f \ " , \ " d r i v e r s _ i s 3 1 f l 3 7 4 6 a . m d \ " : \ " D c _ M B C T u \ " , \ " d r i v e r s _ s e r i a l . m d \ " : \ " C J R p A 3 o b \ " , \ " d r i v e r s _ s n l e d 2 7 3 5 1 . m d \ " : \ " D k o Z 0 n O F \ " , \ " d r i v e r s _ s p i . m d \ " : \ " D X i w w z u 8 \ " , \ " d r i v e r s _ u a r t . m d \ " : \ " D f V p z l t t \ " , \ " d r i v e r s _ w s 2 8 1 2 . m d \ " : \ " D t N m l J h 1 \ " , \ " e a s y _ m a k e r . m d \ " : \ " y f F L Y E Z u \ " , \ " f a q _ b u i l d . m d \ " : \ " C l A W 0 a M e \ " , \ " f a q _ d e b u g . m d \ " : \ " D a R q K H e t \ " , \ " f a q _ g e n e r a l . m d \ " : \ " 0 I x v 7 4 _ I \ " , \ " f a q _ k e y m a p . m d \ " : \ " B L l u C 4 N V \ " , \ " f a q _ m i s c . m d \ " : \ " C V t s e y 6 K \ " , \ " f e a t u r e _ a d v a n c e d _ k e y c o d e s . m d \ " : \ " C 2 i B p 6 m f \ " , \ " f e a t u r e _ c o n v e r t e r s . m d \ " : \ " D e k I O C A V \ " , \ " f e a t u r e _ d e b o u n c e _ t y p e . m d \ " : \ " C Y I y y h F B \ " , \ " f e a t u r e _ e e p r o m . m d \ " : \ " B h z y 4 R D v \ " , \ " f e a t u r e _ l a y e r s . m d \ " : \ " B q n v 5 M v Q \ " , \ " f e a t u r e _ l a y o u t s . m d \ " : \ " B K 7 v f Z u H \ " , \ " f e a t u r e _ m a c r o s . m d \ " : \ " 4 V v Y w f - t \ " , \ " f e a t u r e _ u s e r s p a c e . m d \ " : \ " C F 5 2 R h j y \ " , \ " f e a t u r e s _ a u d i o . m d \ " : \ " x Q 9 V R A s q \ " , \ " f e a t u r e s _ a u t o _ s h i f t . m d \ " : \ " D O c R L W q v \ " , \ " f e a t u r e s _ a u t o c o r r e c t . m d \ " : \ " i X m G H 9 e e \ " , \ " f e a t u r e s _ b a c k l i g h t . m d \ " : \ " B H T f R _ x i \ " , \ " f e a t u r e s _ b l u e t o o t h . m d \ " : \ " B V b 7 I Q e I \ " , \ " f e a t u r e s _ b o o t m a g i c . m d \ " : \ " B j D r Y O U H \ " , \ " f e a t u r e s _ c a p s _ w o r d . m d \ " : \ " C Y f Z h N N 7 \ " , \ " f e a t u r e s _ c o m b o . m d \ " : \ " v t m 8 h _ X K \ " , \ " f e a t u r e s _ c o m m a n d . m d \ " : \ " a j s j x 5 W c \ " , \ " f e a t u r e s _ d i g i t i z e r . m d \ " : \ " B o u F m M B P \ " , \ " f e a t u r e s _ d i p _ s w i t c h . m d \ " : \ " B p h p e X E 7 \ " , \ " f e a t u r e s _ d y n a m i c _ m a c r o s . m d \ " : \ " C n L D k Q K C \ " , \ " f e a t u r e s _ e n c o d e r s . m d \ " : \ " C G t g E W x D \ " , \ " f e a t u r e s _ g r a v e _ e s c . m d \ " : \ " D X E S 6 T t b \ " , \ " f e a t u r e s _ h a p t i c _ f e e d b a c k . m d \ " : \ " C O J 0 M 8 E 1 \ " , \ " f e a t u r e s _ h d 4
2024-05-30 02:02:10 +00:00
< / body >
< / html >
