<divid="app"><divclass="Layout"data-v-5d98c3a5><!--[--><!--]--><!--[--><spantabindex="-1"data-v-0f60ec36></span><ahref="#VPContent"class="VPSkipLink visually-hidden"data-v-0f60ec36> Skip to content </a><!--]--><!----><headerclass="VPNav"data-v-5d98c3a5data-v-ae24b3ad><divclass="VPNavBar has-sidebar top"data-v-ae24b3addata-v-ccf7ddec><divclass="wrapper"data-v-ccf7ddec><divclass="container"data-v-ccf7ddec><divclass="title"data-v-ccf7ddec><divclass="VPNavBarTitle has-sidebar"data-v-ccf7ddecdata-v-ab179fa1><aclass="title"href="/"data-v-ab179fa1><!--[--><!--]--><!--[--><!--[--><!--[--><imgclass="VPImage dark logo"src="/qmk-logo-dark.svg"altdata-v-8426fc1a><!--]--><!--[--><imgclass="VPImage light logo"src="/qmk-logo-light.svg"altdata-v-8426fc1a><!--]--><!--]--><!--]--><spandata-v-ab179fa1>QMK Firmware</span><!--[--><!--]--></a></div></div><divclass="content"data-v-ccf7ddec><divclass="content-body"data-v-ccf7ddec><!--[--><!--]--><divclass="VPNavBarSearch search"data-v-ccf7ddec><!--[--><!----><divid="local-search"><buttontype="button"class="DocSearch DocSearch-Button"aria-label="Search"><spanclass="DocSearch-Button-Container"><spanclass="vp-icon DocSearch-Search-Icon"></span><spanclass="DocSearch-Button-Placeholder">Search</span></span><spanclass="DocSearch-Button-Keys"><kbdclass="DocSearch-Button-Key"></kbd><kbdclass="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><navaria-labelledby="main-nav-aria-label"class="VPNavBarMenu menu"data-v-ccf7ddecdata-v-7f418b0f><spanid="main-nav-aria-label"class="visually-hidden"data-v-7f418b0f>Main Navigation</span><!--[--><!--[--><aclass="VPLink link VPNavBarMenuLink"href="/"tabindex="0"data-v-7f418b0fdata-v-9c663999><!--[--><spandata-v-9c663999>Home</span><!--]--></a><!--]--><!--]--></nav><!----><divclass="VPNavBarAppearance appearance"data-v-ccf7ddecdata-v-e6aabb21><buttonclass="VPSwitch VPSwitchAppearance"type="button"role="switch"title="Switch to dark theme"aria-checked="false"data-v-e6aabb21data-v-d1f28634data-v-1d5665e3><spanclass="check"data-v-1d5665e3><spanclass="icon"data-v-1d5665e3><!--[--><spanclass="vpi-sun sun"data-v-d1f28634></span><spanclass="vpi-moon moon"data-v-d1f28634></span><!--]--></span></span></button></div><divclass="VPSocialLinks VPNavBarSocialLinks social-links"data-v-ccf7ddecdata-v-0394ad82data-v-7bc22406><!--[--><aclass="VPSocialLink no-icon"href="https://reddit.com/r/olkb"aria-labeltarget="_blank"rel="noopener"data-v-7bc22406data-v-eee4e7cb><svgxmlns="http://www.w3.org/2000/svg"viewBox="0 0 50 50"width="50px"height="50px"><pathd="M293C28.0625327.1640633.38281326.54C25.8359384.61718825.3632815.433594256.40625C24.3554698.14062524.08593810.39453124.0312513.03125C19.23437513.17968814.82031314.42187511.2812516.46875C10.21484415.468758.85546914.968757.514.96875C6.08984414.968754.67578115.5117193.5937516.59375C1.42578118.7617191.42578122.2382813.5937524.40625L3.8437524.65625C3.312526.035156327.488281329C333.5273445.56640637.5859389.562540.4375C13.55859443.28906319.007813452545C30.9921884536.44140643.28906340.437540.4375C44.43359437.5859384733.5273444729C4727.48828146.687526.03515646.1562524.65625L46.4062524.40625C48.57421922.23828148.57421918.76171946.4062516.59375C45.32421915.51171943.91015614.9687542.514.96875C41.14453114.9687539.78515615.4687538.7187516.46875C35.19531314.43359430.80078113.19140626.0312513.03125C26.0937510.54687526.3632818.4687526.8757.09375C27.1640636.31640627.5273445.75781327.8755.4375C28.2226565.11718828.5390635295C29.460938529.6835945.12530.031255.40625C30.3789065.687530.7851566.14843831.31256.6875C32.2539067.65234433.6953138.71484436.093758.9375C36.53906311.23828138.574219134113C43.75134610.75468C465.2543.753413C38.605469336.5742194.71093836.093756.96875C34.31256.79687533.5273446.10937532.755.3125C32.3007814.85156331.8867194
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SRC += is31fl3218-mono.c </span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># For single-color</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">SRC += is31fl3218.c </span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># For RGB</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">I2C_DRIVER_REQUIRED = yes</span></span></code></pre></div><h2id="basic-configuration"tabindex="-1">Basic Configuration <aclass="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><h3id="i2c-addressing"tabindex="-1">I²C Addressing <aclass="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><h2id="arm-configuration"tabindex="-1">ARM/ChibiOS Configuration <aclass="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 <ahref="./i2c#arm-configuration">enable and configure I²C</a> at the keyboard level.</p><h2id="led-mapping"tabindex="-1">LED Mapping <aclass="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><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> is31fl3218_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3218_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3218_LED_COUNT] </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* R G B */</span></span>
<spanclass="line"><spanstyle="--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><divclass="language-c vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">c</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> is31fl3218_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3218_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3218_LED_COUNT] </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* V */</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span></code></pre></div><h2id="api"tabindex="-1">API <aclass="header-anchor"href="#api"aria-label="Permalink to "API {#api}""></a></h2><h3id="api-is31fl3218-led-t"tabindex="-1"><code>struct is31fl3218_led_t</code><aclass="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><h4id="api-is31fl3218-led-t-members"tabindex="-1">Members <aclass="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><h3id="api-is31fl3218-init"tabindex="-1"><code>void is31fl3218_init(void)</code><aclass="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><h3id="api-is31fl3218-write-register"tabindex="-1"><code>void is31fl3218_write_register(uint8_t reg, uint8_t data)</code><aclass="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><h4id="api-is31fl3218-write-register-arguments"tabindex="-1">Arguments <aclass="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><h3id="api-is31fl3218-set-color"tabindex="-1"><code>void is31fl3218_set_color(int index, uint8_t red, uint8_t green, uint8_t blue)</code><aclass="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><h4id="api-is31fl3218-set-color-arguments"tabindex="-1">Arguments <aclass="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><h3id="api-is31fl3218-set-color-all"tabindex="-1"><code>void is31fl3218_set_color_all(uint8_t red, uint8_t green, uint8_t blue)</code><aclass="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><h4id="api-is31fl3218-set-color-all-arguments"tabindex="-1">Arguments <aclass="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
