From ce45b212d70bafd98fa45386be85f280e79f349e Mon Sep 17 00:00:00 2001 From: Gergely Nagy Date: Sat, 11 Feb 2017 22:54:19 +0100 Subject: [PATCH] The Big Rename Rename the library to Kaleidoscope-Heatmap, and follow up with other renames. Signed-off-by: Gergely Nagy --- README.md | 11 ++++++----- examples/Heatmap/Heatmap.ino | 11 ++++++----- library.properties | 8 ++++---- src/{Akela-Heatmap.h => Kaleidoscope-Heatmap.h} | 4 ++-- src/{Akela => Kaleidoscope}/Heatmap.cpp | 9 +++++---- src/{Akela => Kaleidoscope}/Heatmap.h | 10 +++++----- 6 files changed, 28 insertions(+), 25 deletions(-) rename src/{Akela-Heatmap.h => Kaleidoscope-Heatmap.h} (88%) rename src/{Akela => Kaleidoscope}/Heatmap.cpp (94%) rename src/{Akela => Kaleidoscope}/Heatmap.h (86%) diff --git a/README.md b/README.md index 4ef3066c..dc0fc547 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Akela-Heatmap +# Kaleidoscope-Heatmap ![status][st:experimental] @@ -20,11 +20,12 @@ The plugin comes with reasonable defaults pre-configured, all one needs to do is include the header, and make sure the plugin is in use: ```c++ -#include +#include +#include void setup (void) { - Keyboardio.setup (KEYMAP_SIZE); - Keyboardio.use (&HeatmapEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&HeatmapEffect, NULL); } ``` @@ -58,4 +59,4 @@ The plugin provides two methods on the `HeatmapEffect` object: Starting from the [example][plugin:example] is the recommended way of getting started with the plugin. - [plugin:example]: https://github.com/keyboardio/Akela-Heatmap/blob/master/examples/Heatmap/Heatmap.ino + [plugin:example]: https://github.com/keyboardio/Kaleidoscope-Heatmap/blob/master/examples/Heatmap/Heatmap.ino diff --git a/examples/Heatmap/Heatmap.ino b/examples/Heatmap/Heatmap.ino index 4dcb83cb..8579e4ba 100644 --- a/examples/Heatmap/Heatmap.ino +++ b/examples/Heatmap/Heatmap.ino @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect 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 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, &HeatmapEffect, NULL); + Kaleidoscope.setup (KEYMAP_SIZE); + Kaleidoscope.use (&LEDControl, &HeatmapEffect, NULL); HeatmapEffect.activate (); } void loop () { - Keyboardio.loop (); + Kaleidoscope.loop (); } diff --git a/library.properties b/library.properties index 5fd6ffc7..81cf365e 100644 --- a/library.properties +++ b/library.properties @@ -1,10 +1,10 @@ -name=Akela-Heatmap +name=Kaleidoscope-Heatmap version=0.0.0 author=Gergely Nagy -maintainer=Gergely Nagy -sentence=Heatmap LED effect for Keyboardio boards. +maintainer=Gergely Nagy +sentence=Heatmap LED effect for Kaleidoscope. paragraph=Displays a heatmap via the LEDs under each key. category=Communication -url=https://github.com/keyboardio/Akela-Heatmap +url=https://github.com/keyboardio/Kaleidoscope-Heatmap architectures=avr dot_a_linkage=true diff --git a/src/Akela-Heatmap.h b/src/Kaleidoscope-Heatmap.h similarity index 88% rename from src/Akela-Heatmap.h rename to src/Kaleidoscope-Heatmap.h index 2c0d1a10..e4874414 100644 --- a/src/Akela-Heatmap.h +++ b/src/Kaleidoscope-Heatmap.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * 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/Heatmap.cpp b/src/Kaleidoscope/Heatmap.cpp similarity index 94% rename from src/Akela/Heatmap.cpp rename to src/Kaleidoscope/Heatmap.cpp index 92df231b..7a4557d1 100644 --- a/src/Akela/Heatmap.cpp +++ b/src/Kaleidoscope/Heatmap.cpp @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect for Kaleidoscope. * 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 { uint8_t Heatmap::heatmap[ROWS][COLS]; uint16_t Heatmap::totalKeys; uint8_t Heatmap::highestCount; @@ -119,4 +120,4 @@ namespace Akela { } }; -Akela::Heatmap HeatmapEffect; +KaleidoscopePlugins::Heatmap HeatmapEffect; diff --git a/src/Akela/Heatmap.h b/src/Kaleidoscope/Heatmap.h similarity index 86% rename from src/Akela/Heatmap.h rename to src/Kaleidoscope/Heatmap.h index e01294c6..1337fe7e 100644 --- a/src/Akela/Heatmap.h +++ b/src/Kaleidoscope/Heatmap.h @@ -1,5 +1,5 @@ /* -*- mode: c++ -*- - * Akela -- Animated Keyboardio Extension Library for Anything + * Kaleidoscope-Heatmap -- Heatmap LED effect 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 { class Heatmap : public LEDMode { public: Heatmap (void); @@ -48,4 +48,4 @@ namespace Akela { }; }; -extern Akela::Heatmap HeatmapEffect; +extern KaleidoscopePlugins::Heatmap HeatmapEffect;