Skip to content

Commit

Permalink
update all docs to reflect
Browse files Browse the repository at this point in the history
  • Loading branch information
Xelus22 committed Nov 28, 2024
1 parent b15f3f7 commit f30832c
Show file tree
Hide file tree
Showing 15 changed files with 34 additions and 15 deletions.
11 changes: 6 additions & 5 deletions docs/drivers/apa102.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,12 @@ You can then call the APA102 API by including `apa102.h` in your code.

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 |
|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 |
|`APA102_DOUBLE_BUFFER` |*Not defined*|(Optional) Use double buffer when rendering |

## API {#api}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3218.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ Add the following to your `config.h`:
|`IS31FL3218_SDB_PIN` |*Not defined*|The GPIO pin connected to the driver's shutdown pin|
|`IS31FL3218_I2C_TIMEOUT` |`100` |The I²C timeout in milliseconds |
|`IS31FL3218_I2C_PERSISTENCE`|`0` |The number of times to retry I²C transmissions |
|`IS31FL3218_DOUBLE_BUFFER` |*Not defined*|(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
2 changes: 2 additions & 0 deletions docs/drivers/is31fl3236.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ Add the following to your `config.h`:
|`IS31FL3236_I2C_ADDRESS_2` |*Not defined*|The I²C address of driver 1 |
|`IS31FL3236_I2C_ADDRESS_3` |*Not defined*|The I²C address of driver 2 |
|`IS31FL3236_I2C_ADDRESS_4` |*Not defined*|The I²C address of driver 3 |
|`IS31FL3236_DOUBLE_BUFFER` |*Not defined*|(Optional) Use double buffer when rendering |


### I²C Addressing {#i2c-addressing}

Expand Down
2 changes: 2 additions & 0 deletions docs/drivers/is31fl3729.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Add the following to your `config.h`:
|`IS31FL3729_SW_PULLDOWN` |`IS31FL3729_SW_PULLDOWN_2K_OHM_SW_OFF`|The `SWx` pullup resistor value |
|`IS31FL3729_CS_PULLUP` |`IS31FL3729_CS_PULLUP_2K_OHM_CS_OFF` |The `CSx` pulldown resistor value |
|`IS31FL3729_GLOBAL_CURRENT` |`0x40` |The global current control value |
|`IS31FL3729_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |


### I²C Addressing {#i2c-addressing}

Expand Down
2 changes: 2 additions & 0 deletions docs/drivers/is31fl3731.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Add the following to your `config.h`:
|`IS31FL3731_I2C_ADDRESS_3` |*Not defined*|The I²C address of driver 2 |
|`IS31FL3731_I2C_ADDRESS_4` |*Not defined*|The I²C address of driver 3 |
|`IS31FL3731_DEGHOST` |*Not defined*|Enable ghost image prevention |
|`IS31FL3731_DOUBLE_BUFFER` |*Not defined*|(Optional) Use double buffer when rendering |


### I²C Addressing {#i2c-addressing}

Expand Down
2 changes: 2 additions & 0 deletions docs/drivers/is31fl3733.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ Add the following to your `config.h`:
|`IS31FL3733_SW_PULLUP` |`IS31FL3733_PUR_0_OHM` |The `SWx` pullup resistor value |
|`IS31FL3733_CS_PULLDOWN` |`IS31FL3733_PDR_0_OHM` |The `CSx` pulldown resistor value |
|`IS31FL3733_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3733_DOUBLE_BUFFER` |`false` |(Optional) Use double buffer when rendering |


### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3736.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Add the following to your `config.h`:
|`IS31FL3736_SW_PULLUP` |`IS31FL3736_PUR_0_OHM` |The `SWx` pullup resistor value |
|`IS31FL3736_CS_PULLDOWN` |`IS31FL3736_PDR_0_OHM` |The `CSx` pulldown resistor value |
|`IS31FL3736_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3736_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3737.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Add the following to your `config.h`:
|`IS31FL3737_SW_PULLUP` |`IS31FL3737_PUR_0_OHM` |The `SWx` pullup resistor value |
|`IS31FL3737_CS_PULLDOWN` |`IS31FL3737_PDR_0_OHM` |The `CSx` pulldown resistor value |
|`IS31FL3737_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3737_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3741.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Add the following to your `config.h`:
|`IS31FL3741_SW_PULLUP` |`IS31FL3741_PUR_32K_OHM` |The `SWx` pullup resistor value |
|`IS31FL3741_CS_PULLDOWN` |`IS31FL3741_PDR_32K_OHM` |The `CSx` pulldown resistor value |
|`IS31FL3741_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3741_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3742a.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Add the following to your `config.h`:
|`IS31FL3742A_SW_PULLDOWN` |`IS31FL3742A_PDR_8K_OHM` |The `SWx` pulldown resistor value |
|`IS31FL3742A_CS_PULLUP` |`IS31FL3742A_PUR_8K_OHM` |The `CSx` pullup resistor value |
|`IS31FL3742A_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3742A_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3743a.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Add the following to your `config.h`:
|`IS31FL3743A_SW_PULLDOWN` |`IS31FL3743A_PDR_2K_OHM_SW_OFF`|The `SWx` pulldown resistor value |
|`IS31FL3743A_CS_PULLUP` |`IS31FL3743A_PUR_2K_OHM_CS_OFF`|The `CSx` pullup resistor value |
|`IS31FL3743A_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3743A_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3745.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ Add the following to your `config.h`:
|`IS31FL3745_SW_PULLDOWN` |`IS31FL3745_PDR_2K_OHM_SW_OFF`|The `SWx` pulldown resistor value |
|`IS31FL3745_CS_PULLUP` |`IS31FL3745_PUR_2K_OHM_CS_OFF`|The `CSx` pullup resistor value |
|`IS31FL3745_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3745_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/is31fl3746a.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ Add the following to your `config.h`:
|`IS31FL3746A_SW_PULLDOWN` |`IS31FL3746A_PDR_2K_OHM_SW_OFF` |The `SWx` pulldown resistor value |
|`IS31FL3746A_CS_PULLUP` |`IS31FL3746A_PUR_2K_OHM_CS_OFF` |The `CSx` pullup resistor value |
|`IS31FL3746A_GLOBAL_CURRENT` |`0xFF` |The global current control value |
|`IS31FL3746A_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
1 change: 1 addition & 0 deletions docs/drivers/snled27351.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ Add the following to your `config.h`:
|`SNLED27351_I2C_ADDRESS_2` |*Not defined*|The I²C address of driver 1 |
|`SNLED27351_I2C_ADDRESS_3` |*Not defined*|The I²C address of driver 2 |
|`SNLED27351_I2C_ADDRESS_4` |*Not defined*|The I²C address of driver 3 |
|`SNLED27351_DOUBLE_BUFFER` |*Not defined*|(Optional) Use double buffer when rendering |

### I²C Addressing {#i2c-addressing}

Expand Down
21 changes: 11 additions & 10 deletions docs/drivers/ws2812.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,17 @@ You can then call the WS2812 API by including `ws2812.h` in your code.

Add the following to your `config.h`:

|Define |Default |Description |
|-------------------|-----------------------|------------------------------------------------------------------------------------------------|
|`WS2812_DI_PIN` |*Not defined* |The GPIO pin connected to the DI pin of the first LED in the chain |
|`WS2812_LED_COUNT` |*Not defined* |Number of LEDs in the WS2812 chain - automatically set when RGBLight or RGB Matrix is configured|
|`WS2812_TIMING` |`1250` |The total length of a bit (TH+TL) in nanoseconds |
|`WS2812_T1H` |`900` |The length of a "1" bit's high phase in nanoseconds |
|`WS2812_T0H` |`350` |The length of a "0" bit's high phase in nanoseconds |
|`WS2812_TRST_US` |`280` |The length of the reset phase in microseconds |
|`WS2812_BYTE_ORDER`|`WS2812_BYTE_ORDER_GRB`|The byte order of the RGB data |
|`WS2812_RGBW` |*Not defined* |Enables RGBW support (except `i2c` driver) |
|Define |Default |Description |
|------------------------|-----------------------|------------------------------------------------------------------------------------------------|
|`WS2812_DI_PIN` |*Not defined* |The GPIO pin connected to the DI pin of the first LED in the chain |
|`WS2812_LED_COUNT` |*Not defined* |Number of LEDs in the WS2812 chain - automatically set when RGBLight or RGB Matrix is configured|
|`WS2812_TIMING` |`1250` |The total length of a bit (TH+TL) in nanoseconds |
|`WS2812_T1H` |`900` |The length of a "1" bit's high phase in nanoseconds |
|`WS2812_T0H` |`350` |The length of a "0" bit's high phase in nanoseconds |
|`WS2812_TRST_US` |`280` |The length of the reset phase in microseconds |
|`WS2812_BYTE_ORDER` |`WS2812_BYTE_ORDER_GRB`|The byte order of the RGB data |
|`WS2812_RGBW` |*Not defined* |Enables RGBW support (except `i2c` driver) |
|`WS2812_DOUBLE_BUFFER` |*Not defined* |(Optional) Use double buffer when rendering (except `pwm` and `pio` driver) |

### Timing Adjustment {#timing-adjustment}

Expand Down

0 comments on commit f30832c

Please sign in to comment.