diff --git a/README.md b/README.md index 8d77c8ea..314e5c83 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-LED-Stalker +# Kaleidoscope-LED-Stalker ![status][st:experimental] @@ -15,17 +15,18 @@ trail of ghostly white lights, or a blazing trail of fire. To use the plugin, one needs to include the header, and select the effect. ```c++ -#include +#include +#include void setup () { - Keyboardio.setup (KEYMAP_SIZE); + Kaleidoscope.setup (KEYMAP_SIZE); StalkerEffect.configure (STALKER (Haunt, {0xff, 0, 0})); - Keyboardio.use (&StalkerEffect, NULL); + Kaleidoscope.use (&StalkerEffect, NULL); } ``` -It is recommended to place the activation of the plugin (the `Keyboardio.use` +It is recommended to place the activation of the plugin (the `Kaleidoscope.use` call) as early as possible, so the plugin can catch all relevant key presses. The configuration can happen at any time, but using the `STALKER` macro is highly recommended. @@ -76,4 +77,4 @@ The plugin provides the following effects: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-LED-Stalker/blob/master/examples/LED-Stalker/LED-Stalker.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-LED-Stalker/blob/master/examples/LED-Stalker/LED-Stalker.ino diff --git a/examples/LED-Stalker/LED-Stalker.ino b/examples/LED-Stalker/LED-Stalker.ino index aa276ea0..1f835dcc 100644 --- a/examples/LED-Stalker/LED-Stalker.ino +++ b/examples/LED-Stalker/LED-Stalker.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-Stalker -- Stalk keys pressed by lighting up and fading back the LED under them * Copyright (C) 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); + Kaleidoscope.setup (KEYMAP_SIZE); StalkerEffect.configure (STALKER (BlazingTrail, NULL)); - Keyboardio.use (&LEDControl, &StalkerEffect, NULL); + Kaleidoscope.use (&LEDControl, &StalkerEffect, NULL); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index c1fc414d..8c121e5d 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-LED-Stalker +name=Kaleidoscope-LED-Stalker version=0.0.0 author=Gergely Nagy maintainer=Gergely Nagy sentence=Stalk keys pressed by lighting up and fading back the LED under them. paragraph=Stalk keys pressed by lighting up and fading back the LED under them. category=Communication -url=https://github.com/keyboardio/Akela-LED-Stalker +url=https://github.com/keyboardio/Kaleidoscope-LED-Stalker architectures=avr dot_a_linkage=true diff --git a/src/Akela-LED-Stalker.h b/src/Kaleidoscope-LED-Stalker.h similarity index 84% rename from src/Akela-LED-Stalker.h rename to src/Kaleidoscope-LED-Stalker.h index 1a48dc2e..e9c84797 100644 --- a/src/Akela-LED-Stalker.h +++ b/src/Kaleidoscope-LED-Stalker.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-Stalker -- Stalk keys pressed by lighting up and fading back the LED under them * Copyright (C) 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-Stalker.cpp b/src/Kaleidoscope/LED-Stalker.cpp similarity index 93% rename from src/Akela/LED-Stalker.cpp rename to src/Kaleidoscope/LED-Stalker.cpp index 4cc2cf92..02cf86a0 100644 --- a/src/Akela/LED-Stalker.cpp +++ b/src/Kaleidoscope/LED-Stalker.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-Stalker -- Stalk keys pressed by lighting up and fading back the LED under them * Copyright (C) 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 { uint8_t StalkerEffect::map[ROWS][COLS]; StalkerEffect::ColorComputer *StalkerEffect::colorComputer; @@ -136,4 +136,4 @@ namespace Akela { }; }; -Akela::LEDEffects::StalkerEffect StalkerEffect; +KaleidoscopePlugins::LEDEffects::StalkerEffect StalkerEffect; diff --git a/src/Akela/LED-Stalker.h b/src/Kaleidoscope/LED-Stalker.h similarity index 80% rename from src/Akela/LED-Stalker.h rename to src/Kaleidoscope/LED-Stalker.h index 16dcc06b..af108a8a 100644 --- a/src/Akela/LED-Stalker.h +++ b/src/Kaleidoscope/LED-Stalker.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-LED-Stalker -- Stalk keys pressed by lighting up and fading back the LED under them * Copyright (C) 2017 Gergely Nagy * * This program is free software: you can redistribute it and/or modify @@ -16,14 +16,14 @@ * along with this program. If not, see . */ -#include -#include +#include +#include -#define STALKER(n, ...) (({static Akela::LEDEffects::Stalker::n _effect (__VA_ARGS__); &_effect;})) +#define STALKER(n, ...) (({static KaleidoscopePlugins::LEDEffects::Stalker::n _effect (__VA_ARGS__); &_effect;})) -namespace Akela { +namespace KaleidoscopePlugins { namespace LEDEffects { - class StalkerEffect : public KeyboardioPlugin { + class StalkerEffect : public KaleidoscopePlugin { public: class ColorComputer { public: @@ -71,4 +71,4 @@ namespace Akela { }; }; -extern Akela::LEDEffects::StalkerEffect StalkerEffect; +extern KaleidoscopePlugins::LEDEffects::StalkerEffect StalkerEffect;