mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-07-18 21:52:02 +00:00
16 lines
16 KiB
JavaScript
16 lines
16 KiB
JavaScript
import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.Cauyuiy8.js";
|
||
const __pageData = JSON.parse('{"title":"IS31FL3218 Driver","description":"","frontmatter":{},"headers":[],"relativePath":"drivers/is31fl3218.md","filePath":"drivers/is31fl3218.md","lastUpdated":null}');
|
||
const _sfc_main = { name: "drivers/is31fl3218.md" };
|
||
const _hoisted_1 = /* @__PURE__ */ createStaticVNode('<h1 id="is31fl3218-driver" tabindex="-1">IS31FL3218 Driver <a class="header-anchor" href="#is31fl3218-driver" aria-label="Permalink to "IS31FL3218 Driver {#is31fl3218-driver}""></a></h1><p>I²C LED driver by Lumissil. Supports up to 18 single-color LEDs, or 6 RGB LEDs.</p><p><a href="https://www.lumissil.com/assets/pdf/core/IS31FL3218_DS.pdf" target="_blank" rel="noreferrer">IS31FL3218 Datasheet</a></p><h2 id="usage" tabindex="-1">Usage <a class="header-anchor" href="#usage" aria-label="Permalink to "Usage {#usage}""></a></h2><p>The IS31FL3218 driver code is automatically included if you are using the <a href="./../features/led_matrix">LED Matrix</a> or <a href="./../features/rgb_matrix">RGB Matrix</a> feature with the <code>is31fl3218</code> driver set, and you would use those APIs instead.</p><p>However, if you need to use the driver standalone, add this to your <code>rules.mk</code>:</p><div class="language-make vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">make</span><pre class="shiki shiki-themes github-light github-dark vp-code"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">COMMON_VPATH += </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">$(</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DRIVER_PATH</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">)</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">/led/issi</span></span>\n<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>\n<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>\n<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>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* R G B */</span></span>\n<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {OUT1, OUT2, OUT3},</span></span>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // etc...</span></span>\n<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>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">/* V */</span></span>\n<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {OUT1},</span></span>\n<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // etc...</span></span>\n<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>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-value" tabindex="-1"><code>void is31fl3218_set_value(int index, uint8_t value)</code> <a class="header-anchor" href="#api-is31fl3218-set-value" aria-label="Permalink to "`void is31fl3218_set_value(int index, uint8_t value)` {#api-is31fl3218-set-value}""></a></h3><p>Set the brightness of a single LED (single-color 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-value-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-value-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-value-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 value</code><br> The brightness value to set.</li></ul><hr><h3 id="api-is31fl3218-set-value-all" tabindex="-1"><code>void is31fl3218_set_value_all(uint8_t value)</code> <a class="header-anchor" href="#api-is31fl3218-set-value-all" aria-label="Permalink to "`void is31fl3218_set_value_all(uint8_t value)` {#api-is31fl3218-set-value-all}""></a></h3><p>Set the brightness of all LEDs (single-color driver only).</p><h4 id="api-is31fl3218-set-value-all-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-value-all-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-value-all-arguments}""></a></h4><ul><li><code>uint8_t value</code><br> The brightness value to set.</li></ul><hr><h3 id="api-is31fl3218-set-led-control-register-rgb" tabindex="-1"><code>void is31fl3218_set_led_control_register(uint8_t index, bool red, bool green, bool blue)</code> <a class="header-anchor" href="#api-is31fl3218-set-led-control-register-rgb" aria-label="Permalink to "`void is31fl3218_set_led_control_register(uint8_t index, bool red, bool green, bool blue)` {#api-is31fl3218-set-led-control-register-rgb}""></a></h3><p>Configure the LED control registers for a single LED (RGB driver only). This function does not immediately update the LEDs; call <code>is31fl3218_update_led_control_registers()</code> after you are finished.</p><h4 id="api-is31fl3218-set-led-control-register-rgb-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-led-control-register-rgb-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-led-control-register-rgb-arguments}""></a></h4><ul><li><code>uint8_t index</code><br> The LED index (ie. the index into the <code>g_is31fl3218_leds</code> array).</li><li><code>bool red</code><br> Enable or disable the red channel.</li><li><code>bool green</code><br> Enable or disable the green channel.</li><li><code>bool blue</code><br> Enable or disable the blue channel.</li></ul><hr><h3 id="api-is31fl3218-set-led-control-register-mono" tabindex="-1"><code>void is31fl3218_set_led_control_register(uint8_t index, bool value)</code> <a class="header-anchor" href="#api-is31fl3218-set-led-control-register-mono" aria-label="Permalink to "`void is31fl3218_set_led_control_register(uint8_t index, bool value)` {#api-is31fl3218-set-led-control-register-mono}""></a></h3><p>Configure the LED control registers for a single LED (single-color driver only). This function does not immediately update the LEDs; call <code>is31fl3218_update_led_control_registers()</code> after you are finished.</p><h4 id="api-is31fl3218-set-led-control-register-mono-arguments" tabindex="-1">Arguments <a class="header-anchor" href="#api-is31fl3218-set-led-control-register-mono-arguments" aria-label="Permalink to "Arguments {#api-is31fl3218-set-led-control-register-mono-arguments}""></a></h4><ul><li><code>uint8_t index</code><br> The LED index (ie. the index into the <code>g_is31fl3218_leds</code> array).</li><li><code>bool value</code><br> Enable or disable the LED.</li></ul><hr><h3 id="api-is31fl3218-update-pwm-buffers" tabindex="-1"><code>void is31fl3218_update_pwm_buffers(void)</code> <a class="header-anchor" href="#api-is31fl3218-update-pwm-buffers" aria-label="Permalink to "`void is31fl3218_update_pwm_buffers(void)` {#api-is31fl3218-update-pwm-buffers}""></a></h3><p>Flush the PWM values to the LED driver.</p><hr><h3 id="api-is31fl3218-update-led-control-registers" tabindex="-1"><code>void is31fl3218_update_led_control_registers(void)</code> <a class="header-anchor" href="#api-is31fl3218-update-led-control-registers" aria-label="Permalink to "`void is31fl3218_update_led_control_registers(void)` {#api-is31fl3218-update-led-control-registers}""></a></h3><p>Flush the LED control register values to the LED driver.</p>', 69);
|
||
const _hoisted_70 = [
|
||
_hoisted_1
|
||
];
|
||
function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) {
|
||
return openBlock(), createElementBlock("div", null, _hoisted_70);
|
||
}
|
||
const is31fl3218 = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]);
|
||
export {
|
||
__pageData,
|
||
is31fl3218 as default
|
||
};
|