Rename library

Author: stnkl

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Stephan Rumswinkel
+Copyright (c) 2022 Stephan Rumswinkel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,8 +1,9 @@
-# FastLEDManager
+# FastLEDHub
 
-<!--[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE)-->
+[![arduino-library-badge](https://www.ardu-badge.com/badge/FastLEDHub.svg?)](https://www.ardu-badge.com/FastLEDHub)
+[![MIT license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/stnkl/EverythingToolbar/blob/master/LICENSE)
 
-FastLEDManager allows you to manage all of your [FastLED]([FastLED](https://github.com/FastLED/FastLED)) sketches on the ESP8266 with minimal changes to your existing code. FastLEDManager is compatible with most of the demo sketches at [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos). It requires little knowledge about the ESP8266 platform making in an ideal playground for beginners getting started with FastLED animations.
+FastLEDHub allows you to manage all of your [FastLED]([FastLED](https://github.com/FastLED/FastLED)) sketches on the ESP8266 with minimal changes to your existing code. FastLEDHub is compatible with most of the demo sketches at [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos). It requires little knowledge about the ESP8266 platform making in an ideal playground for beginners getting started with FastLED animations.
 
 ## Features
 
@@ -17,7 +18,7 @@ FastLEDManager allows you to manage all of your [FastLED]([FastLED](https://gith
 
 ## Web interface
 
-![FastLEDManager web app screenshot](screenshots/screenshot.png "FastLED Manager web app")
+![FastLEDHub web app screenshot](screenshots/screenshot.png "FastLEDHub web app")
 
 ## Installation
 
@@ -34,43 +35,43 @@ FastLEDManager allows you to manage all of your [FastLED]([FastLED](https://gith
 ### Official releases via the Arduino IDE v1.8+
 1. Open the Arduino IDE
 2. Navigate to _"Sketch"_ &#8594; _"Include Library"_ &#8594; _"Manage Libraries..."_
-3. Search for `FastLEDManager` and install the desired version
+3. Search for `FastLEDHub` and install the desired version
 -->
 
 ### Manual Installation
 
 1. Make sure you have installed the dependencies above
-2. Download the desired version from the [releases](https://github.com/stnkl/FastLEDManager/releases) page
+2. Download the desired version from the [releases](https://github.com/stnkl/FastLEDHub/releases) page
 3. Extract the contents of the downloaded zip file
-4. Rename the extracted folder to `FastLEDManager`
+4. Rename the extracted folder to `FastLEDHub`
 5. Move this folder to your libraries directory `~/Arduino/libraries`)
 6. Restart your Arduino IDE
 
 ### Using Git
 
 ```bash
 cd ~/Arduino/libraries
-git clone https://github.com/stnkl/FastLEDManager.git
+git clone https://github.com/stnkl/FastLEDHub.git
 ```
 
 To update to the latest version of the library
 
 ```bash
-cd ~/Arduino/libraries/FastLEDManager && git pull
+cd ~/Arduino/libraries/FastLEDHub && git pull
 ```
 
 ## Usage
 
-Using FastLEDManager to manage your FastLED animations requires mainly three steps:
+Using FastLEDHub to manage your FastLED animations requires mainly three steps:
 
-- Creating the main sketch to initialize your lightstrip with FastLEDManager
-- Creating an animation or modifying an existing sketch to be compatible with FastLEDManager
+- Creating the main sketch to initialize your lightstrip with FastLEDHub
+- Creating an animation or modifying an existing sketch to be compatible with FastLEDHub
 - Registering your animations in the main sketch
 
 ### Creating the main sketch
 
 ```cpp
-#include <FastLEDManager.h>
+#include <FastLEDHub.h>
 #include <ESPEssentials.h>
 
 #define NUM_LEDS 6
@@ -79,17 +80,17 @@ Using FastLEDManager to manage your FastLED animations requires mainly three ste
 
 void setup()
 {
-  FastLEDManager.initialize("Project Name", NUM_LEDS);
-  FastLEDManager.addLeds<LED_TYPE, LIGHTSTRIP_PIN, GRB>(FastLEDManager.hardwareLeds, NUM_LEDS);
+  FastLEDHub.initialize("Project Name", NUM_LEDS);
+  FastLEDHub.addLeds<LED_TYPE, LIGHTSTRIP_PIN, GRB>(FastLEDHub.hardwareLeds, NUM_LEDS);
 }
 
 void loop()
 {
-  FastLEDManager.handle();
+  FastLEDHub.handle();
 }
 ```
 
-Change `NUM_LEDS`, `LED_TYPE` and `LIGHTSTRIP_PIN` according to your hardware configuration. You may notice that this is not different than setting up a regular FastLED sketch apart from using `FastLEDManager` instead of `FastLED`.
+Change `NUM_LEDS`, `LED_TYPE` and `LIGHTSTRIP_PIN` according to your hardware configuration. You may notice that this is not different than setting up a regular FastLED sketch apart from using `FastLEDHub` instead of `FastLED`.
 
 ### Adding a new animation
 
@@ -98,7 +99,7 @@ Create a new animation file `Animations/ExampleAnimation.h`:
 ```cpp
 #pragma once
 
-#include <FastLEDManager.h>
+#include <FastLEDHub.h>
 
 class ExampleAnimation : public Animation
 {
@@ -114,7 +115,7 @@ public:
 
     void loop()
     {
-      // animate FastLEDManager.leds
+      // animate FastLEDHub.leds
     }
 };
 ```
@@ -123,11 +124,11 @@ While creating your animation proceed as you usually would with FastLED by defin
 
 Keep in mind the following important differences to just using FastLED:
 - The regular `setup` function is called `reset` to emphasize its purpose
-- Instead of creating your own `leds` array use the existing `FastLEDManager.leds`
-- Within your animation use `FastLEDManager.numLeds` instead of `NUM_LEDS`
-- Every time you may want to use `FastLED` use `FastLEDManager` instead. Since `FastLEDManager` inherits from `FastLED` all member functions will be available just like before. FastLEDManager just adds some stuff on top of that.
+- Instead of creating your own `leds` array use the existing `FastLEDHub.leds`
+- Within your animation use `FastLEDHub.numLeds` instead of `NUM_LEDS`
+- Every time you may want to use `FastLED` use `FastLEDHub` instead. Since `FastLEDHub` inherits from `FastLED` all member functions will be available just like before. FastLEDHub just adds some stuff on top of that.
 
-If you want to convert an existing FastLED sketch (e.g. from [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos)), so it can be handled by FastLEDManager, those are the necessary changes you have to perform.
+If you want to convert an existing FastLED sketch (e.g. from [atuline/FastLED-Demos](https://github.com/atuline/FastLED-Demos)), so it can be handled by FastLEDHub, those are the necessary changes you have to perform.
 
 ### Registering animations
 
@@ -147,38 +148,38 @@ The animation name can be any unique string and will be used to identify animati
 
 ### Static color display
 
-FastLEDManager allows you to display a static color in the web interface. It will be handled as a separate animation and will always have animation index `0`. This is important if you want to trigger animations using HTTP requests.
+FastLEDHub allows you to display a static color in the web interface. It will be handled as a separate animation and will always have animation index `0`. This is important if you want to trigger animations using HTTP requests.
 
 ### Pre-defined and custom sliders
 
-You can add custom numeric sliders of type `int16_t` to adjust variables of animations dynamically. FastLEDManager automatically adds two sliders for brightness (0-1023, default: 1023) and animation speed (0-255, default: 127). Both of these fixed sliders have been integrated tightly into FastLEDManager and don't require any further attention. Changing the brightness will apply gamma correction automatically. Adjusting the speed will affect the effective delay of `FastLEDManager.delay()` to speed up or slow down animations. To prevent this explicitly use `FastLED.delay()` or Arduino's standard `delay()`.
+You can add custom numeric sliders of type `int16_t` to adjust variables of animations dynamically. FastLEDHub automatically adds two sliders for brightness (0-1023, default: 1023) and animation speed (0-255, default: 127). Both of these fixed sliders have been integrated tightly into FastLEDHub and don't require any further attention. Changing the brightness will apply gamma correction automatically. Adjusting the speed will affect the effective delay of `FastLEDHub.delay()` to speed up or slow down animations. To prevent this explicitly use `FastLED.delay()` or Arduino's standard `delay()`.
 
 To add more custom sliders simply register them in the main sketch via
 
 ```cpp
-FastLEDManager.registerSlider(new Slider("Saturation", 150, 255, 200, 1));
+FastLEDHub.registerSlider(new Slider("Saturation", 150, 255, 200, 1));
 ```
 
 This example registers a slider with a range of `150-255` and step size `1` defaulting to the value `200`. Again the slider name `"Saturation"` can be any unique string identifying the slider in the web interface.
 
 To access custom slider values inside of your animation use
 
 ```cpp
-int16_t saturation = FastLEDManager.getSlider("Saturation")->value;
+int16_t saturation = FastLEDHub.getSlider("Saturation")->value;
 ```
 
 ### Hardware inputs
 
-FastLEDManager supports a potentiometer for brightness adjustments and a push button to cycle through animations. They have to be specifically enabled with
+FastLEDHub supports a potentiometer for brightness adjustments and a push button to cycle through animations. They have to be specifically enabled with
 
 ```cpp
-FastLEDManager.enablePotentiometer(potentiometerPin);
+FastLEDHub.enablePotentiometer(potentiometerPin);
 ```
 
 and
 
 ```cpp
-FastLEDManager.enableToggleButton(togglePin);
+FastLEDHub.enableToggleButton(togglePin);
 ```
 
 ### Alarm and sunset

data/index.htm

@@ -2,7 +2,7 @@
 <html>
 
 <head>
-  <title>FastLED Manager</title>
+  <title>FastLEDHub</title>
   <meta charset="utf-8">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <meta name="mobile-web-app-capable" content="yes">
@@ -25,7 +25,7 @@ <h4 id="connectingOverlayText">Connecting...</h4>
   </div>
 
   <div id="wrapper">
-    <h1 style="text-align: center">FastLED Manager</h1>
+    <h1 style="text-align: center">FastLEDHub</h1>
 
     <div id="animationButtons">
       <button type="button" class="btn btn-secondary color no-alpha" id="colorButton">Color</button>

library.json

@@ -1,10 +1,10 @@
 {
-  "name": "FastLEDManager",
-  "description": "Control multiple FastLED lightstrip animations on the ESP8266 without reuploading and more...",
+  "name": "FastLEDHub",
+  "description": "Control multiple FastLED lightstrip animations on the ESP8266 without reuploading.",
   "repository":
   {
     "type": "git",
-    "url": "https://github.com/stnkl/FastLEDManager.git"
+    "url": "https://github.com/stnkl/FastLEDHub.git"
   },
   "frameworks": "arduino",
   "platforms": "espressif8266",
@@ -14,5 +14,5 @@
     "maintainer": true,
     "url": "https://github.com/stnkl"
   },
-  "version": "1.0.0"
+  "version": "0.9.0"
 }

library.properties

@@ -1,11 +1,10 @@
-name=FastLEDManager
-version=1.0.0
+name=FastLEDHub
+version=0.9.0
 author=Stephan Rumswinkel
 maintainer=Stephan Rumswinkel
-sentence=Control multiple FastLED lightstrip animations on the ESP8266 without reuploading and more...
-paragraph=Control multiple FastLED lightstrip animations on the ESP8266 without reuploading and more...
-url=https://github.com/stnkl/ESPEssentials.git
+sentence=Control multiple FastLED lightstrip animations on the ESP8266 without reuploading.
+paragraph=Control multiple FastLED lightstrip animations on the ESP8266 without reuploading.
+url=https://github.com/stnkl/FastLEDHub.git
 category=Display
 architectures=esp8266
 depends=WiFiManager,ESPEssentials,ArduinoJson,LinkedList,FastLED,WebSockets
-includes=FastLEDManager.h

src/Animations/Color.h

@@ -1,6 +1,6 @@
 #pragma once
 
-#include <FastLEDManager.h>
+#include <FastLEDHub.h>
 
 class Color : public Animation
 {
@@ -13,8 +13,8 @@ class Color : public Animation
 
   void loop()
   {
-    fill_solid(FastLEDManager.leds, FastLEDManager.numLeds, strtol((const char *)&Config.color[0], NULL, 16));
+    fill_solid(FastLEDHub.leds, FastLEDHub.numLeds, strtol((const char *)&Config.color[0], NULL, 16));
 
-    FastLEDManager.show();
+    FastLEDHub.show();
   }
 };

src/Config.cpp

@@ -8,14 +8,14 @@ bool ConfigClass::initialize()
 {
   if (!SPIFFS.begin())
   {
-    PRINTLN("[FastLEDManager] Couldn't mount file system.");
+    PRINTLN("[FastLEDHub] Couldn't mount file system.");
     return false;
   }
 
   File configFile = SPIFFS.open(configFilename, "r");
   if (!configFile)
   {
-    PRINTLN("[FastLEDManager] Opening file '" + configFilename + "' failed.");
+    PRINTLN("[FastLEDHub] Opening file '" + configFilename + "' failed.");
     return false;
   }
 
@@ -127,7 +127,7 @@ bool ConfigClass::save()
   File configFile = SPIFFS.open(configFilename, "w");
   if (!configFile)
   {
-    PRINTLN("[FastLEDManager] Opening file " + configFilename + " for saving failed.");
+    PRINTLN("[FastLEDHub] Opening file " + configFilename + " for saving failed.");
     return false;
   }
 

src/Fade.cpp

@@ -1,6 +1,6 @@
 #include "Fade.h"
 
-#include "FastLEDManager.h"
+#include "FastLEDHub.h"
 #include "SerialOut.h"
 
 #include <ArduinoJson.h>
@@ -48,16 +48,16 @@ void handle()
   else if (Config.sunsetEnabled && now->tm_hour == Config.sunsetHour && now->tm_min == Config.sunsetMinute)
   {
     // Only start sunset if all leds are off
-    if (FastLEDManager.brightness10 == 0)
+    if (FastLEDHub.brightness10 == 0)
     {
       Fade::begin(Fade::FadeMode::SUNSET);
     }
     else // brightness10 > 0
     {
       bool ledsIlluminated = false;
-      for (uint16_t i = 0; i < FastLEDManager.numLeds; i++)
+      for (uint16_t i = 0; i < FastLEDHub.numLeds; i++)
       {
-        if (FastLEDManager.hardwareLeds[i] != CRGB(0, 0, 0))
+        if (FastLEDHub.hardwareLeds[i] != CRGB(0, 0, 0))
         {
           ledsIlluminated = true;
           break;
@@ -74,7 +74,7 @@ void begin(FadeMode fadeMode)
 {
   // Set fade starting point
   fadeBrightness = 1;
-  FastLEDManager.show(fadeBrightness);
+  FastLEDHub.show(fadeBrightness);
 
   currentFade = fadeMode;
 
@@ -84,16 +84,16 @@ void begin(FadeMode fadeMode)
 
   if (fadeMode == Fade::FadeMode::ALARM)
   {
-    FastLEDManager.begin(FastLEDManager.getAnimation(Config.alarmAnimation));
+    FastLEDHub.begin(FastLEDHub.getAnimation(Config.alarmAnimation));
     fadeTicker.attach_ms(Config.alarmDuration * 60 * 1000 / 1024, tick);
-    PRINTLN("[FastLEDManager] Start fade 'Alarm'");
+    PRINTLN("[FastLEDHub] Start fade 'Alarm'");
   }
   else if (fadeMode == Fade::FadeMode::SUNSET)
   {
-    FastLEDManager.begin(FastLEDManager.getAnimation(Config.sunsetAnimation));
-    sunsetMaximumBrightness = FastLEDManager.brightness10;
+    FastLEDHub.begin(FastLEDHub.getAnimation(Config.sunsetAnimation));
+    sunsetMaximumBrightness = FastLEDHub.brightness10;
     fadeTicker.attach_ms(Config.sunsetDuration * 60 * 1000 / sunsetMaximumBrightness, tick);
-    PRINTLN("[FastLEDManager] Start fade 'Sunset'");
+    PRINTLN("[FastLEDHub] Start fade 'Sunset'");
   }
 }
 
@@ -105,20 +105,20 @@ void stop()
 
 void tick()
 {
-  if (FastLEDManager.status == PAUSED)
+  if (FastLEDHub.status == PAUSED)
     return;
 
   if (currentFade == Fade::FadeMode::ALARM && fadeBrightness == 1023)
   {
     if (Config.postAlarmAnimation != Config.alarmAnimation)
-      FastLEDManager.begin(FastLEDManager.getAnimation(Config.postAlarmAnimation));
+      FastLEDHub.begin(FastLEDHub.getAnimation(Config.postAlarmAnimation));
     fadeTicker.detach();
-    PRINTLN("[FastLEDManager] End fade 'Alarm'");
+    PRINTLN("[FastLEDHub] End fade 'Alarm'");
   }
   else if (currentFade == Fade::FadeMode::SUNSET && fadeBrightness == sunsetMaximumBrightness)
   {
     fadeTicker.detach();
-    PRINTLN("[FastLEDManager] End fade 'Sunset'");
+    PRINTLN("[FastLEDHub] End fade 'Sunset'");
   }
   else
   {
@@ -127,15 +127,15 @@ void tick()
     else
       fadeTicker.detach();
 
-    PRINTLN("[FastLEDManager] Fade brightness: " + String(fadeBrightness));
+    PRINTLN("[FastLEDHub] Fade brightness: " + String(fadeBrightness));
   }
 
-  FastLEDManager.brightness10 = fadeBrightness;
+  FastLEDHub.brightness10 = fadeBrightness;
 }
 
 void getSunsetTime()
 {
-  PRINT("[FastLEDManager] Getting sunset time...");
+  PRINT("[FastLEDHub] Getting sunset time...");
 
   WiFiClient client;
   HTTPClient http;

src/Fade.h

@@ -5,7 +5,7 @@
 #include <Arduino.h>
 
 
-class FastLEDManagerClass;
+class FastLEDHubClass;
 
 namespace Fade
 {