diff options
| author | skullydazed <skullydazed@users.noreply.github.com> | 2017-10-17 16:47:49 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-10-17 16:47:49 -0700 |
| commit | ad49db8cd2557b6c54531059d4d162623520bd17 (patch) | |
| tree | 574183832900a40562e6f9c4de78c33ac6cc018d /docs/feature_rgblight.md | |
| parent | d3fe6a0588965b71c6876b060d05abfceabacbb5 (diff) | |
Address #1689 by using a formula to define the breathing curve (#1692)
* Address #1689 by using a formula to define the breathing curve and exposing defines to control the shape of the curve.
* Tweak the behavior of breathing for clueboard
Diffstat (limited to 'docs/feature_rgblight.md')
| -rw-r--r-- | docs/feature_rgblight.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/feature_rgblight.md b/docs/feature_rgblight.md index 4ee32f3ec2..c65a499fbe 100644 --- a/docs/feature_rgblight.md +++ b/docs/feature_rgblight.md @@ -49,8 +49,10 @@ If you have `#define RGBLIGHT_ANIMATIONS` in your `config.h` you will have a num | Option | Default Value | Description | |--------|---------------|-------------| | `RGBLIGHT_ANIMATIONS` | | `#define` this to enable animation modes. | -| `RGBLIGHT_EFFECT_SNAKE_LENGTH` | 4 | The number of LEDs to light up for the "snake" mode. | -| `RGBLIGHT_EFFECT_KNIGHT_LENGTH` | 3 | The number of LEDs to light up for the "knight" mode. | +| `RGBLIGHT_EFFECT_BREATHE_CENTER | 1.85 | Used to calculate the curve for the breathing animation. Valid values 1.0-2.7. | +| `RGBLIGHT_EFFECT_BREATHE_MAX | 255 | The maximum brightness for the breathing mode. Valid values 1-255. | +| `RGBLIGHT_EFFECT_SNAKE_LENGTH` | 4 | The number of LEDs to light up for the "snake" animation. | +| `RGBLIGHT_EFFECT_KNIGHT_LENGTH` | 3 | The number of LEDs to light up for the "knight" animation. | | `RGBLIGHT_EFFECT_KNIGHT_OFFSET` | 0 | Start the knight animation this many LEDs from the start of the strip. | | `RGBLIGHT_EFFECT_KNIGHT_LED_NUM` | RGBLED_NUM | The number of LEDs to have the "knight" animation travel. | | `RGBLIGHT_EFFECT_CHRISTMAS_INTERVAL` | 1000 | How long to wait between light changes for the "christmas" animation. Specified in ms. | |