diff --git a/README.md b/README.md index 652f986e..3afdbfd7 100644 --- a/README.md +++ b/README.md @@ -29,14 +29,26 @@ KALEIDOSCOPE_INIT_PLUGINS(LEDRainbowEffect, LEDRainbowWaveEffect); void setup() { Kaleidoscope.setup(); + + LEDRainbowEffect.brightness(150); + LEDRainbowWaveEffect.brightness(150); + LEDRainbowWaveEffect.delay(50); } ``` ## Plugin methods The plugin provides two objects: `LEDRainbowEffect`, and `LEDRainbowWaveEffect`, -neither of which have any public methods or properties, outside of those -provided by all LED modes. +both of which provide the following methods: + +### `.brightness(brightness)` + +Sets the LED brightness for the effect. + +### `.update_delay(delay)` + +Sets the number of miliseconds between effect updates. +Smaller number = faster rainbows. ## Dependencies diff --git a/src/Kaleidoscope-LEDEffect-Rainbow.cpp b/src/Kaleidoscope-LEDEffect-Rainbow.cpp index 5fdbcc5f..a8a4f21e 100644 --- a/src/Kaleidoscope-LEDEffect-Rainbow.cpp +++ b/src/Kaleidoscope-LEDEffect-Rainbow.cpp @@ -23,6 +23,10 @@ void LEDRainbowEffect::brightness(byte brightness) { rainbow_value = brightness; } +void LEDRainbowEffect::update_delay(byte delay) { + rainbow_update_delay = delay; +} + // --------- @@ -51,6 +55,10 @@ void LEDRainbowWaveEffect::update(void) { void LEDRainbowWaveEffect::brightness(byte brightness) { rainbow_value = brightness; } + +void LEDRainbowWaveEffect::updat_delay(byte delay) { + rainbow_update_delay = delay; +} } kaleidoscope::LEDRainbowEffect LEDRainbowEffect; diff --git a/src/Kaleidoscope-LEDEffect-Rainbow.h b/src/Kaleidoscope-LEDEffect-Rainbow.h index e3a66210..bd87d998 100644 --- a/src/Kaleidoscope-LEDEffect-Rainbow.h +++ b/src/Kaleidoscope-LEDEffect-Rainbow.h @@ -9,6 +9,7 @@ class LEDRainbowEffect : public LEDMode { LEDRainbowEffect(void) {} void brightness(byte); + void update_delay(byte); void update(void) final; private: @@ -28,6 +29,7 @@ class LEDRainbowWaveEffect : public LEDMode { LEDRainbowWaveEffect(void) {} void brightness(byte); + void update_delay(byte); void update(void) final; private: