diff --git a/README.md b/README.md index 7a000dfb..55382bd0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-LED-ActiveModColor +# Kaleidoscope-LED-ActiveModColor ![status][st:experimental] @@ -16,18 +16,19 @@ To use the plugin, one needs to include the header, and activate the effect. It is also possible to use a custom color instead of the white default. ```c++ -#include +#include +#include void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); - Keyboardio.use (&ActiveModColorEffect, NULL); + Kaleidoscope.use (&ActiveModColorEffect, NULL); ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } ``` -It is recommended to place the activation (the `Keyboardio.use` call) of the +It is recommended to place the activation (the `Kaleidoscope.use` call) of the plugin last, so that it can reliably override any other plugins that may work with the LEDs, and apply the highlight over those. @@ -46,4 +47,4 @@ method: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-LED-ActiveModColor/blob/master/examples/LED-ActiveModColor/LED-ActiveModColor.ino diff --git a/examples/LED-ActiveModColor/LED-ActiveModColor.ino b/examples/LED-ActiveModColor/LED-ActiveModColor.ino index 6a6e40d1..69496129 100644 --- a/examples/LED-ActiveModColor/LED-ActiveModColor.ino +++ b/examples/LED-ActiveModColor/LED-ActiveModColor.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,8 @@ * along with this program. If not, see . */ -#include +#include +#include const Key keymaps[][ROWS][COLS] PROGMEM = { [0] = KEYMAP_STACKED @@ -40,12 +41,12 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { }; void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&LEDControl, &ActiveModColorEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &ActiveModColorEffect, NULL); ActiveModColorEffect.configure ({0x00, 0xff, 0xff}); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 43508d3b..6108b80a 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-LED-ActiveModColor +name=Kaleidoscope-LED-ActiveModColor version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy +maintainer=Gergely Nagy sentence=Light up the LEDs under the active modifiers. paragraph=Supports one-shot and normal modifiers - if it is active, it lights up. category=Communication -url=https://github.com/keyboardio/Akela-LED-ActiveModColor +url=https://github.com/keyboardio/Kaleidoscope-LED-ActiveModColor architectures=avr dot_a_linkage=true diff --git a/src/Akela-LED-ActiveModColor.h b/src/Kaleidoscope-LED-ActiveModColor.h similarity index 85% rename from src/Akela-LED-ActiveModColor.h rename to src/Kaleidoscope-LED-ActiveModColor.h index fc6f5506..e9a70b39 100644 --- a/src/Akela-LED-ActiveModColor.h +++ b/src/Kaleidoscope-LED-ActiveModColor.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,4 +18,4 @@ #pragma once -#include +#include diff --git a/src/Akela/LED-ActiveModColor.cpp b/src/Kaleidoscope/LED-ActiveModColor.cpp similarity index 78% rename from src/Akela/LED-ActiveModColor.cpp rename to src/Kaleidoscope/LED-ActiveModColor.cpp index 7dbd8691..0c9e2baa 100644 --- a/src/Akela/LED-ActiveModColor.cpp +++ b/src/Kaleidoscope/LED-ActiveModColor.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,10 @@ * along with this program. If not, see . */ -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { cRGB ActiveModColorEffect::highlightColor = (cRGB) {0xff, 0xff, 0xff}; @@ -44,8 +45,8 @@ namespace Akela { for (byte c = 0; c < COLS; c++) { Key k = Layer.lookup (r, c); - if (k.raw >= Akela::Ranges::OSM_FIRST && k.raw <= Akela::Ranges::OSM_LAST) { - uint8_t idx = k.raw - Akela::Ranges::OSM_FIRST; + if (k.raw >= KaleidoscopePlugins::Ranges::OSM_FIRST && k.raw <= KaleidoscopePlugins::Ranges::OSM_LAST) { + uint8_t idx = k.raw - KaleidoscopePlugins::Ranges::OSM_FIRST; k.flags = 0; k.keyCode = Key_LCtrl.keyCode + idx; } @@ -62,4 +63,4 @@ namespace Akela { }; }; -Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect; diff --git a/src/Akela/LED-ActiveModColor.h b/src/Kaleidoscope/LED-ActiveModColor.h similarity index 75% rename from src/Akela/LED-ActiveModColor.h rename to src/Kaleidoscope/LED-ActiveModColor.h index 096536c4..ee6abbde 100644 --- a/src/Akela/LED-ActiveModColor.h +++ b/src/Kaleidoscope/LED-ActiveModColor.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-ActiveModColor -- Light up the LEDs under the active modifiers * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,12 +16,12 @@ * along with this program. If not, see . */ -#include -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { - class ActiveModColorEffect : public KeyboardioPlugin { + class ActiveModColorEffect : public KaleidoscopePlugin { public: ActiveModColorEffect (void); @@ -35,4 +35,4 @@ namespace Akela { }; }; -extern Akela::LEDEffects::ActiveModColorEffect ActiveModColorEffect; +extern KaleidoscopePlugins::LEDEffects::ActiveModColorEffect ActiveModColorEffect;