diff --git a/README.md b/README.md index 71011bb7..16b0ed6b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-LEDEffects +# Kaleidoscope-LEDEffects ![status][st:stable] @@ -17,10 +17,11 @@ does not enable anything by default, and we will have to selectively enable the effects we are interested in. ```c++ -#include +#include +#include ``` -Then, in the `setup()` method of our Sketch, we will call `Keyboardio.use()`, +Then, in the `setup()` method of our Sketch, we will call `Kaleidoscope.use()`, with the selected effect objects. ## Included effects @@ -67,4 +68,4 @@ The plugin provides a single method on each of the included effect objects: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-LEDEffects/blob/master/examples/LEDEffects/LEDEffects.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-LEDEffects/blob/master/examples/LEDEffects/LEDEffects.ino diff --git a/TriColor.md b/TriColor.md index 15f02f71..3d79fd7c 100644 --- a/TriColor.md +++ b/TriColor.md @@ -1,4 +1,4 @@ -# Akela-TriColor +# Kaleidoscope-TriColor ![status][st:stable] @@ -10,7 +10,7 @@ The `TriColor` effect extension is a part of the [`LEDEffects`][plugin:ledeffects] library, not a stand-alone base library of its own. It is used to implement the effects in that library. - [plugin:ledeffects]: https://github/keyboardio/Akela-LEDEffects + [plugin:ledeffects]: https://github/keyboardio/Kaleidoscope-LEDEffects It is a class that can be used to create LED effects that all follow a similar pattern: alphas and similar in one color; modifiers, special keys, and half the @@ -24,16 +24,16 @@ Because the extension is part of the [`LEDEffects`][plugin:ledeffects] library, we need to include that header: ```c++ -#include +#include ``` Then, we simply create a new instance of the `TriColor` class, with appropriate colors set for the constructor: ```c++ -Akela::LEDEffects::TriColor BlackAndWhiteEffect ((cRGB){0x00, 0x00, 0x00}, - (cRGB){0xff, 0xff, 0xff}, - (cRGB){0x80, 0x80, 0x80}); +KaleidoscopePlugins::LEDEffects::TriColor BlackAndWhiteEffect ((cRGB){0x00, 0x00, 0x00}, + (cRGB){0xff, 0xff, 0xff}, + (cRGB){0x80, 0x80, 0x80}); ``` The first argument is the base color, the second is for modifiers and special diff --git a/examples/LEDEffects/LEDEffects.ino b/examples/LEDEffects/LEDEffects.ino index 3f1800e2..f4e67973 100644 --- a/examples/LEDEffects/LEDEffects.ino +++ b/examples/LEDEffects/LEDEffects.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * 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 #include "LED-Off.h" @@ -43,12 +44,12 @@ const Key keymaps[][ROWS][COLS] PROGMEM = { void setup () { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&LEDControl, &LEDOff, &MiamiEffect, &JukeboxEffect, &JukeboxAlternateEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &LEDOff, &MiamiEffect, &JukeboxEffect, &JukeboxAlternateEffect, NULL); MiamiEffect.activate (); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 2beb25a9..0fb17c84 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-LEDEffects +name=Kaleidoscope-LEDEffects version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=An assorted collection of LED effects for Keyboardio boards. +maintainer=Gergely Nagy +sentence=An assorted collection of LED effects for Kaleidoscope. paragraph=A neat effect for every occasion one can possibly think of! category=Communication -url=https://github.com/keyboardio/Akela-LEDEffects +url=https://github.com/keyboardio/Kaleidoscope-LEDEffects architectures=avr dot_a_linkage=true diff --git a/src/Akela-LEDEffects.h b/src/Kaleidoscope-LEDEffects.h similarity index 79% rename from src/Akela-LEDEffects.h rename to src/Kaleidoscope-LEDEffects.h index bd15539b..4e3fd86e 100644 --- a/src/Akela-LEDEffects.h +++ b/src/Kaleidoscope-LEDEffects.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,6 +18,6 @@ #pragma once -#include -#include -#include +#include +#include +#include diff --git a/src/Akela/Jukebox.cpp b/src/Kaleidoscope/Jukebox.cpp similarity index 50% rename from src/Akela/Jukebox.cpp rename to src/Kaleidoscope/Jukebox.cpp index 8044c8a7..c1364356 100644 --- a/src/Akela/Jukebox.cpp +++ b/src/Kaleidoscope/Jukebox.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016 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 -Akela::LEDEffects::TriColor JukeboxEffect((cRGB){0xc8, 0xe8, 0xee} /* TM */, - (cRGB){0xc3, 0xee, 0x8c} /* VCO */, - (cRGB){0x21, 0x38, 0xd7} /* RN */); +KaleidoscopePlugins::LEDEffects::TriColor JukeboxEffect((cRGB){0xc8, 0xe8, 0xee} /* TM */, + (cRGB){0xc3, 0xee, 0x8c} /* VCO */, + (cRGB){0x21, 0x38, 0xd7} /* RN */); -Akela::LEDEffects::TriColor JukeboxAlternateEffect((cRGB){0xc8, 0xe8, 0xee} /* TM */, - (cRGB){0x21, 0x38, 0xd7} /* RN */, - (cRGB){0xc3, 0xee, 0x8c} /* VCO */); +KaleidoscopePlugins::LEDEffects::TriColor JukeboxAlternateEffect((cRGB){0xc8, 0xe8, 0xee} /* TM */, + (cRGB){0x21, 0x38, 0xd7} /* RN */, + (cRGB){0xc3, 0xee, 0x8c} /* VCO */); diff --git a/src/Akela/Jukebox.h b/src/Kaleidoscope/Jukebox.h similarity index 74% rename from src/Akela/Jukebox.h rename to src/Kaleidoscope/Jukebox.h index 93f415e9..d1aee9a9 100644 --- a/src/Akela/Jukebox.h +++ b/src/Kaleidoscope/Jukebox.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,8 +18,7 @@ #pragma once -#include -#include +#include -extern Akela::LEDEffects::TriColor JukeboxEffect; -extern Akela::LEDEffects::TriColor JukeboxAlternateEffect; +extern KaleidoscopePlugins::LEDEffects::TriColor JukeboxEffect; +extern KaleidoscopePlugins::LEDEffects::TriColor JukeboxAlternateEffect; diff --git a/src/Akela/Miami.cpp b/src/Kaleidoscope/Miami.cpp similarity index 69% rename from src/Akela/Miami.cpp rename to src/Kaleidoscope/Miami.cpp index e2dc82fb..8abd2719 100644 --- a/src/Akela/Miami.cpp +++ b/src/Kaleidoscope/Miami.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,7 +16,7 @@ * along with this program. If not, see . */ -#include +#include -Akela::LEDEffects::TriColor MiamiEffect((cRGB){0xd6, 0xd6, 0x4e} /* Cyan */, - (cRGB){0xaf, 0x67, 0xfa} /* Magenta */); +KaleidoscopePlugins::LEDEffects::TriColor MiamiEffect((cRGB){0xd6, 0xd6, 0x4e} /* Cyan */, + (cRGB){0xaf, 0x67, 0xfa} /* Magenta */); diff --git a/src/Akela/Miami.h b/src/Kaleidoscope/Miami.h similarity index 80% rename from src/Akela/Miami.h rename to src/Kaleidoscope/Miami.h index f42f91db..9682a87c 100644 --- a/src/Akela/Miami.h +++ b/src/Kaleidoscope/Miami.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,7 +18,6 @@ #pragma once -#include -#include +#include -extern Akela::LEDEffects::TriColor MiamiEffect; +extern KaleidoscopePlugins::LEDEffects::TriColor MiamiEffect; diff --git a/src/Akela/TriColor.cpp b/src/Kaleidoscope/TriColor.cpp similarity index 92% rename from src/Akela/TriColor.cpp rename to src/Kaleidoscope/TriColor.cpp index 39d6ffe4..ad1e1484 100644 --- a/src/Akela/TriColor.cpp +++ b/src/Kaleidoscope/TriColor.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,9 +16,9 @@ * along with this program. If not, see . */ -#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { TriColor::TriColor (cRGB baseColor, cRGB modColor, cRGB escColor) { diff --git a/src/Akela/TriColor.h b/src/Kaleidoscope/TriColor.h similarity index 86% rename from src/Akela/TriColor.h rename to src/Kaleidoscope/TriColor.h index 522d0cab..a0c1cf7e 100644 --- a/src/Akela/TriColor.h +++ b/src/Kaleidoscope/TriColor.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LEDEffects -- An assorted collection of LED effects for Kaleidoscope * Copyright (C) 2016, 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -18,10 +18,10 @@ #pragma once -#include -#include +#include +#include -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { class TriColor : public LEDMode { public: