aboutsummaryrefslogtreecommitdiff
path: root/docs/apa102_driver.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/apa102_driver.md')
-rw-r--r--docs/apa102_driver.md16
1 files changed, 8 insertions, 8 deletions
diff --git a/docs/apa102_driver.md b/docs/apa102_driver.md
index 1da2de6ca3..0f905e3f18 100644
--- a/docs/apa102_driver.md
+++ b/docs/apa102_driver.md
@@ -1,10 +1,10 @@
-# APA102 Driver :id=apa102-driver
+# APA102 Driver {#apa102-driver}
-This driver provides support for APA102 addressable RGB LEDs. They are similar to the [WS2812](ws2812_driver.md) LEDs, but have increased data and refresh rates.
+This driver provides support for APA102 addressable RGB LEDs. They are similar to the [WS2812](ws2812_driver) LEDs, but have increased data and refresh rates.
-## Usage :id=usage
+## Usage {#usage}
-In most cases, the APA102 driver code is automatically included if you are using either the [RGBLight](feature_rgblight.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `apa102` driver set, and you would use those APIs instead.
+In most cases, the APA102 driver code is automatically included if you are using either the [RGBLight](feature_rgblight) or [RGB Matrix](feature_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`:
@@ -14,7 +14,7 @@ APA102_DRIVER_REQUIRED = yes
You can then call the APA102 API by including `apa102.h` in your code.
-## Basic Configuration :id=basic-configuration
+## Basic Configuration {#basic-configuration}
Add the following to your `config.h`:
@@ -24,13 +24,13 @@ Add the following to your `config.h`:
|`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 :id=api
+## API {#api}
### `void apa102_setleds(rgb_led_t *start_led, uint16_t num_leds)`
Send RGB data to the APA102 LED chain.
-#### Arguments :id=api-apa102-setleds-arguments
+#### Arguments {#api-apa102-setleds-arguments}
- `rgb_led_t *start_led`
A pointer to the LED array.
@@ -43,7 +43,7 @@ Send RGB data to the APA102 LED chain.
Set the global brightness.
-#### Arguments :id=api-apa102-set-brightness-arguments
+#### Arguments {#api-apa102-set-brightness-arguments}
- `uint8_t brightness`
The brightness level to set, from 0 to 31.