The Big Rename

Renamed the library to Kaleidoscope-LEDEffects, and followed up with other
renames.

Signed-off-by: Gergely Nagy <algernon@madhouse-project.org>
pull/389/head
Gergely Nagy 8 years ago
parent a8abf11b11
commit 02cb499154

@ -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 <Akela-LEDEffects.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-LEDEffects.h>
```
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

@ -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 <Akela-LEDEffects.h>
#include <Kaleidoscope-LEDEffects.h>
```
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

@ -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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-LEDEffects.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-LEDEffects.h>
#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 ();
}

@ -1,10 +1,10 @@
name=Akela-LEDEffects
name=Kaleidoscope-LEDEffects
version=0.0.0
author=Gergely Nagy
maintainer=Gergely Nagy <akela@gergo.csillger.hu>
sentence=An assorted collection of LED effects for Keyboardio boards.
maintainer=Gergely Nagy <kaleidoscope@gergo.csillger.hu>
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

@ -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 <Akela/TriColor.h>
#include <Akela/Miami.h>
#include <Akela/Jukebox.h>
#include <Kaleidoscope/TriColor.h>
#include <Kaleidoscope/Miami.h>
#include <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 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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-LEDEffects.h>
#include <Kaleidoscope-LEDEffects.h>
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 */);

@ -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 <Akela-Core.h>
#include <Akela/TriColor.h>
#include <Kaleidoscope/TriColor.h>
extern Akela::LEDEffects::TriColor JukeboxEffect;
extern Akela::LEDEffects::TriColor JukeboxAlternateEffect;
extern KaleidoscopePlugins::LEDEffects::TriColor JukeboxEffect;
extern KaleidoscopePlugins::LEDEffects::TriColor JukeboxAlternateEffect;

@ -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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-LEDEffects.h>
#include <Kaleidoscope-LEDEffects.h>
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 */);

@ -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 <Akela-Core.h>
#include <Akela/TriColor.h>
#include <Kaleidoscope/TriColor.h>
extern Akela::LEDEffects::TriColor MiamiEffect;
extern KaleidoscopePlugins::LEDEffects::TriColor MiamiEffect;

@ -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 <http://www.gnu.org/licenses/>.
*/
#include <Akela-LEDEffects.h>
#include <Kaleidoscope-LEDEffects.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace LEDEffects {
TriColor::TriColor (cRGB baseColor, cRGB modColor, cRGB escColor) {

@ -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 <Akela-Core.h>
#include <Keyboardio-LEDControl.h>
#include <Kaleidoscope.h>
#include <Kaleidoscope-LEDControl.h>
namespace Akela {
namespace KaleidoscopePlugins {
namespace LEDEffects {
class TriColor : public LEDMode {
public:
Loading…
Cancel
Save