qmk_firmware/feature_send_string.html

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>Send String | 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.DWuET1QV.css" as="style">
    
    <script type="module" src="/assets/app.D4WigKuz.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.BUy7YO2h.js">
    <link rel="modulepreload" href="/assets/feature_send_string.md.ucKdf_1f.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 style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    switch</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (keycode) {</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">        case</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> SS_HELLO:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">            if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (record</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">-&gt;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">event.pressed) {</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">                SEND_STRING</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;Hello, world!</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">\n</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;</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:#D73A49;--shiki-dark:#F97583;">            return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> false</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>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">    return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> true</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><h3 id="example-keycode-injection" tabindex="-1">Keycode Injection <a class="header-anchor" href="#example-keycode-injection" aria-label="Permalink to &quot;Keycode Injection {#example-keycode-injection}&quot;"></a></h3><p>This example types out opening and closing curly braces, then taps the left arrow key to move the cursor between the two.</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:#6F42C1;--shiki-dark:#B392F0;">SEND_STRING</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;{}&quot;</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> SS_TAP</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(X_LEFT));</span></span></code></pre></div><p>This example types Ctrl+A, then Ctrl+C, without releasing Ctrl.</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:#6F42C1;--shiki-dark:#B392F0;">SEND_STRING</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">SS_LCTL</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;ac&quot;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">));</span></span></code></pre></div><h2 id="api" tabindex="-1">API <a class="header-anchor" href="#api" aria-label="Permalink to &quot;API {#api}&quot;"></a></h2><h3 id="api-send-string" tabindex="-1"><code>void send_string(const char *string)</code> <a class="header-anchor" href="#api-send-string" aria-label="Permalink to &quot;`void send_string(const char *string)` {#api-send-string}&quot;"></a></h3><p>Type out a string of ASCII characters.</p><p>This function simply calls <code>send_string_with_delay(string, 0)</code>.</p><h4 id="api-send-string-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-send-string-arguments" aria-label="Permalink to &quot;Arguments {#api-send-string-arguments}&quot;"></a></h4><ul><li><code>const char *string</code><br> The string to type out.</li></ul><hr><h3 id="api-send-string-with-delay" tabindex="-1"><code>void send_string_with_delay(const char *string, uint8_t interval)</code> <a class="header-anchor" href="#api-send-string-with-delay" aria-label="Permalink to &quot;`void send_string_with_delay(const char *string, uint8_t interval)` {#api-send-string-with-delay}&quot;"></a></h3><p>Type out a string of ASCII characters, with a delay between each character.</p><h4 id="api-send-string-with-delay-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-send-string-with-delay-arguments" aria-label="Permalink to &quot;Arguments {#api-send-string-with-delay-arguments}&quot;"></a></h4><ul><li><code>const char *string</code><br> The string to type out.</li><li><code>uint8_t interval</code><br> The amount of time, in milliseconds, to wait before typing the next character.</li></ul><hr><h3 id="api-send-string-p" tabindex="-1"><code>void send_string_P(const char *string)</code> <a class="header-anchor" href="#api-send-string-p" aria-label="Permalink to &quot;`void send_string_P(const char *string)` {#api-send-string-p}&quot;"></a></h3><p>Type out a PROGMEM string of ASCII characters.</p><p>On ARM devices, this function is simply an alias for <code>send_string_with_delay(string, 0)</code>.</p><h4 id="api-send-string-p-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-send-string-p-arguments" aria-label="Permalink to &quot;Arguments {#api-send-string-p-arguments}&quot;"></a></h4><ul><li><code>const cha
    <script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20210227.md\":\"BWOtCaeS\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20220827.md\":\"I6ja7C5w\",\"faq_build.md\":\"Bryo1ywz\",\"driver_installation_zadig.md\":\"BIO-iq8r\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"configurator_step_by_step.md\":\"GvmPtScT\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"contributing.md\":\"DLsp4vSA\",\"feature_digitizer.md\":\"XYO9R19s\",\"feature_advanced_keycodes.md\":\"jN1BLaPG\",\"eeprom_driver.md\":\"CJGhJYmK\",\"breaking_changes_history.md\":\"CkzdD6x8\",\"changelog_20190830.md\":\"Drtq3lMy\",\"breaking_changes.md\":\"BtdqWQlY\",\"configurator_architecture.md\":\"DEFTvTlS\",\"feature_key_lock.md\":\"DBAH_Fju\",\"breaking_changes_instructions.md\":\"BAjIGeJb\",\"custom_quantum_functions.md\":\"BabGw-ye\",\"changelog_20220528.md\":\"BdSPPJS6\",\"feature_key_overrides.md\":\"DXeoCP3-\",\"feature_backlight.md\":\"DBI0guDv\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"custom_matrix.md\":\"DMnRw_5l\",\"api_docs.md\":\"CRoD6CbL\",\"arm_debugging.md\":\"BH-H2Ukz\",\"changelog_20210529.md\":\"CR1YNfZX\",\"config_options.md\":\"D0qoSxZG\",\"feature_caps_word.md\":\"DFEidvi5\",\"data_driven_config.md\":\"BvLQ7P20\",\"documentation_templates.md\":\"Bhkum0wD\",\"easy_maker.md\":\"BLadB4D_\",\"feature_auto_shift.md\":\"0xqmu9IK\",\"feature_haptic_feedback.md\":\"CI5hNqfq\",\"changelog_20211127.md\":\"BDzkUAQX\",\"changelog_20200829.md\":\"CoqrOffn\",\"feature_led_indicators.md\":\"CZMu7H5E\",\"changelog_20220226.md\":\"Ee8ZP8S1\",\"feature_led_matrix.md\":\"xGxJCIdk\",\"feature_combo.md\":\"BFcSajDz\",\"feature_command.md\":\"DyD1wEzr\",\"feature_converters.md\":\"Bmv29bqN\",\"feature_dip_switch.md\":\"BRm_919T\",\"faq_misc.md\":\"qGrhOTu4\",\"feature_dynamic_macros.md\":\"CQqgFNCL\",\"newbs_flashing.md\":\"B42m5Wln\",\"newbs_getting_started.md\":\"DD4a5qPC\",\"feature_rawhid.md\":\"_qE_L8rS\",\"newbs_git_best_practices.md\":\"BI2-EVI5\",\"newbs_git_resolving_merge_conflicts.md\":\"72w3BRmm\",\"newbs_git_resynchronize_a_branch.md\":\"YGDefQFx\",\"newbs_git_using_your_master_branch.md\":\"B9DxZCl8\",\"flashing_bootloadhid.md\":\"aXGP0bN5\",\"getting_started_docker.md\":\"mz6HE4Bl\",\"getting_started_github.md\":\"OYq7IT7B\",\"getting_started_introduction.md\":\"BOJreqSs\",\"getting_started_make_guide.md\":\"fsRi0mqX\",\"gpio_control.md\":\"BXAY05Da\",\"hand_wire.md\":\"CieyXSH7\",\"feature_repeat_key.md\":\"D8sTeKpj\",\"feature_ps2_mouse.md\":\"DgKRvSpd\",\"hardware_drivers.md\":\"DFF5LGTT\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"feature_macros.md\":\"DpKdCniT\",\"feature_os_detection.md\":\"DZib_QdQ\",\"newbs_testing_debugging.md\":\"D-c7Gle_\",\"feature_mouse_keys.md\":\"Iyt3Hb3p\",\"one_shot_keys.md\":\"QR09rSb-\",\"feature_swap_hands.md\":\"DYy3Hkxa\",\"other_eclipse.md\":\"C-zqyJO9\",\"other_vscode.md\":\"Di3vOySR\",\"platformdev_proton_c.md\":\"CDRuJBvD\",\"platformdev_selecting_arm_mcu.md\":\"aF4DUsvb\",\"feature_grave_esc.md\":\"Dfk03Mwq\",\"porting_your_keyboard_to_qmk.md\":\"YHGsI2lB\",\"pr_checklist.md\":\"B5cKcG_-\",\"feature_pointing_device.md\":\"D8bKydDH\",\"quantum_keycodes.md\":\"DM5WeUFF\",\"feature_programmable_button.md\":\"BP5-HUlT\",\"platformdev_chibios_earlyinit.md\":\"BQJSTP3y\",\"hardware_keyboard_guidelines.md\":\"D6JrfTvT\",\"flashing.md\":\"CGYYQUk5\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"platformdev_rp2040.md\":\"Ca0zZxM4\",\"quantum_painter_qff.md\":\"kLNwshez\",\"quantum_painter_qgf.md\":\"BJNSu2s0\",\"quantum_painter_rle.md\":\"B07V3m-n\",\"ref_functions.md\":\"BqUSY2Jo\",\"feature_joystick.md\":\"BQEb6YMp\",\"changelog_20230827.md\":\"CkGh7Wzq\",\"quantum_painter_lvgl.md\":\"DobNbSgA\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"documentation_best_practices.md\":\"D_UwEt1C\",\"feature_unicode.md\":\"D_2PhXnL\",\"faq_debug.md\":\"uJtFRvCN\",\"cli_development.md\":\"CczMJOE3\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"platformdev_blackpill_f4x1.md\":\"DvObLRuk\",\"feature_bootmagic.md\":\"C
    
  </body>
</html>