diff options
| author | Drashna Jaelre <drashna@live.com> | 2018-05-29 08:05:22 -0700 |
|---|---|---|
| committer | Jack Humbert <jack.humb@gmail.com> | 2018-05-29 11:05:22 -0400 |
| commit | 751719e6cb547db753b2f33f06ee6fa61607d544 (patch) | |
| tree | 456437ab1d6c051e73ccd2e92d4fb1445d496ca8 /docs/feature_rgblight.md | |
| parent | 034a25aedf5e0ddba2b05f4b3534c1522330d5cd (diff) | |
| download | qmk_firmware-751719e6cb547db753b2f33f06ee6fa61607d544.tar.gz qmk_firmware-751719e6cb547db753b2f33f06ee6fa61607d544.zip | |
Add and fix _noeeprom functions to many of the RGB Underglow functions (#3070)
* And and fix _noeeprom functions to many of the RGB Underglow functions
* Many functions are unnecessarily calling the eeprom write code. The toggle/enable is command is especially guilty of this, as it writes to EEPROM 3 times. But rgb mode writes twice, every time it's called. And init resets the rgb eeprom range and then writes back to it twice!
* Fixed the rgblight_sethsv_noeeprom to work as expected, by moving a lot of the code to a helper function.
* Added a noeeprom function for mode, enable, disable, and toggle functions. (didn't bother for increase/decrease stuff, and didn't add new keycodes)
* Add to predefined colors list
* Add new functions to manual/docs
* Update RGB Sleep feature to use _noeeprom
Because that's exactly what it should be doing, actually!
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 35 |
1 files changed, 30 insertions, 5 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 0f1e649ef..5369d2fb7 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md | |||
| @@ -88,11 +88,36 @@ const uint16_t RGBLED_GRADIENT_RANGES[] PROGMEM = {360, 240, 180, 120, 90}; | |||
| 88 | Look in `rgblights.h` for all available functions, but if you want to control all or some LEDs your goto functions are: | 88 | Look in `rgblights.h` for all available functions, but if you want to control all or some LEDs your goto functions are: |
| 89 | 89 | ||
| 90 | ```c | 90 | ```c |
| 91 | rgblight_disable(); // turn all lights off | 91 | // turn all lights off (stored in EEPROM) |
| 92 | rgblight_enable(); // turn lights on, based on their previous state (stored in EEPROM) | 92 | rgblight_disable(); |
| 93 | // turn lights on, based on their previous state (stored in EEPROM) | ||
| 94 | rgblight_enable(); | ||
| 95 | |||
| 96 | // turn all lights off (not stored in EEPROM) | ||
| 97 | rgblight_disable_noeeprom(); | ||
| 98 | // turn lights on, based on their previous state (not stored in EEPROM) | ||
| 99 | rgblight_enable_noeeprom(); | ||
| 100 | |||
| 101 | // where r/g/b is a number from 0..255. Turns all the LEDs to this color (ignores mode, not stored in EEPROM). | ||
| 102 | rgblight_setrgb(r, g, b); | ||
| 103 | // HSV color control - h is a value from 0..360 and s/v is a value from 0..255 (stored in EEPROM) | ||
| 104 | rgblight_sethsv(h, s, v); | ||
| 105 | // HSV color control - h is a value from 0..360 and s/v is a value from 0..255 (not stored in EEPROM) | ||
| 106 | rgblight_sethsv_noeeprom(h, s, v); | ||
| 107 | |||
| 108 | // Sets the mode, if rgb animations are enabled (stored in eeprom) | ||
| 109 | rgblight_mode(x); | ||
| 110 | // Sets the mode, if rgb animations are enabled (not stored in eeprom) | ||
| 111 | rgblight_mode_noeeprom(x); | ||
| 112 | // MODE 1, solid color | ||
| 113 | // MODE 2-5, breathing | ||
| 114 | // MODE 6-8, rainbow mood | ||
| 115 | // MODE 9-14, rainbow swirl | ||
| 116 | // MODE 15-20, snake | ||
| 117 | // MODE 21-23, knight | ||
| 118 | // MODE 24, xmas | ||
| 119 | // MODE 25-34, static rainbow | ||
| 93 | 120 | ||
| 94 | rgblight_setrgb(r, g, b); // where r/g/b is a number from 0..255. Turns all the LEDs to this color | ||
| 95 | rgblight_sethsv(h, s, v); // HSV color control - h is a value from 0..360 and s/v is a value from 0..255 | ||
| 96 | rgblight_setrgb_at(r,g,b, LED); // control a single LED. 0 <= LED < RGBLED_NUM | 121 | rgblight_setrgb_at(r,g,b, LED); // control a single LED. 0 <= LED < RGBLED_NUM |
| 97 | rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM | 122 | rgblight_sethsv_at(h,s,v, LED); // control a single LED. 0 <= LED < RGBLED_NUM |
| 98 | ``` | 123 | ``` |
| @@ -126,7 +151,7 @@ note: for backwards compatibility, `RGB_SMOD` is an alias for `RGB_MOD`. | |||
| 126 | 151 | ||
| 127 | ## Hardware Modification | 152 | ## Hardware Modification |
| 128 | 153 | ||
| 129 |  | 154 |  |
| 130 | 155 | ||
| 131 | Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY). | 156 | Here is a quick demo on Youtube (with NPKC KC60) (https://www.youtube.com/watch?v=VKrpPAHlisY). |
| 132 | 157 | ||
