Skip to content

Commit

Permalink
Update examples and README
Browse files Browse the repository at this point in the history
Signed-off-by: Evy Bongers <[email protected]>
  • Loading branch information
EvyBongers committed Nov 12, 2023
1 parent 4d1f2d3 commit 8dc41a6
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
10 changes: 9 additions & 1 deletion plugins/Kaleidoscope-LED-ActiveLayerKeys/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,16 @@ void setup () {
};

Kaleidoscope.setup();
// By default, only LEDs for keys on the topmost layer are lit.
//LEDActiveLayerKeysEffect.lightLowerLayers(false);
LEDActiveLayerKeysEffect.setColormap(layerColormap);
}
```
## Plugin properties
The plugin provides the `LEDActiveLayerKeysEffect` object, which has the following
method:
methods:
### `.setColormap(colormap)`
Expand All @@ -43,6 +45,12 @@ method:
> same amount of items as there are layers. Any layer that doesn't have a
> matching entry in the array, will have leds turned off.
### `.lightLowerLayers(boolean)`
> By default, this plugin only lights up LEDs keys on the topmost layer. This
> method allows overriding this default, to have the plugin change the leds of
> all non-blocked keys to the color of their respective layers.
## Dependencies
* [Kaleidoscope-LEDControl](Kaleidoscope-LEDControl.md)
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,8 @@ void setup() {

Kaleidoscope.setup();
LEDActiveLayerKeysEffect.setColormap(layerColormap);
// Light up leds of keys on lower layers as well
LEDActiveLayerKeysEffect.lightLowerLayers(true);
LEDActiveLayerKeysEffect.activate();
}

Expand Down

0 comments on commit 8dc41a6

Please sign in to comment.