ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

[Docs] Fixes for feature_rgblight.md (#8514)

Browse source 
* remove extra comma that breaks the RGBLight Layers example

* linting

- use four spaces instead of tabs for indenting
- remove trailing spaces
This commit is contained in:
James Young 2020-03-21 13:11:06 -07:00 • committed by GitHub
parent 8651eef298
commit a521fc2b6c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 16 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

30
docs/feature_rgblight.md
View file

@ -182,16 +182,16 @@ To define a layer, we modify `keymap.c` to list out LED ranges and the colors we
```c ```c
// Light LEDs 6 to 9 and 12 to 15 red when caps lock is active. Hard to ignore! // Light LEDs 6 to 9 and 12 to 15 red when caps lock is active. Hard to ignore!
const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS( const rgblight_segment_t PROGMEM my_capslock_layer[] = RGBLIGHT_LAYER_SEGMENTS(
{6, 4, HSV_RED}, // Light 4 LEDs, starting with LED 6 {6, 4, HSV_RED}, // Light 4 LEDs, starting with LED 6
{12, 4, HSV_RED} // Light 4 LEDs, starting with LED 12 {12, 4, HSV_RED} // Light 4 LEDs, starting with LED 12
); );
// Light LEDs 9 & 10 in cyan when keyboard layer 1 is active // Light LEDs 9 & 10 in cyan when keyboard layer 1 is active
const rgblight_segment_t PROGMEM my_layer1_layer[] = RGBLIGHT_LAYER_SEGMENTS( const rgblight_segment_t PROGMEM my_layer1_layer[] = RGBLIGHT_LAYER_SEGMENTS(
{9, 2, HSV_CYAN} {9, 2, HSV_CYAN}
); );
// Light LEDs 11 & 12 in purple when keyboard layer 2 is active // Light LEDs 11 & 12 in purple when keyboard layer 2 is active
const rgblight_segment_t PROGMEM my_layer2_layer[] = RGBLIGHT_LAYER_SEGMENTS( const rgblight_segment_t PROGMEM my_layer2_layer[] = RGBLIGHT_LAYER_SEGMENTS(
{11, 2, HSV_PURPLE}, {11, 2, HSV_PURPLE}
); );
// etc.. // etc..
``` ```
@ -201,14 +201,14 @@ We combine these layers into an array using the `RGBLIGHT_LAYERS_LIST` macro, an
```c ```c
// Now define the array of layers. Later layers take precedence // Now define the array of layers. Later layers take precedence
const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST( const rgblight_segment_t* const PROGMEM my_rgb_layers[] = RGBLIGHT_LAYERS_LIST(
my_capslock_layer, my_capslock_layer,
my_layer1_layer, // Overrides caps lock layer my_layer1_layer, // Overrides caps lock layer
my_layer2_layer // Overrides other layers my_layer2_layer // Overrides other layers
); );
void keyboard_post_init_user(void) { void keyboard_post_init_user(void) {
// Enable the LED layers // Enable the LED layers
rgblight_layers = my_rgb_layers; rgblight_layers = my_rgb_layers;
} }
``` ```
@ -216,15 +216,15 @@ Finally, we enable and disable the lighting layers whenever the state of the key
```c ```c
layer_state_t layer_state_set_user(layer_state_t state) { layer_state_t layer_state_set_user(layer_state_t state) {
// Both layers will light up if both kb layers are active // Both layers will light up if both kb layers are active
rgblight_set_layer_state(1, layer_state_cmp(state, 1)); rgblight_set_layer_state(1, layer_state_cmp(state, 1));
rgblight_set_layer_state(2, layer_state_cmp(state, 2)); rgblight_set_layer_state(2, layer_state_cmp(state, 2));
return state; return state;
} }
bool led_update_user(led_t led_state) { bool led_update_user(led_t led_state) {
rgblight_set_layer_state(0, led_state.caps_lock); rgblight_set_layer_state(0, led_state.caps_lock);
return true; return true;
} }
``` ```