mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-02 07:55:12 +00:00
35 lines
110 KiB
HTML
35 lines
110 KiB
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>IS31FL3218 Driver | 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.CJtVUzpb.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.Cqpp2VIn.js">
|
|||
|
|
<link rel="modulepreload" href="/assets/drivers_is31fl3218.md.C7Rok4l6.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 4
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SRC += is31fl3218-mono.c </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># For single-color</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SRC += is31fl3218.c </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># For RGB</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">I2C_DRIVER_REQUIRED = yes</span></span></code></pre></div><h2 id="basic-configuration" tabindex="-1">Basic Configuration <a class="header-anchor" href="#basic-configuration" aria-label="Permalink to "Basic Configuration {#basic-configuration}""></a></h2><p>Add the following to your <code>config.h</code>:</p><table><thead><tr><th>Define</th><th>Default</th><th>Description</th></tr></thead><tbody><tr><td><code>IS31FL3218_SDB_PIN</code></td><td><em>Not defined</em></td><td>The GPIO pin connected to the driver's shutdown pin</td></tr><tr><td><code>IS31FL3218_I2C_TIMEOUT</code></td><td><code>100</code></td><td>The I²C timeout in milliseconds</td></tr><tr><td><code>IS31FL3218_I2C_PERSISTENCE</code></td><td><code>0</code></td><td>The number of times to retry I²C transmissions</td></tr></tbody></table><h3 id="i2c-addressing" tabindex="-1">I²C Addressing <a class="header-anchor" href="#i2c-addressing" aria-label="Permalink to "I²C Addressing {#i2c-addressing}""></a></h3><p>The IS31FL3218's 7-bit I²C address is <code>0x54</code>, available as <code>IS31FL3218_I2C_ADDRESS</code>.</p><h2 id="arm-configuration" tabindex="-1">ARM/ChibiOS Configuration <a class="header-anchor" href="#arm-configuration" aria-label="Permalink to "ARM/ChibiOS Configuration {#arm-configuration}""></a></h2><p>Depending on the ChibiOS board configuration, you may need to <a href="./i2c#arm-configuration">enable and configure I²C</a> at the keyboard level.</p><h2 id="led-mapping" tabindex="-1">LED Mapping <a class="header-anchor" href="#led-mapping" aria-label="Permalink to "LED Mapping {#led-mapping}""></a></h2><p>In order to use this driver, each output must be mapped to an LED index, by adding the following to your <code><keyboardname>.c</code>:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> is31fl3218_led_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3218_leds</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3218_LED_COUNT] </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* R G B */</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {OUT1, OUT2, OUT3},</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // etc...</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span></code></pre></div><p>In this example, the red, green and blue channels for the first LED index all have their anodes connected to <code>VCC</code>, and their cathodes on the <code>OUT1</code>, <code>OUT2</code> and <code>OUT3</code> pins respectively.</p><p>For the single-color driver, the principle is the same, but there is only one channel:</p><div class="language-c vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">c</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> is31fl3218_led_t</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3218_leds</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3218_LED_COUNT] </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* V */</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {OUT1},</span></span>
|
|||
|
|
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // etc...</span></span>
|
|||
|
|
<span class="line"><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 "API {#api}""></a></h2><h3 id="api-is31fl3218-led-t" tabindex="-1"><code>struct is31fl3218_led_t</code> <a class="header-anchor" href="#api-is31fl3218-led-t" aria-label="Permalink to "`struct is31fl3218_led_t` {#api-is31fl3218-led-t}""></a></h3><p>Contains the PWM register addresses for a single RGB LED.</p><h4 id="api-is31fl3218-led-t-members" tabindex="-1">Members <a class="header-anchor" href="#api-is31fl3218-led-t-members" aria-label="Permalink to "Members {#api-is31fl3218-led-t-members}""></a></h4><ul><li><code>uint8_t r</code><br> The output PWM register address for the LED's red channel (RGB driver only).</li><li><code>uint8_t g</code><br> The output PWM register address for the LED's green channel (RGB driver only).</li><li><code>uint8_t b</code><br> The output PWM register address for the LED's blue channel (RGB driver only).</li><li><code>uint8_t v</code><br> The output PWM register address for the LED (single-color driver only).</li></ul><hr><h3 id="api-is31fl3218-init" tabindex="-1"><code>void is31fl3218_init(void)</code> <a class="header-anchor" href="#api-is31fl3218-init" aria-label="Permalink to "`void is31fl3218_init(void)` {#api-is31fl3218-init}""></a></h3><p>Initialize the LED driver. This function should be called first.</p><hr><h3 id="api-is31fl3218-write-register" tabindex="-1"><code>void is31fl3218_write_register(uint8_t reg, uint8_t data)</code> <a class="header-anchor" href="#api-is31fl3218-write-register" aria-label="Permalink to "`void is31fl3218_write_register(uint8_t reg, uint8_t data)` {#api-is31fl3218-write-register}""></a></h3><p>Set the value of the given register.</p><h4 id="api-is31fl3218-write-register-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-write-register-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-write-register-arguments}""></a></h4><ul><li><code>uint8_t reg</code><br> The register address.</li><li><code>uint8_t data</code><br> The value to set.</li></ul><hr><h3 id="api-is31fl3218-set-color" tabindex="-1"><code>void is31fl3218_set_color(int index, uint8_t red, uint8_t green, uint8_t blue)</code> <a class="header-anchor" href="#api-is31fl3218-set-color" aria-label="Permalink to "`void is31fl3218_set_color(int index, uint8_t red, uint8_t green, uint8_t blue)` {#api-is31fl3218-set-color}""></a></h3><p>Set the color of a single LED (RGB driver only). This function does not immediately update the LEDs; call <code>is31fl3218_update_pwm_buffers()</code> after you are finished.</p><h4 id="api-is31fl3218-set-color-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-color-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-color-arguments}""></a></h4><ul><li><code>int index</code><br> The LED index (ie. the index into the <code>g_is31fl3218_leds</code> array).</li><li><code>uint8_t red</code><br> The red value to set.</li><li><code>uint8_t green</code><br> The green value to set.</li><li><code>uint8_t blue</code><br> The blue value to set.</li></ul><hr><h3 id="api-is31fl3218-set-color-all" tabindex="-1"><code>void is31fl3218_set_color_all(uint8_t red, uint8_t green, uint8_t blue)</code> <a class="header-anchor" href="#api-is31fl3218-set-color-all" aria-label="Permalink to "`void is31fl3218_set_color_all(uint8_t red, uint8_t green, uint8_t blue)` {#api-is31fl3218-set-color-all}""></a></h3><p>Set the color of all LEDs (RGB driver only).</p><h4 id="api-is31fl3218-set-color-all-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-color-all-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-color-all-arguments}""></a></h4><ul><li><code>uint8_t red</code><br> The red value to set.</li><li><code>uint
|
|||
|
|
<script>window.__VP_HASH_MAP__=JSON.parse("{\"changelog_20200229.md\":\"DNsowwM1\",\"changelog_20190830.md\":\"Drtq3lMy\",\"drivers_aw20216s.md\":\"CgKehEzB\",\"arm_debugging.md\":\"BH-H2Ukz\",\"changelog_20220226.md\":\"BWO5r_ec\",\"api_overview.md\":\"0FPaUsMb\",\"drivers_eeprom.md\":\"DMr_G_5d\",\"breaking_changes_history.md\":\"CJNU0o77\",\"breaking_changes.md\":\"BWMhRDM2\",\"chibios_upgrade_instructions.md\":\"B5dMtL5R\",\"breaking_changes_instructions.md\":\"C99NYDjO\",\"changelog_20221126.md\":\"DpbrnXeC\",\"cli.md\":\"BLzAdA6l\",\"changelog_20211127.md\":\"ClUawWkq\",\"cli_tab_complete.md\":\"ChaxfzYo\",\"configurator_step_by_step.md\":\"CB5U_ksW\",\"contributing.md\":\"CgMx5YLW\",\"custom_matrix.md\":\"DMnRw_5l\",\"configurator_architecture.md\":\"DEFTvTlS\",\"cli_commands.md\":\"DGx-qNiE\",\"drivers_apa102.md\":\"Cl7Xer3S\",\"documentation_templates.md\":\"Bhkum0wD\",\"driver_installation_zadig.md\":\"CX9-BACt\",\"changelog_20210529.md\":\"CR1YNfZX\",\"api_development_overview.md\":\"Dcey4ntL\",\"changelog_20230827.md\":\"NSPhmB6l\",\"documentation_best_practices.md\":\"BtEjePaZ\",\"capabilities.md\":\"DgKwcj5n\",\"changelog_20200829.md\":\"CoqrOffn\",\"changelog_20230226.md\":\"Cg0AYxIn\",\"changelog_20220528.md\":\"BX3CCY1Z\",\"configurator_default_keymaps.md\":\"B3v8dlHd\",\"coding_conventions_c.md\":\"DdrpXBEh\",\"cli_development.md\":\"3xFA2OvS\",\"coding_conventions_python.md\":\"BV-OK1s5\",\"drivers_adc.md\":\"DzU8txf8\",\"configurator_troubleshooting.md\":\"BxGLPT8G\",\"drivers_is31fl3236.md\":\"BsbsN_Nu\",\"data_driven_config.md\":\"BvLQ7P20\",\"changelog_20201128.md\":\"7XXL02Bn\",\"changelog_20240825.md\":\"DV_RdVWK\",\"changelog_20231126.md\":\"D2Ok5QAf\",\"changelog_20210828.md\":\"DNbHIuuM\",\"drivers_gpio.md\":\"C5PvyJVh\",\"capabilities_inc.md\":\"Ca9zpMce\",\"changelog_20230528.md\":\"nX9R48zP\",\"config_options.md\":\"DvMeqlpB\",\"drivers_is31fl3741.md\":\"DzsuNWJt\",\"drivers_is31fl3742a.md\":\"CKPjB5T1\",\"faq_debug.md\":\"DuThValw\",\"drivers_ws2812.md\":\"D9E3Wb-Y\",\"features_os_detection.md\":\"DZKTWvSd\",\"faq_general.md\":\"BOlGsWSk\",\"easy_maker.md\":\"DAfbIK4w\",\"faq_keymap.md\":\"BsEmEZTo\",\"feature_advanced_keycodes.md\":\"CX8dJkY-\",\"changelog_20220827.md\":\"DjPthqDk\",\"feature_layouts.md\":\"qcy8hNMO\",\"drivers_audio.md\":\"mqaz6p5N\",\"drivers_is31fl3729.md\":\"uZAm-59P\",\"changelog_20210227.md\":\"BWOtCaeS\",\"features_led_matrix.md\":\"BTOvgNVe\",\"api_docs.md\":\"CRoD6CbL\",\"api_development_environment.md\":\"EhJClb9f\",\"features_led_indicators.md\":\"BI857zKH\",\"changelog_20240225.md\":\"B4-WrXj6\",\"drivers_is31fl3746a.md\":\"BFczK5c-\",\"changelog_20240526.md\":\"DAmAEDG5\",\"feature_userspace.md\":\"BsmY9yWw\",\"feature_converters.md\":\"DcwmzUcD\",\"drivers_is31fl3736.md\":\"Cr5SQU0k\",\"drivers_is31fl3218.md\":\"C7Rok4l6\",\"drivers_is31fl3731.md\":\"_mTT68lh\",\"features_midi.md\":\"u3tHPteB\",\"custom_quantum_functions.md\":\"Br1xUGGa\",\"features_mouse_keys.md\":\"DIChRnuA\",\"feature_debounce_type.md\":\"CUrSp0Iy\",\"faq_misc.md\":\"qGrhOTu4\",\"drivers_flash.md\":\"DhWcHp8S\",\"feature_layers.md\":\"8GwBUTZN\",\"features_audio.md\":\"DWNYte3W\",\"features_combo.md\":\"C-GfDyXJ\",\"features_split_keyboard.md\":\"C-blnyD_\",\"isp_flashing_guide.md\":\"BiuBpOKX\",\"features_autocorrect.md\":\"DHRDcuho\",\"features_bootmagic.md\":\"CeNSUsBQ\",\"features_oled_driver.md\":\"D9wJVdL1\",\"hand_wire.md\":\"GiNX60kU\",\"hardware_drivers.md\":\"BUnx48D9\",\"changelog_20200530.md\":\"Dk-vRpTQ\",\"how_a_matrix_works.md\":\"JINKbCuX\",\"getting_started_make_guide.md\":\"BjUuEnSh\",\"features_hd44780.md\":\"15K40o_e\",\"how_keyboards_work.md\":\"CB7z8ocb\",\"features_st7565.md\":\"MoajNurJ\",\"features_wpm.md\":\"BYf-Xc1H\",\"drivers_i2c.md\":\"Cuj87reB\",\"support.md\":\"Bj3JfaeV\",\"mod_tap.md\":\"C7wRKLcf\",\"features_rawhid.md\":\"bKKG3KCa\",\"drivers_is31fl3733.md\":\"B2SurzgJ\",\"cli_configuration.md\":\"CGSB128P\",\"drivers_is31fl3745.md\":\"CpCpR0Np\",\"hardware_keyboard_guidelines.md\":\"CJevsanE\",\"syllabus.md\":\"B_ARGkLg\",\"drivers_snled27351.md\":\
|
|||
|
|
|
|||
|
|
</body>
|
|||
|
|
</html>
|