<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = is31fl3731</span></span></code></pre></div><p>You can use between 1 and 4 IS31FL3731 IC's. Do not specify <code>DRIVER_ADDR_<N></code> defines for IC's that are not present on your keyboard. You can define the following items in <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>IS31FL3731_I2C_TIMEOUT</code></td><td>(Optional) How long to wait for i2c messages, in milliseconds</td><td>100</td></tr><tr><td><code>IS31FL3731_I2C_PERSISTENCE</code></td><td>(Optional) Retry failed messages this many times</td><td>0</td></tr><tr><td><code>IS31FL3731_DEGHOST</code></td><td>(Optional) Set this define to enable de-ghosting by halving Vcc during blanking time</td><td></td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>IS31FL3731_I2C_ADDRESS_1</code></td><td>(Required) Address for the first RGB driver</td><td></td></tr><tr><td><code>IS31FL3731_I2C_ADDRESS_2</code></td><td>(Optional) Address for the second RGB driver</td><td></td></tr><tr><td><code>IS31FL3731_I2C_ADDRESS_3</code></td><td>(Optional) Address for the third RGB driver</td><td></td></tr><tr><td><code>IS31FL3731_I2C_ADDRESS_4</code></td><td>(Optional) Address for the fourth RGB driver</td><td></td></tr></tbody></table><p>Here is an example using 2 drivers.</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:#6A737D;--shiki-dark:#6A737D;">// This is a 7-bit address, that gets left-shifted and bit 0</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// set to 0 for write, 1 for read (as per I2C protocol)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The address will vary depending on your wiring:</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 00 AD <-> GND</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 01 AD <-> SCL</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 10 AD <-> SDA</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 11 AD <-> VCC</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// ADDR represents A1:A0 of the 7-bit address.</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The result is: 0b11101(ADDR)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>For split keyboards using <code>RGB_MATRIX_SPLIT</code> with an LED driver, you can either have the same driver address or different driver addresses. If using different addresses, use <code>IS31FL3731_I2C_ADDRESS_1</code> for one and <code>IS31FL3731_I2C_ADDRESS_2</code> for the other one. Then, in <code>g_is31fl3731_leds</code>, fill out the correct driver index (0 or 1). If using one address, use <code>IS31FL3731_I2C_ADDRESS_1</code> for both, and use index 0 for <code>g_is31fl3731_leds</code>.</p><p>Define these arrays listing all the LEDs in your <code><keyboard>.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;"> is31fl3731_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3731_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3731_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;">/* Refer to IS31 manual for these locations</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Where <code>Cx_y</code> is the location of the LED in the matrix defined by <ahref="https://www.issi.com/WW/pdf/31FL3731.pdf"target="_blank"rel="noreferrer">the datasheet</a> and the header file <code>drivers/led/issi/is31fl3731.h</code>. The <code>driver</code> is the index of the driver you defined in your <code>config.h</code> (<code>0</code>, <code>1</code>, <code>2</code>, or <code>3</code>).</p><hr><h3id="is31fl3733"tabindex="-1">IS31FL3733 <aclass="header-anchor"href="#is31fl3733"aria-label="Permalink to "IS31FL3733 {#is31fl3733}""></a></h3><p>There is basic support for addressable RGB matrix lighting with the I2C IS31FL3733 RGB controller. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = is31fl3733</span></span></code></pre></div><p>You can use between 1 and 4 IS31FL3733 IC's. Do not specify <code>DRIVER_ADDR_<N></code> defines for IC's that are not present on your keyboard. You can define the following items in <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>IS31FL3733_I2C_TIMEOUT</code></td><td>(Optional) How long to wait for i2c messages, in milliseconds</td><td>100</td></tr><tr><td><code>IS31FL3733_I2C_PERSISTENCE</code></td><td>(Optional) Retry failed messages this many times</td><td>0</td></tr><tr><td><code>IS31FL3733_PWM_FREQUENCY</code></td><td>(Optional) PWM Frequency Setting - IS31FL3733B only</td><td>0</td></tr><tr><td><code>IS31FL3733_GLOBALCURRENT</code></td><td>(Optional) Configuration for the Global Current Register</td><td>0xFF</td></tr><tr><td><code>IS31FL3733_SWPULLUP</code></td><td>(Optional) Set the value of the SWx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>IS31FL3733_CSPULLUP</code></td><td>(Optional) Set the value of the CSx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>IS31FL3733_I2C_ADDRESS_1</code></td><td>(Required) Address for the first RGB driver</td><td></td></tr><tr><td><code>IS31FL3733_I2C_ADDRESS_2</code></td><td>(Optional) Address for the second RGB driver</td><td></td></tr><tr><td><code>IS31FL3733_I2C_ADDRESS_3</code></td><td>(Optional) Address for the third RGB driver</td><td></td></tr><tr><td><code>IS31FL3733_I2C_ADDRESS_4</code></td><td>(Optional) Address for the fourth RGB driver</td><td></td></tr><tr><td><code>IS31FL3733_SYNC_1</code></td><td>(Optional) Sync configuration for the first RGB driver</td><td>0</td></tr><tr><td><code>IS31FL3733_SYNC_2</code></td><td>(Optional) Sync configuration for the second RGB driver</td><td>0</td></tr><tr><td><code>IS31FL3733_SYNC_3</code></td><td>(Optional) Sync configuration for the third RGB driver</td><td>0</td></tr><tr><td><code>IS31FL3733_SYNC_4</code></td><td>(Optional) Sync configuration for the fourth RGB driver</td><td>0</td></tr></tbody></table><p>The IS31FL3733 IC's have on-chip resistors that can be enabled to allow for de-ghosting of the RGB matrix. By default these resistors are not enabled (<code>IS31FL3733_SWPULLUP</code>/<code>IS31FL3733_CSPULLUP</code> are given the value of <code>IS31FL3733_PUR_0R</code>), the values that can be set to enable de-ghosting are as follows:</p><table><thead><tr><th><code>IS31FL3733_SWPULLUP/IS31FL3733_CSPULLUP</code></th><th>Description</th></tr></thead><tbody><tr><td><code>IS31FL3733_PUR_0R</code></td><td>(default) Do not use the on-chip resistors/enable de-ghosting</td></tr><tr><td><code>IS31FL3733_PUR_05KR</code></td><td>The 0.5k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3733_PUR_3KR</code></td><td>The 3k Ohm resistor used at all times</td></tr><tr><td><code>IS31FL3733_PUR_4KR</code></td><td>The 4k Ohm resistor used at all times</td></tr><tr><td><code>IS31FL3733_PUR_8KR</code></td><td>The 8k Ohm resistor used at all times</td></tr><tr><td><code>IS31FL3733_PUR_16KR</code></td><td>The 16k Ohm resistor used at all times</td></tr><tr><td><code>IS31FL3733_PUR_32KR</code></td><td>The 32k Ohm resistor used during blanking period (t_NOL)</td></tr></tbody></table><p>Here is an example using 2 drivers.</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:#6A737D;--shiki-dark:#6A737D;">// This is a 7-bit address, that gets left-shifted and bit 0</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// set to 0 for write, 1 for read (as per I2C protocol)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The address will vary depending on your wiring:</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>Currently only 4 drivers are supported, but it would be trivial to support all 8 combinations.</p><p>Define these arrays listing all the LEDs in your <code><keyboard>.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;"> is31fl3733_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3733_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3733_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;">/* Refer to IS31 manual for these locations</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Where <code>SWx_CSy</code> is the location of the LED in the matrix defined by <ahref="https://www.issi.com/WW/pdf/31FL3733.pdf"target="_blank"rel="noreferrer">the datasheet</a> and the header file <code>drivers/led/issi/is31fl3733.h</code>. The <code>driver</code> is the index of the driver you defined in your <code>config.h</code> (<code>0</code>, <code>1</code>, <code>2</code>, or <code>3</code> for now).</p><hr><h3id="is31fl3736"tabindex="-1">IS31FL3736 <aclass="header-anchor"href="#is31fl3736"aria-label="Permalink to "IS31FL3736 {#is31fl3736}""></a></h3><p>There is basic support for addressable RGB matrix lighting with the I2C IS31FL3736 RGB controller. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = is31fl3736</span></span></code></pre></div><p>You can use between 1 and 4 IS31FL3736 IC's. Do not specify <code>DRIVER_ADDR_<N></code> defines for IC's that are not present on your keyboard.</p><p>Configure the hardware via your <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>IS31FL3736_I2C_TIMEOUT</code></td><td>(Optional) How long to wait for i2c messages, in milliseconds</td><td>100</td></tr><tr><td><code>IS31FL3736_PERSISTENCE</code></td><td>(Optional) Retry failed messages this many times</td><td>0</td></tr><tr><td><code>IS31FL3736_PWM_FREQUENCY</code></td><td>(Optional) PWM Frequency Setting - IS31FL3736B only</td><td>0</td></tr><tr><td><code>IS31FL3736_GLOBALCURRENT</code></td><td>(Optional) Configuration for the Global Current Register</td><td>0xFF</td></tr><tr><td><code>IS31FL3736_SWPULLUP</code></td><td>(Optional) Set the value of the SWx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>IS31FL3736_CSPULLUP</code></td><td>(Optional) Set the value of the CSx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>IS31FL3736_I2C_ADDRESS_1</code></td><td>(Required) Address for the first RGB driver</td><td></td></tr><tr><td><code>IS31FL3736_I2C_ADDRESS_2</code></td><td>(Optional) Address for the second RGB driver</td><td></td></tr><tr><td><code>IS31FL3736_I2C_ADDRESS_3</code></td><td>(Optional) Address for the third RGB driver</td><td></td></tr><tr><td><code>IS31FL3736_I2C_ADDRESS_4</code></td><td>(Optional) Address for the fourth RGB driver</td><td></td></tr></tbody></table><p>The IS31FL3736 IC's have on-chip resistors that can be enabled to allow for de-ghosting of the RGB matrix. By default these resistors are not enabled (<code>IS31FL3736_SWPULLUP</code>/<code>IS31FL3736_CSPULLUP</code> are given the value of <code>IS31FL3736_PUR_0R</code>), the values that can be set to enable de-ghosting are as follows:</p><table><thead><tr><th><code>IS31FL3736_SWPULLUP/IS31FL3736_CSPULLUP</code></th><th>Description</th></tr></thead><tbody><tr><td><code>IS31FL3736_PUR_0R</code></td><td>(default) Do not use the on-chip resistors/enable de-ghosting</td></tr><tr><td><code>IS31FL3736_PUR_05KR</code></td><td>The 0.5k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_1KR</code></td><td>The 1k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_2KR</code></td><td>The 2k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_4KR</code></td><td>The 4k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_8KR</code></td><td>The 8k Ohm resistor during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_16KR</code></td><td>The 16k Ohm resistor during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3736_PUR_32KR</code></td><td>The 32k Ohm resistor used during blanking period (t_NOL)</td></tr></tbody></table><p>Here is an example using 2 drivers.</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:#6A737D;--shiki-dark:#6A737D;">// This is a 7-bit address, that gets left-shifted and bit 0</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// set to 0 for write, 1 for read (as per I2C protocol)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The address will vary depending on your wiring:</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>Define these arrays listing all the LEDs in your <code><keyboard>.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;"> is31fl3736_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3736_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3736_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;">/* Refer to IS31 manual for these locations</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3id="is31fl3737"tabindex="-1">IS31FL3737 <aclass="header-anchor"href="#is31fl3737"aria-label="Permalink to "IS31FL3737 {#is31fl3737}""></a></h3><p>There is basic support for addressable RGB matrix lighting with the I2C IS31FL3737 RGB controller. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = is31fl3737</span></span></code></pre></div><p>You can use between 1 and 4 IS31FL3737 IC's. Do not specify <code>DRIVER_ADDR_<N></code> defines for IC's that are not present on your keyboard.</p><p>Configure the hardware via your <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>IS31FL3737_I2C_TIMEOUT</code></td><td>(Optional) How long to wait for i2c messages, in milliseconds</td><td>100</td></tr><tr><td><code>IS31FL3737_I2C_PERSISTENCE</code></td><td>(Optional) Retry failed messages this many times</td><td>0</td></tr><tr><td><code>IS31FL3737_PWM_FREQUENCY</code></td><td>(Optional) PWM Frequency Setting - IS31FL3737B only</td><td>0</td></tr><tr><td><code>IS31FL3737_GLOBALCURRENT</code></td><td>(Optional) Configuration for the Global Current Register</td><td>0xFF</td></tr><tr><td><code>IS31FL3737_SWPULLUP</code></td><td>(Optional) Set the value of the SWx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>IS31FL3737_CSPULLUP</code></td><td>(Optional) Set the value of the CSx lines on-chip de-ghosting resistors</td><td>PUR_0R (Disabled)</td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>IS31FL3737_I2C_ADDRESS_1</code></td><td>(Required) Address for the first RGB driver</td><td></td></tr><tr><td><code>IS31FL3737_I2C_ADDRESS_2</code></td><td>(Optional) Address for the second RGB driver</td><td></td></tr><tr><td><code>IS31FL3737_I2C_ADDRESS_3</code></td><td>(Optional) Address for the third RGB driver</td><td></td></tr><tr><td><code>IS31FL3737_I2C_ADDRESS_4</code></td><td>(Optional) Address for the fourth RGB driver</td><td></td></tr></tbody></table><p>The IS31FL3737 IC's have on-chip resistors that can be enabled to allow for de-ghosting of the RGB matrix. By default these resistors are not enabled (<code>IS31FL3737_SWPULLUP</code>/<code>IS31FL3737_CSPULLUP</code> are given the value of <code>IS31FL3737_PUR_0R</code>), the values that can be set to enable de-ghosting are as follows:</p><table><thead><tr><th><code>IS31FL3737_SWPULLUP/IS31FL3737_CSPULLUP</code></th><th>Description</th></tr></thead><tbody><tr><td><code>IS31FL3737_PUR_0R</code></td><td>(default) Do not use the on-chip resistors/enable de-ghosting</td></tr><tr><td><code>IS31FL3737_PUR_05KR</code></td><td>The 0.5k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_1KR</code></td><td>The 1k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_2KR</code></td><td>The 2k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_4KR</code></td><td>The 4k Ohm resistor used during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_8KR</code></td><td>The 8k Ohm resistor during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_16KR</code></td><td>The 16k Ohm resistor during blanking period (t_NOL)</td></tr><tr><td><code>IS31FL3737_PUR_32KR</code></td><td>The 32k Ohm resistor used during blanking period (t_NOL)</td></tr></tbody></table><p>Here is an example using 2 drivers.</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:#6A737D;--shiki-dark:#6A737D;">// This is a 7-bit address, that gets left-shifted and bit 0</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// set to 0 for write, 1 for read (as per I2C protocol)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The address will vary depending on your wiring:</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>Define these arrays listing all the LEDs in your <code><keyboard>.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;"> is31fl3737_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31fl3737_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[IS31FL3737_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;">/* Refer to IS31 manual for these locations</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Where <code>SWx_CSy</code> is the location of the LED in the matrix defined by <ahref="https://www.issi.com/WW/pdf/31FL3737.pdf"target="_blank"rel="noreferrer">the datasheet</a> and the header file <code>drivers/led/issi/is31fl3737.h</code>. The <code>driver</code> is the index of the driver you defined in your <code>config.h</code> (Only <code>0</code>, <code>1</code>, <code>2</code>, or <code>3</code> for now).</p><hr><h3id="is31flcommon"tabindex="-1">IS31FLCOMMON <aclass="header-anchor"href="#is31flcommon"aria-label="Permalink to "IS31FLCOMMON {#is31flcommon}""></a></h3><p>There is basic support for addressable RGB matrix lighting with a selection of I2C ISSI Lumissil RGB controllers through a shared common driver. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-makefile vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">makefile</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = <driver name></span></span></code></pre></div><p>Where <code><driver name></code> is the applicable LED driver chip as below</p><table><thead><tr><th>Driver Name</th><th>Data Sheet</th><th>Capability</th></tr></thead><tbody><tr><td><code>IS31FL3742A</code></td><td><ahref="https://www.lumissil.com/assets/pdf/core/IS31FL3742A_DS.pdf"target="_blank"rel="noreferrer">datasheet</a></td><td>60 RGB, 30x6 Matrix</td></tr><tr><td><code>IS31FL3743A</code></td><td><ahref="https://www.lumissil.com/assets/pdf/core/IS31FL3743A_DS.pdf"target="_blank"rel="noreferrer">datasheet</a></td><td>66 RGB, 18x11 Matrix</td></tr><tr><td><code>IS31FL3745</code></td><td><ahref="https://www.lumissil.com/assets/pdf/core/IS31FL3745_DS.pdf"target="_blank"rel="noreferrer">datasheet</a></td><td>48 RGB, 18x8 Matrix</td></tr><tr><td><code>IS31FL3746A</code></td><td><ahref="https://www.lumissil.com/assets/pdf/core/IS31FL3746A_DS.pdf"target="_blank"rel="noreferrer">datasheet</a></td><td>24 RGB, 18x4 Matrix</td></tr></tbody></table><p>You can use between 1 and 4 IC's. Do not specify <code>DRIVER_ADDR_<N></code> define for IC's if not present on your keyboard. The <code>DRIVER_ADDR_1</code> default assumes that all Address pins on the controller have been connected to GND. Drivers that have SYNC functionality have the default settings to disable if 1 driver. If more than 1 drivers then <code>DRIVER_ADDR_1</code> will be set to Master and the remaining ones set to Slave.</p><p>Configure the hardware via your <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>ISSI_TIMEOUT</code></td><td>(Optional) How long to wait for i2c messages, in milliseconds</td><td>100</td></tr><tr><td><code>ISSI_PERSISTENCE</code></td><td>(Optional) Retry failed messages this many times</td><td>0</td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>DRIVER_ADDR_1</code></td><td>(Optional) Address for the first RGB driver</td><td></td></tr><tr><td><code>DRIVER_ADDR_<N></code></td><td>(Required) Address for the additional RGB drivers</td><td></td></tr><tr><td><code>ISSI_SSR_<N></code></td><td>(Optional) Configuration for the Spread Spectrum Register</td><td></td></tr><tr><td><code>ISSI_CONFIGURATION</code></td><td>(Optional) Configuration for the Configuration Register</td><td></td></tr><tr><td><code>ISSI_GLOBALCURRENT</code></td><td>(Optional) Configuration for the Global Current Register</td><td>0xFF</td></tr><tr><td><code>ISSI_PULLDOWNUP</code></td><td>(Optional) Configuration for the Pull Up & Pull Down Register</td><td></td></tr><tr><td><code>ISSI_TEMP</code></td><td>(Optional) Configuration for the Temperature Register</td><td></td></tr><tr><td><code>ISSI_PWM_ENABLE</code></td><td>(Optional) Configuration for the PWM Enable Register</td><td></td></tr><tr><td><code>ISSI_PWM_SET</code></td><td>(Optional) Configuration for the PWM Setting Register</td><td></td></tr><tr><td><code>ISSI_SCAL_RED</code></td><td>(Optional) Configuration for the RED LEDs in Scaling Registers</td><td>0xFF</td></tr><tr><td><code>ISSI_SCAL_BLUE</code></td><td>(Optional) Configuration for the BLUE LEDs in Scaling Registers</td><td>0xFF</td></tr><tr><td><code>ISSI_SCAL_GREEN</code></td><td>(Optional) Configuration for the GREEN LEDs in Scaling Registers</td><td>0xFF</td></tr><tr><td><code>ISSI_MANUAL_SCALING</code></td><td>(Optional) If you wish to configure the Scaling Registers manually</td><td></td></tr></tbody></table><p>Defaults</p><table><thead><tr><th>Variable</th><th>IS31FL3742A</th><th>IS31FL3743A</th><th>IS31FL3745</th><th>IS31FL3746</th></tr></thead><tbody><tr><td><code>DRIVER_ADDR_1</code></td><td>0b0110000</td><td>0b0100000</td><td>0b0100000</td><td>0b1100000</td></tr><tr><td><code>ISSI_SSR_1</code></td><td>0x00</td><td>0x00 / 0x60</td><td>0x00 / 0xC0</td><td>0x00</td></tr><tr><
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>Currently only 4 drivers are supported, but it would be trivial to support for more. Note that using a combination of different drivers is not supported. All drivers must be of the same model.</p><p>Define these arrays listing all the LEDs in your <code><keyboard>.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:#24292E;--shiki-dark:#E1E4E8;"> is31_led PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[RGB_MATRIX_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;">/* Refer to IS31 manual for these locations</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Where <code>CSx_SWx</code> is the location of the LED in the matrix defined by the datasheet. The <code>driver</code> is the index of the driver you defined in your <code>config.h</code> (<code>0</code>, <code>1</code>, <code>2</code>, or <code>3</code> for now).</p><p><code>ISSI_MANUAL_SCALING</code> is used to override the Scaling for individual LED's. By default they will be set as per <code>ISSI_SCAL_<colour></code>. In <code>config.h</code> set how many LED's you want to manually set scaling for. Eg <code>#define ISSI_MANUAL_SCALING 3</code></p><p>Then Define the array listing all the LEDs you want to override in your <code><keyboard>.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:#24292E;--shiki-dark:#E1E4E8;"> is31_led PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_is31_scaling</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[ISSI_MANUAL_SCALING] </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;">/* LED Index</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> * | R scaling</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> * | | G scaling</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> * | | | B scaling</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>Where LED Index is the position of the LED in the <code>g_is31_leds</code> array. The <code>scaling</code> value between 0 and 255 to be written to the Scaling Register.</p><hr><h3id="ws2812"tabindex="-1">WS2812 <aclass="header-anchor"href="#ws2812"aria-label="Permalink to "WS2812 {#ws2812}""></a></h3><p>There is basic support for addressable RGB matrix lighting with a WS2811/WS2812{a,b,c} addressable LED strand. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = ws2812</span></span></code></pre></div><p>Configure the hardware via your <code>config.h</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:#6A737D;--shiki-dark:#6A737D;">// The pin connected to the data pin of the LEDs</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 70</span></span></code></pre></div><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>There are additional configuration options for ARM controllers that offer increased performance over the default bitbang driver. Please see <ahref="./../drivers/ws2812">WS2812 Driver</a> for more information.</p></div><hr><h3id="apa102"tabindex="-1">APA102 <aclass="header-anchor"href="#apa102"aria-label="Permalink to "APA102 {#apa102}""></a></h3><p>There is basic support for APA102 based addressable LED strands. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = apa102</span></span></code></pre></div><p>Configure the hardware via your <code>config.h</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:#6A737D;--shiki-dark:#6A737D;">// The pin connected to the data pin of the LEDs</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// The number of LEDs connected</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 70</span></span></code></pre></div><hr><h3id="aw20216s"tabindex="-1">AW20216S <aclass="header-anchor"href="#aw20216s"aria-label="Permalink to "AW20216S {#aw20216s}""></a></h3><p>There is basic support for addressable RGB matrix lighting with the SPI AW20216S RGB controller. To enable it, add this to your <code>rules.mk</code>:</p><divclass="language-make vp-adaptive-theme"><buttontitle="Copy Code"class="copy"></button><spanclass="lang">make</span><preclass="shiki shiki-themes github-light github-dark vp-code"><code><spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_ENABLE = yes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">RGB_MATRIX_DRIVER = aw20216s</span></span></code></pre></div><p>You can use up to 2 AW20216S IC's. Do not specify <code>DRIVER_<N>_xxx</code> defines for IC's that are not present on your keyboard. You can define the following items in <code>config.h</code>:</p><table><thead><tr><th>Variable</th><th>Description</th><th>Default</th></tr></thead><tbody><tr><td><code>AW20216S_CS_PIN_1</code></td><td>(Required) MCU pin connected to first RGB driver chip select line</td><td>B13</td></tr><tr><td><code>AW20216S_CS_PIN_2</code></td><td>(Optional) MCU pin connected to second RGB driver chip select line</td><td></td></tr><tr><td><code>AW20216S_EN_PIN_1</code></td><td>(Required) MCU pin connected to first RGB driver hardware enable line</td><td>C13</td></tr><tr><td><code>AW20216S_EN_PIN_2</code></td><td>(Optional) MCU pin connected to second RGB driver hardware enable line</td><td></td></tr><tr><td><code>DRIVER_1_LED_TOTAL</code></td><td>(Required) How many RGB lights are connected to first RGB driver</td><td></td></tr><tr><td><code>DRIVER_2_LED_TOTAL</code></td><td>(Optional) How many RGB lights are connected to second RGB driver</td><td></td></tr><tr><td><code>RGB_MATRIX_LED_COUNT</code></td><td>(Required) How many RGB lights are present across all drivers</td><td></td></tr><tr><td><code>AW20216S_SCALING_MAX</code></td><td>(Optional) LED current scaling value (0-255, higher values mean LED is brighter at full PWM)</td><td>150</td></tr><tr><td><code>AW20216S_GLOBAL_CURRENT_MAX</code></td><td>(Optional) Driver global current limit (0-255, higher values means the driver may consume more power)</td><td>150</td></tr><tr><td><code>AW20216S_SPI_MODE</code></td><td>(Optional) Mode for SPI communication (0-3, defines polarity and phase of the clock)</td><td>3</td></tr><tr><td><code>AW20216S_SPI_DIVISOR</code></td><td>(Optional) Clock divisor for SPI communication (powers of 2, smaller numbers means faster communication, should not be less than 4)</td><td>4</td></tr></tbody></table><p>Here is an example using 2 drivers.</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;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> AW20216S_CS_PIN_1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> B13</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_COUNT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (DRIVER_1_LED_TOTAL </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> DRIVER_2_LED_TOTAL)</span></span></code></pre></div><divclass="warning custom-block"><pclass="custom-block-title">WARNING</p><p>Note the parentheses, this is so when <code>RGB_MATRIX_LED_COUNT</code> is used in code and expanded, the values are added together before any additional math is applied to them. As an example, <code>rand() % (DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL)</code> will give very different results than <code>rand() % DRIVER_1_LED_TOTAL + DRIVER_2_LED_TOTAL</code>.</p></div><p>Define these arrays listing all the LEDs in your <code><keyboard>.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;"> aw20216s_led_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> PROGMEM </span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;">g_aw20216s_leds</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">[AW20216S_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;">/* Each AW20216S channel is controlled by a register at some offset between 0x00</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> * and 0xD7 inclusive.</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> * See drivers/led/aw20216s.h for the mapping between register offsets and</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">};</span></span></code></pre></div><hr><h2id="common-configuration"tabindex="-1">Common Configuration <aclass="header-anchor"href="#common-configuration"aria-label="Permalink to "Common Configuration {#common-configuration}""></a></h2><p>From this point forward the configuration is the same for all the drivers. The <code>led_config_t</code> struct provides a key electrical matrix to led index lookup table, what the physical position of each LED is on the board, and what type of key or usage the LED if the LED represents. Here is a brief example:</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:#005CC5;--shiki-dark:#79B8FF;">led_config_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> g_led_config </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;"> // Key Matrix to LED Index</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">} };</span></span></code></pre></div><p>The first part, <code>// Key Matrix to LED Index</code>, tells the system what key this LED represents by using the key's electrical matrix row & col. The second part, <code>// LED Index to Physical Position</code> represents the LED's physical <code>{ x, y }</code> position on the keyboard. The default expected range of values for <code>{ x, y }</code> is the inclusive range <code>{ 0..224, 0..64 }</code>. This default expected range is due to effects that calculate the center of the keyboard for their animations. The easiest way to calculate these positions is imagine your keyboard is a grid, and the top left of the keyboard represents <code>{ x, y }</code> coordinate <code>{ 0, 0 }</code> and the bottom right of your keyboard represents <code>{ 224, 64 }</code>. Using this as a basis, you can use the following formula to calculate the physical position:</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:#24292E;--shiki-dark:#E1E4E8;">x </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 224</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_COLS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> COL_POSITION</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">y </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 64</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> /</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (NUMBER_OF_ROWS </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ROW_POSITION</span></span></code></pre></div><p>Where NUMBER_OF_COLS, NUMBER_OF_ROWS, COL_POSITION, & ROW_POSITION are all based on the physical layout of your keyboard, not the electrical layout.</p><p>As mentioned earlier, the center of the keyboard by default is expected to be <code>{ 112, 32 }</code>, but this can be changed if you want to more accurately calculate the LED's physical <code>{ x, y }</code> positions. Keyboard designers can implement <code>#define RGB_MATRIX_CENTER { 112, 32 }</code> in their config.h file with the new center point of the keyboard, or where they want it to be allowing more possibilities for the <code>{ x, y }</code> values. Do note that the maximum value for x or y is 255, and the recommended maximum is 224 as this gives animations runoff room before they reset.</p><p><code>// LED Index to Flag</code> is a bitmask, whether or not a certain LEDs is of a certain type. It is recommended that LEDs are set to only 1 type.</p><h2id="flags"tabindex="-1">Flags <aclass="header-anchor"href="#flags"aria-label="Permalink to "Flags {#flags}""></a></h2><table><thead><tr><th>Define</th><th>Value</th><th>Description</th></tr></thead><tbody><tr><td><code>HAS_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has all <code>flags</code> set</td></tr><tr><td><code>HAS_ANY_FLAGS(bits, flags)</code></td><td><em>n/a</em></td><td>Evaluates to <code>true</code> if <code>bits</code> has any <code>flags</code> set</td></tr><tr><td><code>LED_FLAG_NONE</code></td><td><code>0x00</code></td><td>If this LED has no flags</td></tr><tr><td><code>LED_FLAG_ALL</code></td><td><code>0xFF</code></td><td>If this LED has all flags</td></tr><tr><td><code>LED_FLAG_MODIFIER</code></td><td><code>0x01</code></td><td>If the LED is on a modifier key</td></tr><tr><td><code>LED_FLAG_UNDERGLOW</code></td><td><code>0x02</code></td><td>If the LED is for underglow</td></tr><tr><td><code>LED_FLAG_KEYLIGHT</code></td><td><code>0x04</code></td><td>If the LED is for key backlight</td></tr><tr><td><code>LED_FLAG_INDICATOR</code></td><td><code>0x08</code></td><td>If the LED is for keyboard state indication</td></tr></tbody></table><h2id="keycodes"tabindex="-1">Keycodes <aclass="header-anchor"href="#keycodes"aria-label="Permalink to "Keycodes {#keycodes}""></a></h2><p>All RGB keycodes are currently shared with the RGBLIGHT system:</p><table><thead><tr><th>Key</th><th>Aliases</th><th>Description</th></tr></thead><tbody><tr><td><code>RGB_TOG</code></td><td></td><td>Toggle RGB lighting on or off</td></tr><tr><td><code>RGB_MODE_FORWARD</code></td><td><code>RGB_MOD</code></td><td>Cycle through modes, reverse direction when Shift is held</td></tr><tr><td><code>RGB_MODE_REVERSE</code></td><td><code>RGB_RMOD</code></td><td>Cycle through modes in reverse, forward direction when Shift is held</td></tr><tr><td><code>RGB_HUI</code></td><td></td><td>Increase hue, decrease hue when Shift is held</td></tr><tr><td><code>RGB_HUD</code></td><td></td><td>Decrease hue, increase hue when Shift is held</td></tr><tr><td><code>RGB_SAI</code></td><td></td><td>Increase saturation, decrease saturation when Shift is held</td></tr><tr><td><code>RGB_SAD</code></td><td></td><td>Decrease saturation, increase saturation when Shift is held</td></tr><tr><td><code>RGB_VAI</code></td><td></td><td>Incre
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_COLOR </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 1</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static single hue, no speed support</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_ALPHAS_MODS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static dual hue, speed is hue for secondary hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_GRADIENT_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static gradient top to bottom, speed controls how much gradient changes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_GRADIENT_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static gradient left to right, speed controls how much gradient changes</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BREATHING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue brightness cycling animation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue band fading saturation scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_VAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue band fading brightness scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SPIRAL_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue spinning spiral fades saturation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_BAND_SPIRAL_VAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue spinning spiral fades brightness</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_ALL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full keyboard solid hue cycling through full gradient</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_LEFT_RIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_UP_DOWN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling top to bottom</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_OUT_IN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient scrolling out to in</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_OUT_IN_DUAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full dual gradients scrolling out to in</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_MOVING_CHEVRON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient Chevron shapped scrolling left to right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_PINWHEEL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning pinwheel around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_SPIRAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning spiral around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_DUAL_BEACON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient spinning around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_BEACON,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full tighter gradient spinning around center of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINBOW_PINWHEELS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full dual gradients spinning two halfs of keyboard</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_FLOWER_BLOOMING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full tighter gradient of first half scrolling left to right and second half scrolling right to left</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RAINDROPS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly changes a single key's hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_JELLYBEAN_RAINDROPS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly changes a single key's hue and saturation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_BREATHING,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount at the same time, then shifts back</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_PENDULUM,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount in a wave to the right, then back to the left</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_HUE_WAVE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue shifts up a slight ammount and then back down in a wave to the right</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_FRACTAL,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Single hue fractal filled keys pulsing horizontally out to edges</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_FLOW,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pulsing RGB flow along LED wiring with random hues</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_PIXEL_RAIN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Randomly light keys with random hues</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_TYPING_HEATMAP,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // How hot is your WPM!</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_DIGITAL_RAIN,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // That famous computer simulation</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_SIMPLE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Pulses keys hit to hue & value then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Static single hue, pulses keys hit to shifted hue then fades to current hue</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_WIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse near a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTIWIDE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse near multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_CROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse the same column and row of a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTICROSS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse the same column and row of multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_NEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away on the same column and row of a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_REACTIVE_MULTINEXUS,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away on the same column and row of multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient & value pulse away from a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_MULTISPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Full gradient & value pulse away from multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_SPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away from a single key hit then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_SOLID_MULTISPLASH,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Hue & value pulse away from multiple key hits then fades value out</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, maintaining user set color</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT_DUAL_HUE,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, modifies user set hue by +- 30</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_STARLIGHT_DUAL_SAT,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // LEDs turn on and off at random at varying brightness, modifies user set saturation by +- 30</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_RIVERFLOW,</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Modification to breathing animation, offset's animation depending on key location to simulate a river flowing</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A simple effect, self-contained within a single method</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// e.g: A more complex effect, relying on external methods and state, with</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// dedicated init and run methods</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#endif</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // RGB_MATRIX_CUSTOM_EFFECT_IMPLS</span></span></code></pre></div><p>For inspiration and examples, check out the built-in effects under <code>quantum/rgb_matrix/animations/</code>.</p><h2id="colors"tabindex="-1">Colors <aclass="header-anchor"href="#colors"aria-label="Permalink to "Colors {#colors}""></a></h2><p>These are shorthands to popular colors. The <code>RGB</code> ones can be passed to the <code>setrgb</code> functions, while the <code>HSV</code> ones to the <code>sethsv</code> functions.</p><table><thead><tr><th>RGB</th><th>HSV</th></tr></thead><tbody><tr><td><code>RGB_AZURE</code></td><td><code>HSV_AZURE</code></td></tr><tr><td><code>RGB_BLACK</code>/<code>RGB_OFF</code></td><td><code>HSV_BLACK</code>/<code>HSV_OFF</code></td></tr><tr><td><code>RGB_BLUE</code></td><td><code>HSV_BLUE</code></td></tr><tr><td><code>RGB_CHARTREUSE</code></td><td><code>HSV_CHARTREUSE</code></td></tr><tr><td><code>RGB_CORAL</code></td><td><code>HSV_CORAL</code></td></tr><tr><td><code>RGB_CYAN</code></td><td><code>HSV_CYAN</code></td></tr><tr><td><code>RGB_GOLD</code></td><td><code>HSV_GOLD</code></td></tr><tr><td><code>RGB_GOLDENROD</code></td><td><code>HSV_GOLDENROD</code></td></tr><tr><td><code>RGB_GREEN</code></td><td><code>HSV_GREEN</code></td></tr><tr><td><code>RGB_MAGENTA</code></td><td><code>HSV_MAGENTA</code></td></tr><tr><td><code>RGB_ORANGE</code></td><td><code>HSV_ORANGE</code></td></tr><tr><td><code>RGB_PINK</code></td><td><code>HSV_PINK</code></td></tr><tr><td><code>RGB_PURPLE</code></td><td><code>HSV_PURPLE</code></td></tr><tr><td><code>RGB_RED</code></td><td><code>HSV_RED</code></td></tr><tr><td><code>RGB_SPRINGGREEN</code></td><td><code>HSV_SPRINGGREEN</code></td></tr><tr><td><code>RGB_TEAL</code></td><td><code>HSV_TEAL</code></td></tr><tr><td><code>RGB_TURQUOISE</code></td><td><code>HSV_TURQUOISE</code></td></tr><tr><td><code>RGB_WHITE</code></td><td><code>HSV_WHITE</code></td></tr><tr><td><code>RGB_YELLOW</code></td><td><code>HSV_YELLOW</code></td></tr></tbody></table><p>These are defined in <ahref="https://github.com/qmk/qmk_firmware/blob/master/quantum/color.h"target="_blank"rel="noreferrer"><code>color.h</code></a>. Feel free to add to this list!</p><h2id="additional-configh-options"tabindex="-1">Additional <code>config.h</code> Options <aclass="header-anchor"href="#additional-configh-options"aria-label="Permalink to "Additional `config.h` Options {#additional-configh-options}""></a></h2><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;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_KEYRELEASES</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // reactive effects respond to keyreleases (instead of keypresses)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_TIMEOUT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // number of milliseconds to wait until rgb automatically turns off</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_SLEEP</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // turn off effects when suspended</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_PROCESS_LIMIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (RGB_MATRIX_LED_COUNT </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">+</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 4</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">/</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 5</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits the number of LEDs to process in an animation per task run (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_LED_FLUSH_LIMIT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 16</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits in milliseconds how frequently an animation will update the LEDs. 16 (16ms) is equivalent to limiting to 60fps (increases keyboard responsiveness)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 200</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // limits maximum brightness of LEDs to 200 out of 255. If not defined maximum brightness is set to 255</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_ON</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> true</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default enabled state, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_MODE</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_CYCLE_LEFT_RIGHT</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default mode, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_HUE</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default hue value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_SAT</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 255</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default saturation value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_VAL</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> RGB_MATRIX_MAXIMUM_BRIGHTNESS</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default brightness value, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_SPD</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 127</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default animation speed, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DEFAULT_FLAGS</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> LED_FLAG_ALL</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Sets the default LED flags, if none has been set</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_DISABLE_KEYCODES</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // disables control of rgb matrix by keycodes (must use code functions to control the feature)</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_SPLIT</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { X, Y }</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // (Optional) For split keyboards, the number of LEDs connected on each half. X = left, Y = Right.</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // If reactive effects are enabled, you also will want to enable SPLIT_TRANSPORT_MIRROR</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">#define</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_TRIGGER_ON_KEYDOWN</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // Triggers RGB keypress events on key down. This makes RGB control feel more responsive. This may cause RGB to not function properly on some boards</span></span></code></pre></div><h2id="eeprom-storage"tabindex="-1">EEPROM storage <aclass="header-anchor"href="#eeprom-storage"aria-label="Permalink to "EEPROM storage {#eeprom-storage}""></a></h2><p>The EEPROM for it is currently shared with the LED Matrix system (it's generally assumed only one feature would be used at a time).</p><h2id="functions"tabindex="-1">Functions <aclass="header-anchor"href="#functions"aria-label="Permalink to "Functions {#functions}""></a></h2><h3id="direct-operation"tabindex="-1">Direct Operation <aclass="header-anchor"href="#direct-operation"aria-label="Permalink to "Direct Operation {#direct-operation}""></a></h3><table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><code>rgb_matrix_set_color_all(r, g, b)</code></td><td>Set all of the LEDs to the given RGB value, where <code>r</code>/<code>g</code>/<code>b</code> are between 0 and 255 (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_set_color(index, r, g, b)</code></td><td>Set a single LED to the given RGB value, where <code>r</code>/<code>g</code>/<code>b</code> are between 0 and 255, and <code>index</code> is between 0 and <code>RGB_MATRIX_LED_COUNT</code> (not written to EEPROM)</td></tr></tbody></table><h3id="disable-enable-effects"tabindex="-1">Disable/Enable Effects <aclass="header-anchor"href="#disable-enable-effects"aria-label="Permalink to "Disable/Enable Effects {#disable-enable-effects}""></a></h3><table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><code>rgb_matrix_toggle()</code></td><td>Toggle effect range LEDs between on and off</td></tr><tr><td><code>rgb_matrix_toggle_noeeprom()</code></td><td>Toggle effect range LEDs between on and off (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_enable()</code></td><td>Turn effect range LEDs on, based on their previous state</td></tr><tr><td><code>rgb_matrix_enable_noeeprom()</code></td><td>Turn effect range LEDs on, based on their previous state (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_disable()</code></td><td>Turn effect range LEDs off, based on their previous state</td></tr><tr><td><code>rgb_matrix_disable_noeeprom()</code></td><td>Turn effect range LEDs off, based on their previous state (not written to EEPROM)</td></tr></tbody></table><h3id="change-effect-mode"tabindex="-1">Change Effect Mode <aclass="header-anchor"href="#change-effect-mode"aria-label="Permalink to "Change Effect Mode {#change-effect-mode}""></a></h3><table><thead><tr><th>Function</th><th>Description</th></tr></thead><tbody><tr><td><code>rgb_matrix_mode(mode)</code></td><td>Set the mode, if RGB animations are enabled</td></tr><tr><td><code>rgb_matrix_mode_noeeprom(mode)</code></td><td>Set the mode, if RGB animations are enabled (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_step()</code></td><td>Change the mode to the next RGB animation in the list of enabled RGB animations</td></tr><tr><td><code>rgb_matrix_step_noeeprom()</code></td><td>Change the mode to the next RGB animation in the list of enabled RGB animations (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_step_reverse()</code></td><td>Change the mode to the previous RGB animation in the list of enabled RGB animations</td></tr><tr><td><code>rgb_matrix_step_reverse_noeeprom()</code></td><td>Change the mode to the previous RGB animation in the list of enabled RGB animations (not written to EEPROM)</td></tr><tr><td><code>rgb_matrix_increase_speed()</code></td><td>Increase the speed of the animations</td></tr><tr><td><code>rgb_matrix_increase_speed_noeeprom()</code></td
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>In addition, there are the advanced indicator functions. These are aimed at those with heavily customized displays, where rendering every LED per cycle is expensive. Such as some of the "drashna" layouts. This includes a special macro to help make this easier to use: <code>RGB_MATRIX_INDICATOR_SET_COLOR(i, r, g, b)</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;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> for</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> col </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 0</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">; col </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"><</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> MATRIX_COLS; </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">++</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">col) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> uint8_t</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> g_led_config.matrix_co[row][col];</span></span>
<spanclass="line"></span>
<spanclass="line"><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">>=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> led_min </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;"><</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> led_max </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> index </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">!=</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> NO_LED </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">&&</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>Split keyboards will require layer state data syncing with <code>#define SPLIT_LAYER_STATE_ENABLE</code>. See <ahref="./split_keyboard#data-sync-options">Data Sync Options</a> for more details.</p></div><h4id="indicator-examples-2"tabindex="-1">Examples <aclass="header-anchor"href="#indicator-examples-2"aria-label="Permalink to "Examples {#indicator-examples-2}""></a></h4><p>This example sets the modifiers to be a specific color based on the layer state. You can use a switch case here, instead, if you would like. This uses HSV and then converts to RGB, because this allows the brightness to be limited (important when using the WS2812 driver).</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;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><p>If you want to indicate a Host LED status (caps lock, num lock, etc), you can use something like this to light up the caps lock key:</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;">bool</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> rgb_matrix_indicators_advanced_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_min</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">uint8_t</span><spanstyle="--shiki-light:#E36209;--shiki-dark:#FFAB70;"> led_max</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> RGB_MATRIX_INDICATOR_SET_COLOR</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">5</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><spanstyle="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">255</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span><spanstyle="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> // assuming caps lock is at led #5</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><divclass="tip custom-block"><pclass="custom-block-title">TIP</p><p>RGB indicators on split keyboards will require state information synced to the slave half (e.g. <code>#define SPLIT_LAYER_STATE_ENABLE</code>). See <ahref="./split_keyboard#data-sync-options">data sync options</a> for more details.</p></div><h4id="indicators-without-rgb-matrix-effect"tabindex="-1">Indicators without RGB Matrix Effect <aclass="header-anchor"href="#indicators-without-rgb-matrix-effect"aria-label="Permalink to "Indicators without RGB Matrix Effect""></a></h4><p>If you want to just use RGB indicators without RGB matrix effect, it is not possible to disable the latter because toggling RGB off will disable everything. You can workaround it with solid effect and colors off using this init function:</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;">void</span><spanstyle="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> keyboard_post_init_user</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><spanstyle="--shiki-light:#D73A49;--shiki-dark:#F97583;">void</span><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) {</span></span>
<spanclass="line"><spanstyle="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div></div></div></main><footerclass="VPDocFooter"data-v-39a288b8data-v-09de1c0f><!--[--><!--]--><!----><navclass="prev-next"data-v-09de1c0f><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link prev"href="/features/rgblight"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Previous page</span><spanclass="title"data-v-09de1c0f>RGB Lighting</span><!--]--></a></div><divclass="pager"data-v-09de1c0f><aclass="VPLink link pager-link next"href="/features/audio"data-v-09de1c0f><!--[--><spanclass="desc"data-v-09de1c0f>Next page</span><spanclass="title"data-v-09de1c0f>Audio</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
