import { _ as _export_sfc, c as createElementBlock, o as openBlock, a8 as createStaticVNode } from "./chunks/framework.DyMmIvSC.js"; const __pageData = JSON.parse('{"title":"IS31FL3731 Driver","description":"","frontmatter":{},"headers":[],"relativePath":"drivers/is31fl3731.md","filePath":"drivers/is31fl3731.md"}'); const _sfc_main = { name: "drivers/is31fl3731.md" }; const _hoisted_1 = /* @__PURE__ */ createStaticVNode('

IS31FL3731 Driver ​

I²C Charlieplexed 16x9 LED matrix driver by Lumissil. Supports a maximum of four drivers, each controlling up to 144 single-color LEDs, or 48 RGB LEDs.

IS31FL3731 Datasheet

Usage ​

The IS31FL3731 driver code is automatically included if you are using the LED Matrix or RGB Matrix feature with the is31fl3731 driver set, and you would use those APIs instead.

However, if you need to use the driver standalone, add this to your rules.mk:

make
COMMON_VPATH += $(DRIVER_PATH)/led/issi\nSRC += is31fl3731-mono.c # For single-color\nSRC += is31fl3731.c # For RGB\nI2C_DRIVER_REQUIRED = yes

Basic Configuration ​

Add the following to your config.h:

DefineDefaultDescription
IS31FL3731_SDB_PINNot definedThe GPIO pin connected to the drivers' shutdown pins
IS31FL3731_I2C_TIMEOUT100The I²C timeout in milliseconds
IS31FL3731_I2C_PERSISTENCE0The number of times to retry I²C transmissions
IS31FL3731_I2C_ADDRESS_1Not definedThe I²C address of driver 0
IS31FL3731_I2C_ADDRESS_2Not definedThe I²C address of driver 1
IS31FL3731_I2C_ADDRESS_3Not definedThe I²C address of driver 2
IS31FL3731_I2C_ADDRESS_4Not definedThe I²C address of driver 3
IS31FL3731_DEGHOSTNot definedEnable ghost image prevention

I²C Addressing ​

The IS31FL3731 has four possible 7-bit I²C addresses, depending on how the AD pin is connected.

To configure this, set the IS31FL3731_I2C_ADDRESS_n defines to one of the following in your config.h, where n denotes the driver index:

DefineValue
IS31FL3731_I2C_ADDRESS_GND0x74
IS31FL3731_I2C_ADDRESS_SCL0x75
IS31FL3731_I2C_ADDRESS_SDA0x76
IS31FL3731_I2C_ADDRESS_VCC0x77

De-Ghosting ​

This setting enables the de-ghosting feature on the IS31FL3731. See this Application Note (p. 15) for more information.

To enable, add the following to your config.h:

c
#define IS31FL3731_DEGHOST

ARM/ChibiOS Configuration ​

Depending on the ChibiOS board configuration, you may need to enable and configure I²C at the keyboard level.

LED Mapping ​

In order to use this driver, each output must be mapped to an LED index, by adding the following to your <keyboardname>.c:

c
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {\n/* Driver\n *   |  R     G     B */\n    {0, C1_1, C1_2, C1_3},\n    // etc...\n};

In this example, the red, green and blue channels for the first LED index on driver 0 all have their cathodes connected to the CA1 pin, and their anodes on the CA2, CA3 and CA4 pins respectively.

For the single-color driver, the principle is the same, but there is only one channel:

c
const is31fl3731_led_t PROGMEM g_is31fl3731_leds[IS31FL3731_LED_COUNT] = {\n/* Driver\n *   |  V */\n    {0, C1_1},\n    // etc...\n};

These values correspond to the register indices as shown in the datasheet on page 11, figure 8.

API ​

struct is31fl3731_led_t ​

Contains the PWM register addresses for a single RGB LED.

Members ​

void is31fl3731_init(uint8_t index) ​

Initialize the LED driver. This function should be called first.

Arguments ​

void is31fl3731_write_register(uint8_t index, uint8_t reg, uint8_t data) ​

Set the value of the given register.

Arguments ​

void is31fl3731_select_page(uint8_t index, uint8_t page) ​

Change the current page for configuring the LED driver.

Arguments ​

void is31fl3731_set_color(int index, uint8_t red, uint8_t green, uint8_t blue) ​

Set the color of a single LED (RGB driver only). This function does not immediately update the LEDs; call is31fl3731_update_pwm_buffers() after you are finished.

Arguments ​

void is31fl3731_set_color_all(uint8_t red, uint8_t green, uint8_t blue) ​

Set the color of all LEDs (RGB driver only).

Arguments ​

void is31fl3731_set_value(int index, uint8_t value) ​

Set the brightness of a single LED (single-color driver only). This function does not immediately update the LEDs; call is31fl3731_update_pwm_buffers() after you are finished.

Arguments ​

void is31fl3731_set_value_all(uint8_t value) ​

Set the brightness of all LEDs (single-color driver only).

Arguments ​

void is31fl3731_set_led_control_register(uint8_t index, bool red, bool green, bool blue) ​

Configure the LED control registers for a single LED (RGB driver only). This function does not immediately update the LEDs; call is31fl3731_update_led_control_registers() after you are finished.

Arguments ​

void is31fl3731_set_led_control_register(uint8_t index, bool value) ​

Configure the LED control registers for a single LED (single-color driver only). This function does not immediately update the LEDs; call is31fl3731_update_led_control_registers() after you are finished.

Arguments ​

void is31fl3731_update_pwm_buffers(uint8_t index) ​

Flush the PWM values to the LED driver.

Arguments ​

void is31fl3731_update_led_control_registers(uint8_t index) ​

Flush the LED control register values to the LED driver.

Arguments ​

', 87); const _hoisted_88 = [ _hoisted_1 ]; function _sfc_render(_ctx, _cache, $props, $setup, $data, $options) { return openBlock(), createElementBlock("div", null, _hoisted_88); } const is31fl3731 = /* @__PURE__ */ _export_sfc(_sfc_main, [["render", _sfc_render]]); export { __pageData, is31fl3731 as default };