Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

LED drivers: extract documentation from LED/RGB Matrix pages #23630

Merged
merged 6 commits into from
Jul 15, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Merge branch 'develop' into led-drivers-documentation
  • Loading branch information
fauxpark committed Jun 2, 2024
commit 988a5ae290a71c16882588e1d7ded0e7bb9c1158
4 changes: 2 additions & 2 deletions docs/aw20216s_driver.md → docs/drivers/aw20216s.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ SPI 18x12 LED matrix driver by Awinic. Supports a maximum of four drivers, each

## Usage :id=usage

The AW20216S driver code is automatically included if you are using the [RGB Matrix](feature_rgb_matrix.md) feature with the `aw20216s` driver set, and you would use those APIs instead.
The AW20216S driver code is automatically included if you are using the [RGB Matrix](../features/rgb_matrix) feature with the `aw20216s` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -40,7 +40,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. To adju

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure SPI](spi_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure SPI](spi#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3218_driver.md → docs/drivers/is31fl3218.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C LED driver by Lumissil. Supports up to 18 single-color LEDs, or 6 RGB LEDs.

## Usage :id=usage

The IS31FL3218 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3218` driver set, and you would use those APIs instead.
The IS31FL3218 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3218` driver set, and you would use those APIs instead.

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

Expand All @@ -33,7 +33,7 @@ The IS31FL3218's 7-bit I²C address is `0x54`, available as `IS31FL3218_I2C_ADDR

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3236_driver.md → docs/drivers/is31fl3236.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C LED driver by Lumissil. Supports a maximum of four drivers, each controllin

## Usage :id=usage

The IS31FL3236 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3236` driver set, and you would use those APIs instead.
The IS31FL3236 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3236` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -46,7 +46,7 @@ To configure this, set the `IS31FL3236_I2C_ADDRESS_n` defines to one of the foll

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3729_driver.md → docs/drivers/is31fl3729.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 16x8/15x9 LED matrix driver by Lumissil. Supports a maximum of four drivers

## Usage :id=usage

The IS31FL3729 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3729` driver set, and you would use those APIs instead.
The IS31FL3729 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3729` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -116,7 +116,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3731_driver.md → docs/drivers/is31fl3731.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C Charlieplexed 16x9 LED matrix driver by Lumissil. Supports a maximum of fou

## Usage :id=usage

The IS31FL3731 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3731` driver set, and you would use those APIs instead.
The IS31FL3731 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/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`:

Expand Down Expand Up @@ -57,7 +57,7 @@ To enable, add the following to your `config.h`:

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3733_driver.md → docs/drivers/is31fl3733.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 12x16 LED matrix driver by Lumissil. Supports a maximum of four drivers, ea

## Usage :id=usage

The IS31FL3733 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3733` driver set, and you would use those APIs instead.
The IS31FL3733 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3733` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -141,7 +141,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3736_driver.md → docs/drivers/is31fl3736.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 12x8 LED matrix driver by Lumissil. Supports a maximum of four drivers, eac

## Usage :id=usage

The IS31FL3736 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3736` driver set, and you would use those APIs instead.
The IS31FL3736 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3736` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -125,7 +125,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3737_driver.md → docs/drivers/is31fl3737.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 12x12 LED matrix driver by Lumissil. Supports a maximum of four drivers, ea

## Usage :id=usage

The IS31FL3737 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3737` driver set, and you would use those APIs instead.
The IS31FL3737 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3737` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -113,7 +113,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3741_driver.md → docs/drivers/is31fl3741.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 39x9 LED matrix driver by Lumissil. Supports a maximum of four drivers, eac

## Usage :id=usage

The IS31FL3741 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3741` driver set, and you would use those APIs instead.
The IS31FL3741 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3741` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -113,7 +113,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3742a_driver.md → docs/drivers/is31fl3742a.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 30x6 LED matrix driver by Lumissil. Supports a maximum of four drivers, eac

## Usage :id=usage

The IS31FL3742A driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3742a` driver set, and you would use those APIs instead.
The IS31FL3742A driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3742a` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -113,7 +113,7 @@ This setting controls the current sunk by the `CSx` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3743a_driver.md → docs/drivers/is31fl3743a.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 18x11 LED matrix driver by Lumissil. Supports a maximum of four drivers, ea

## Usage :id=usage

The IS31FL3743A driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3743a` driver set, and you would use those APIs instead.
The IS31FL3743A driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3743a` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -123,7 +123,7 @@ This setting controls the current sunk by the `CSy` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3745_driver.md → docs/drivers/is31fl3745.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 18x8 LED matrix driver by Lumissil. Supports a maximum of four drivers, eac

## Usage :id=usage

The IS31FL3745 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3745` driver set, and you would use those APIs instead.
The IS31FL3745 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3745` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -123,7 +123,7 @@ This setting controls the current sunk by the `CSy` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/is31fl3746a_driver.md → docs/drivers/is31fl3746a.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ I²C 18x4 LED matrix driver by Lumissil. Supports a maximum of four drivers, eac

## Usage :id=usage

The IS31FL3746A driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `is31fl3746a` driver set, and you would use those APIs instead.
The IS31FL3746A driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `is31fl3746a` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -128,7 +128,7 @@ This setting controls the current sunk by the `CSy` pins, from 0 to 255. By defa

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
4 changes: 2 additions & 2 deletions docs/snled27351_driver.md → docs/drivers/snled27351.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ A slightly modified version of this IC is also known as "CKLED2001".

## Usage :id=usage

The SNLED27351 driver code is automatically included if you are using the [LED Matrix](feature_led_matrix.md) or [RGB Matrix](feature_rgb_matrix.md) feature with the `snled27351` driver set, and you would use those APIs instead.
The SNLED27351 driver code is automatically included if you are using the [LED Matrix](../features/led_matrix) or [RGB Matrix](../features/rgb_matrix) feature with the `snled27351` driver set, and you would use those APIs instead.

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

Expand Down Expand Up @@ -48,7 +48,7 @@ To configure this, set the `SNLED27351_I2C_ADDRESS_n` defines to one of the foll

## ARM/ChibiOS Configuration :id=arm-configuration

Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c_driver.md#arm-configuration) at the keyboard level.
Depending on the ChibiOS board configuration, you may need to [enable and configure I²C](i2c#arm-configuration) at the keyboard level.

## LED Mapping :id=led-mapping

Expand Down
26 changes: 13 additions & 13 deletions docs/features/led_matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,19 @@ LED Matrix is an abstraction layer on top of an underlying LED driver API. The l

|Driver |Max LEDs|
|-------------------------------------|--------|
|[IS31FL3218](is31fl3218_driver.md) |18 |
|[IS31FL3236](is31fl3236_driver.md) |36 |
|[IS31FL3729](is31fl3729_driver.md) |135 |
|[IS31FL3731](is31fl3731_driver.md) |144 |
|[IS31FL3733](is31fl3733_driver.md) |192 |
|[IS31FL3736](is31fl3736_driver.md) |96 |
|[IS31FL3737](is31fl3737_driver.md) |144 |
|[IS31FL3741](is31fl3741_driver.md) |351 |
|[IS31FL3742A](is31fl3742a_driver.md) |180 |
|[IS31FL3743A](is31fl3743a_driver.md) |198 |
|[IS31FL3745](is31fl3745_driver.md) |144 |
|[IS31FL3746A](is31fl3746a_driver.md) |72 |
|[SNLED27351](snled27351_driver.md) |192 |
|[IS31FL3218](../drivers/is31fl3218) |18 |
|[IS31FL3236](../drivers/is31fl3236) |36 |
|[IS31FL3729](../drivers/is31fl3729) |135 |
|[IS31FL3731](../drivers/is31fl3731) |144 |
|[IS31FL3733](../drivers/is31fl3733) |192 |
|[IS31FL3736](../drivers/is31fl3736) |96 |
|[IS31FL3737](../drivers/is31fl3737) |144 |
|[IS31FL3741](../drivers/is31fl3741) |351 |
|[IS31FL3742A](../drivers/is31fl3742a)|180 |
|[IS31FL3743A](../drivers/is31fl3743a)|198 |
|[IS31FL3745](../drivers/is31fl3745) |144 |
|[IS31FL3746A](../drivers/is31fl3746a)|72 |
|[SNLED27351](../drivers/snled27351) |192 |

To assign the LED Matrix driver, add the following to your `rules.mk`, for example:

Expand Down
32 changes: 16 additions & 16 deletions docs/features/rgb_matrix.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,22 @@ RGB Matrix is an abstraction layer on top of an underlying LED driver API. The l

|Driver |Max LEDs|
|-------------------------------------|--------|
|[APA102](apa102_driver.md) |? |
|[AW20216S](aw20216s_driver.md) |72 |
|[IS31FL3218](is31fl3218_driver.md) |6 |
|[IS31FL3236](is31fl3236_driver.md) |12 |
|[IS31FL3729](is31fl3729_driver.md) |45 |
|[IS31FL3731](is31fl3731_driver.md) |48 |
|[IS31FL3733](is31fl3733_driver.md) |64 |
|[IS31FL3736](is31fl3736_driver.md) |32 |
|[IS31FL3737](is31fl3737_driver.md) |48 |
|[IS31FL3741](is31fl3741_driver.md) |117 |
|[IS31FL3742A](is31fl3742a_driver.md) |60 |
|[IS31FL3743A](is31fl3743a_driver.md) |66 |
|[IS31FL3745](is31fl3745_driver.md) |48 |
|[IS31FL3746A](is31fl3746a_driver.md) |24 |
|[SNLED27351](snled27351_driver.md) |64 |
|[WS2812](ws2812_driver.md) |? |
|[APA102](../drivers/apa102) |? |
|[AW20216S](../drivers/aw20216s) |72 |
|[IS31FL3218](../drivers/is31fl3218) |6 |
|[IS31FL3236](../drivers/is31fl3236) |12 |
|[IS31FL3729](../drivers/is31fl3729) |45 |
|[IS31FL3731](../drivers/is31fl3731) |48 |
|[IS31FL3733](../drivers/is31fl3733) |64 |
|[IS31FL3736](../drivers/is31fl3736) |32 |
|[IS31FL3737](../drivers/is31fl3737) |48 |
|[IS31FL3741](../drivers/is31fl3741) |117 |
|[IS31FL3742A](../drivers/is31fl3742a)|60 |
|[IS31FL3743A](../drivers/is31fl3743a)|66 |
|[IS31FL3745](../drivers/is31fl3745) |48 |
|[IS31FL3746A](../drivers/is31fl3746a)|24 |
|[SNLED27351](../drivers/snled27351) |64 |
|[WS2812](../drivers/ws2812) |? |

To assign the RGB Matrix driver, add the following to your `rules.mk`, for example:

Expand Down
Loading
You are viewing a condensed version of this merge commit. You can view the full changes here.