~ruther/qmk_firmware

ref: e7a08ef1a99b407f7326e146239d785e552c9aba qmk_firmware/docs/drivers/apa102.md -rw-r--r-- 1.8 KiB
e7a08ef1 — Joel Challis Fix broken link in PR checklist (#23877) 1 year, 2 days ago

#APA102 Driver {#apa102-driver}

This driver provides support for APA102 addressable RGB LEDs. They are similar to the WS2812 LEDs, but have increased data and refresh rates.

#Usage {#usage}

In most cases, the APA102 driver code is automatically included if you are using either the RGBLight or RGB Matrix feature with the apa102 driver set, and you would use those APIs instead.

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

APA102_DRIVER_REQUIRED = yes

You can then call the APA102 API by including apa102.h in your code.

#Basic Configuration {#basic-configuration}

Add the following to your config.h:

Define Default Description
APA102_DI_PIN Not defined The GPIO pin connected to the DI pin of the first LED in the chain
APA102_CI_PIN Not defined The GPIO pin connected to the CI pin of the first LED in the chain
APA102_DEFAULT_BRIGHTNESS 31 The default global brightness level of the LEDs, from 0 to 31

#API {#api}

#void apa102_setleds(rgb_led_t *start_led, uint16_t num_leds)

Send RGB data to the APA102 LED chain.

#Arguments {#api-apa102-setleds-arguments}
  • rgb_led_t *start_led
    A pointer to the LED array.
  • uint16_t num_leds
    The length of the LED array.

#void apa102_set_brightness(uint8_t brightness)

Set the global brightness.

#Arguments {#api-apa102-set-brightness-arguments}
  • uint8_t brightness
    The brightness level to set, from 0 to 31.
Do not follow this link