gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2024-11-29 14:40:38 +00:00
Code Issues Packages Projects Releases Wiki Activity
363861f920
qmk_firmware/api_overview.html

24 lines
97 KiB
HTML
Raw Normal View History

Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
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>QMK API | QMK Firmware</title>
<meta name="description" content="Documentation for QMK Firmware">
<meta name="generator" content="VitePress v1.1.3">
Deploying to gh-pages from @ qmk/qmk_firmware@119e54e9e3db66355a07be5f8db9fcc81b65f1ff 🚀
2024-05-31 00:38:24 +00:00
<link rel="preload stylesheet" href="/assets/style.No8zk9aC.css" as="style">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
Deploying to gh-pages from @ qmk/qmk_firmware@fa403562500e1229256ea355d36a8bf4c7967021 🚀
2024-06-13 02:00:59 +00:00
<script type="module" src="/assets/app.CnaJS-jf.js"></script>
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<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">
Deploying to gh-pages from @ qmk/qmk_firmware@fa403562500e1229256ea355d36a8bf4c7967021 🚀
2024-06-13 02:00:59 +00:00
<link rel="modulepreload" href="/assets/chunks/theme.nRuh9auX.js">
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
<link rel="modulepreload" href="/assets/api_overview.md.0FPaUsMb.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>
Deploying to gh-pages from @ qmk/qmk_firmware@7247039742fb81cbf1e443c23a8070afb5961762 🚀
2024-06-13 01:57:12 +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
Deploying to gh-pages from @ qmk/qmk_firmware@fa403562500e1229256ea355d36a8bf4c7967021 🚀
2024-06-13 02:00:59 +00:00
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20220528.md\":\"BX3CCY1Z\",\"changelog_20210227.md\":\"BWOtCaeS\",\"breaking_changes.md\":\"BtdqWQlY\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"changelog_20200829.md\":\"CoqrOffn\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20230827.md\":\"NSPhmB6l\",\"capabilities_inc.md\":\"Ca9zpMce\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"api_development_environment.md\":\"EhJClb9f\",\"changelog_20220226.md\":\"BWO5r_ec\",\"changelog_20201128.md\":\"7XXL02Bn\",\"api_overview.md\":\"0FPaUsMb\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"cli.md\":\"BLzAdA6l\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"cli_development.md\":\"3xFA2OvS\",\"changelog_20190830.md\":\"Drtq3lMy\",\"changelog_20210529.md\":\"CR1YNfZX\",\"capabilities.md\":\"DgKwcj5n\",\"changelog_20240225.md\":\"B4-WrXj6\",\"data_driven_config.md\":\"BvLQ7P20\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"configurator_architecture.md\":\"DEFTvTlS\",\"features_backlight.md\":\"D7R4FkYo\",\"changelog_20240526.md\":\"DAmAEDG5\",\"mod_tap.md\":\"C7wRKLcf\",\"cli_commands.md\":\"DGx-qNiE\",\"changelog_20220827.md\":\"DjPthqDk\",\"changelog_20230528.md\":\"nX9R48zP\",\"custom_matrix.md\":\"DMnRw_5l\",\"custom_quantum_functions.md\":\"DrUNiV1i\",\"compatible_microcontrollers.md\":\"6HA6FJZJ\",\"feature_layers.md\":\"8GwBUTZN\",\"feature_layouts.md\":\"qcy8hNMO\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"features_audio.md\":\"DWNYte3W\",\"keycodes.md\":\"hkOkKJPh\",\"features_auto_shift.md\":\"B9HLt3QM\",\"keycodes_magic.md\":\"CGO3hgMm\",\"keycodes_basic.md\":\"CHIeCvwn\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"drivers_adc.md\":\"DzU8txf8\",\"drivers_apa102.md\":\"Qb-KXRpF\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_eeprom.md\":\"B_6soqar\",\"drivers_flash.md\":\"DhWcHp8S\",\"drivers_gpio.md\":\"C5PvyJVh\",\"drivers_i2c.md\":\"Cuj87reB\",\"drivers_serial.md\":\"qxjytVdM\",\"drivers_uart.md\":\"BNBs-m3h\",\"drivers_spi.md\":\"tJVeIT7e\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"easy_maker.md\":\"DAfbIK4w\",\"faq_build.md\":\"DL_WezA1\",\"faq_general.md\":\"BC3pFw4U\",\"faq_debug.md\":\"DuThValw\",\"faq_keymap.md\":\"BsEmEZTo\",\"cli_configuration.md\":\"CGSB128P\",\"faq_misc.md\":\"qGrhOTu4\",\"contributing.md\":\"DLsp4vSA\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"changelog_20210828.md\":\"DNbHIuuM\",\"features_led_indicators.md\":\"CCZhjHe9\",\"platformdev_rp2040.md\":\"CYKYMDfc\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"features_midi.md\":\"u3tHPteB\",\"porting_your_keyboard_to_qmk.md\":\"CGlGdFj4\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"changelog_20211127.md\":\"ClUawWkq\",\"features_os_detection.md\":\"DZKTWvSd\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"quantum_painter_qff.md\":\"kLNwshez\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"features_oled_driver.md\":\"D9wJVdL1\",\"features_ps2_mouse.md\":\"CL_pA9sk\",\"features_digitizer.md\":\"DGIGZFVx\",\"features_dip_switch.md\":\"DtBOdc98\",\"features_dynamic_macros.md\":\"CrJ1vhBA\",\"features_secure.md\":\"BX7jFvW5\",\"features_haptic_feedback.md\":\"DS8CmC7e\",\"features_hd44780.md\":\"15K40o_e\",\"features_sequencer.md\":\"DkgqNCsQ\",\"features_space_cadet.md\":\"DmNfYRVJ\",\"features_split_keyboard.md\":\"mMTUzI5n\",\"features_joystick.md\":\"CW0gZHec\",\"other_vscode.md\":\"Di3vOySR\",\"features_stenography.md\":\"Bb_IhUGl\",\"features_leader_key.md\":\"DBQTnBRh\",\"features_key_overrides.md\":\"rVTP6kn9\",\"features_bluetooth.md\":\"CiAjl875\",\"pr_checklist.md\":\"BnrDXG2G\",\"other_eclipse.md\":\"C-zqyJO9\",\"features_unicode.md\":\"CsON-fJH\",\"flashing_bootl
Deploying to gh-pages from @ qmk/qmk_firmware@6ef97172889ccd5db376b2a9f8825489e24fdac4 🚀
2024-05-30 02:02:10 +00:00
</body>
</html>
Reference in New Issue Copy Permalink