mirror of
https://github.com/qmk/qmk_firmware.git
synced 2025-04-21 22:51:28 +00:00
Deploying to gh-pages from master @ 7ce5ba645a
🚀
This commit is contained in:
parent
7614083eaa
commit
13e2da17ef
@ -10,8 +10,10 @@ If you want to use RGB LED's you should use the [RGB Matrix Subsystem](feature_r
|
|||||||
|
|
||||||
There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
|
There is basic support for addressable LED matrix lighting with the I2C IS31FL3731 RGB controller. To enable it, add this to your `rules.mk`:
|
||||||
|
|
||||||
|
```make
|
||||||
LED_MATRIX_ENABLE = yes
|
LED_MATRIX_ENABLE = yes
|
||||||
LED_MATRIX_DRIVER = IS31FL3731
|
LED_MATRIX_DRIVER = IS31FL3731
|
||||||
|
```
|
||||||
|
|
||||||
You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
|
You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>` defines for IC's that are not present on your keyboard. You can define the following items in `config.h`:
|
||||||
|
|
||||||
@ -28,6 +30,7 @@ You can use between 1 and 4 IS31FL3731 IC's. Do not specify `LED_DRIVER_ADDR_<N>
|
|||||||
|
|
||||||
Here is an example using 2 drivers.
|
Here is an example using 2 drivers.
|
||||||
|
|
||||||
|
```c
|
||||||
// This is a 7-bit address, that gets left-shifted and bit 0
|
// This is a 7-bit address, that gets left-shifted and bit 0
|
||||||
// set to 0 for write, 1 for read (as per I2C protocol)
|
// set to 0 for write, 1 for read (as per I2C protocol)
|
||||||
// The address will vary depending on your wiring:
|
// The address will vary depending on your wiring:
|
||||||
@ -42,19 +45,23 @@ Here is an example using 2 drivers.
|
|||||||
#define LED_DRIVER_1_LED_COUNT 25
|
#define LED_DRIVER_1_LED_COUNT 25
|
||||||
#define LED_DRIVER_2_LED_COUNT 24
|
#define LED_DRIVER_2_LED_COUNT 24
|
||||||
#define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL
|
#define LED_DRIVER_LED_COUNT LED_DRIVER_1_LED_TOTAL + LED_DRIVER_2_LED_TOTAL
|
||||||
|
```
|
||||||
|
|
||||||
Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
|
Currently only 2 drivers are supported, but it would be trivial to support all 4 combinations.
|
||||||
|
|
||||||
Define these arrays listing all the LEDs in your `<keyboard>.c`:
|
Define these arrays listing all the LEDs in your `<keyboard>.c`:
|
||||||
|
|
||||||
|
```c
|
||||||
const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
|
const is31_led g_is31_leds[DRIVER_LED_TOTAL] = {
|
||||||
/* Refer to IS31 manual for these locations
|
/* Refer to IS31 manual for these locations
|
||||||
* driver
|
* driver
|
||||||
* | LED address
|
* | LED address
|
||||||
* | | */
|
* | | */
|
||||||
{0, C3_3},
|
{ 0, C1_1 },
|
||||||
....
|
{ 0, C1_15 },
|
||||||
|
// ...
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731-simple.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` ).
|
Where `Cx_y` is the location of the LED in the matrix defined by [the datasheet](https://www.issi.com/WW/pdf/31FL3731.pdf) and the header file `drivers/issi/is31fl3731-simple.h`. The `driver` is the index of the driver you defined in your `config.h` (`0`, `1`, `2`, or `3` ).
|
||||||
|
|
||||||
@ -66,26 +73,28 @@ All LED matrix keycodes are currently shared with the [backlight system](feature
|
|||||||
|
|
||||||
Currently no LED matrix effects have been created.
|
Currently no LED matrix effects have been created.
|
||||||
|
|
||||||
## Custom layer effects
|
## Custom Layer Effects
|
||||||
|
|
||||||
Custom layer effects can be done by defining this in your `<keyboard>.c`:
|
Custom layer effects can be done by defining this in your `<keyboard>.c`:
|
||||||
|
|
||||||
|
```c
|
||||||
void led_matrix_indicators_kb(void) {
|
void led_matrix_indicators_kb(void) {
|
||||||
led_matrix_set_index_value(index, value);
|
led_matrix_set_index_value(index, value);
|
||||||
}
|
}
|
||||||
|
```
|
||||||
|
|
||||||
A similar function works in the keymap as `led_matrix_indicators_user`.
|
A similar function works in the keymap as `led_matrix_indicators_user`.
|
||||||
|
|
||||||
## Suspended state
|
## Suspended State
|
||||||
|
|
||||||
To use the suspend feature, add this to your `<keyboard>.c`:
|
To use the suspend feature, add this to your `<keyboard>.c`:
|
||||||
|
|
||||||
void suspend_power_down_kb(void)
|
```c
|
||||||
{
|
void suspend_power_down_kb(void) {
|
||||||
led_matrix_set_suspend_state(true);
|
led_matrix_set_suspend_state(true);
|
||||||
}
|
}
|
||||||
|
|
||||||
void suspend_wakeup_init_kb(void)
|
void suspend_wakeup_init_kb(void) {
|
||||||
{
|
|
||||||
led_matrix_set_suspend_state(false);
|
led_matrix_set_suspend_state(false);
|
||||||
}
|
}
|
||||||
|
```
|
@ -142,7 +142,7 @@ This global variable allows to decode and response a setup request. It can be up
|
|||||||
Members | Descriptions
|
Members | Descriptions
|
||||||
--------------------------------|---------------------------------------------
|
--------------------------------|---------------------------------------------
|
||||||
`public `[`usb_setup_req_t`](.build/docs/internals_usb_protocol_group.md#structusb__setup__req__t)` `[`req`](#structudd__ctrl__request__t_1a8ca591128eb7000ed02f8cc730af6e69) | Data received in USB SETUP packet Note: The swap of "req.wValues" from uin16_t to le16_t is done by UDD.
|
`public `[`usb_setup_req_t`](.build/docs/internals_usb_protocol_group.md#structusb__setup__req__t)` `[`req`](#structudd__ctrl__request__t_1a8ca591128eb7000ed02f8cc730af6e69) | Data received in USB SETUP packet Note: The swap of "req.wValues" from uin16_t to le16_t is done by UDD.
|
||||||
`public uint8_t * `[`payload`](#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66) | [Point](.build/docs/internals_undefined.md#struct_point) to buffer to send or fill with data following SETUP packet This buffer must be word align for DATA IN phase (use prefix COMPILER_WORD_ALIGNED for buffer)
|
`public uint8_t * `[`payload`](#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66) | Point to buffer to send or fill with data following SETUP packet This buffer must be word align for DATA IN phase (use prefix COMPILER_WORD_ALIGNED for buffer)
|
||||||
`public uint16_t `[`payload_size`](#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f) | Size of buffer to send or fill, and content the number of byte transfered.
|
`public uint16_t `[`payload_size`](#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f) | Size of buffer to send or fill, and content the number of byte transfered.
|
||||||
`public void(* `[`callback`](#structudd__ctrl__request__t_1a11f084a69a85b6e1da79695b6a3d07c3) | Callback called after reception of ZLP from setup request.
|
`public void(* `[`callback`](#structudd__ctrl__request__t_1a11f084a69a85b6e1da79695b6a3d07c3) | Callback called after reception of ZLP from setup request.
|
||||||
`public bool(* `[`over_under_run`](#structudd__ctrl__request__t_1a3d31b0db5458678975632d6b5815ea8c) | Callback called when the buffer given (.payload) is full or empty. This one return false to abort data transfer, or true with a new buffer in .payload.
|
`public bool(* `[`over_under_run`](#structudd__ctrl__request__t_1a3d31b0db5458678975632d6b5815ea8c) | Callback called when the buffer given (.payload) is full or empty. This one return false to abort data transfer, or true with a new buffer in .payload.
|
||||||
@ -155,7 +155,7 @@ Data received in USB SETUP packet Note: The swap of "req.wValues" from uin16_t t
|
|||||||
|
|
||||||
#### `public uint8_t * `[`payload`](#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66) {#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66}
|
#### `public uint8_t * `[`payload`](#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66) {#structudd__ctrl__request__t_1aa5cbdad2c57e9b3f949e1a4d96382b66}
|
||||||
|
|
||||||
[Point](.build/docs/internals_undefined.md#struct_point) to buffer to send or fill with data following SETUP packet This buffer must be word align for DATA IN phase (use prefix COMPILER_WORD_ALIGNED for buffer)
|
Point to buffer to send or fill with data following SETUP packet This buffer must be word align for DATA IN phase (use prefix COMPILER_WORD_ALIGNED for buffer)
|
||||||
|
|
||||||
#### `public uint16_t `[`payload_size`](#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f) {#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f}
|
#### `public uint16_t `[`payload_size`](#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f) {#structudd__ctrl__request__t_1a34d21baa46ca7f4b695307631457c75f}
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user