Refactor lib includes for Arduino Cloud

Author: nothans

README.md

@@ -21,7 +21,7 @@ Include the library in your sketch and initialize it with your WiFi credentials.
 ## Methods
 
 - `begin(const char* ssid, const char* password)`: Initialize the library with your WiFi credentials.
-- `getCurrentColor()`: Get the current CheerLights color from ThingSpeak.
-- `showColorName()`: Show the current CheerLights color name (e.g. "red").
-- `showColorHex()`: Show the current CheerLights color as a hex value (e.g. 0xFF0000).
-- `showRed()`, `showGreen()`, `showBlue()`: Show the RGB values for the current CheerLights color (e.g. 255, 0, 0).
+- `getCurrentColor()`: Get the current CheerLights color from ThingSpeak channel 1417.
+- `currentColorName()`: The current CheerLights color name (e.g. "red").
+- `currentColorHex()`: The current CheerLights color as a hex value (e.g. 0xFF0000).
+- `currentRed()`, `currentGreen()`, `currentBlue()`: The RGB values for the current CheerLights color (e.g. 255, 0, 0).

examples/CheerLightsExample/CheerLightsExample.ino

@@ -1,65 +1,78 @@
 /*
-'CheerLightsExample' demonstrates how to use the CheerLights library to fetch and display the current CheerLights color on an Adafruit NeoPixel LED strip.
+'CheerLightsExample' demonstrates how to use the CheerLights Arduino library to fetch and display the current CheerLights color on an Adafruit NeoPixel LED strip.
 
 To learn more about CheerLights, visit https://cheerlights.com.
 */
 
-#include <CheerLights.h>
-#include "secrets.h"
-#include <Adafruit_NeoPixel.h> // For controlling NeoPixels
+// Include the Adafruit NeoPixel library and initialize the strip
+#include <Adafruit_NeoPixel.h>
 
 #define LED_PIN    6
 #define NUM_LEDS   8
 
-CheerLights CheerLights;
 Adafruit_NeoPixel strip(NUM_LEDS, LED_PIN, NEO_GRB + NEO_KHZ800);
 
+// Include the correct WiFi library based on the board
+#if defined(ESP8266)
+  #include <ESP8266WiFi.h>
+#elif defined(ESP32)
+  #include <WiFi.h>
+#elif defined(ARDUINO_SAMD_MKR1000)
+  // For Arduino MKR1000 using WiFi101 library
+  #include <WiFi101.h>
+#elif defined(ARDUINO_SAMD_MKRWIFI1010)
+  // For Arduino MKR WiFi 1010 using WiFiNINA library
+  #include <WiFiNINA.h>
+#elif defined(ARDUINO_AVR_UNO_WIFI_REV2)
+  // For Arduino Uno WiFi Rev2
+  #include <WiFiNINA.h>
+#elif defined(ARDUINO_ARCH_SAMD)
+  // For other SAMD boards
+  #include <WiFiNINA.h>
+#else
+  #include <WiFi.h>
+#endif
+
+// Include the CheerLights library and instantiate the CheerLights object
+#include <CheerLights.h>
+CheerLights CheerLights;
+
+// Include the secrets file that contains the WiFi credentials
+#include "secrets.h"
+
 unsigned long previousMillis = 0;
-const long interval = 15000; // 15 seconds
+const long updateInterval = 15000;
 
 void setup() {
     Serial.begin(115200);
     CheerLights.begin(SECRET_SSID, SECRET_PASSWORD);
     strip.begin();
-    strip.show(); // Initialize all pixels to 'off'
+
+    // Get the current CheerLights color and set the LEDs to that color
+    CheerLights.getCurrentColor();
+    Serial.print("Current CheerLights Color: ");
+    Serial.println(CheerLights.currentColorName());
+    setLEDColors(CheerLights.currentRed(), CheerLights.currentGreen(), CheerLights.currentBlue());
 }
 
 void loop() {
     unsigned long currentMillis = millis();
 
-    if (currentMillis - previousMillis >= interval) {
+    // Update the LEDs every updateInterval milliseconds
+    if (currentMillis - previousMillis >= updateInterval) {
         previousMillis = currentMillis;
 
-        // Get the current CheerLights color
+        // Get the current CheerLights color and set the LEDs to that color
+        CheerLights.getCurrentColor();
         Serial.print("Current CheerLights Color: ");
-        Serial.println(CheerLights.getCurrentColor());
-
-        // Show the color as a hex value
-        Serial.print("Color Hex: 0x");
-        Serial.println(CheerLights.showColorHex(), HEX);
-
-        // Show the RGB values
-        uint8_t red = CheerLights.showRed();
-        uint8_t green = CheerLights.showGreen();
-        uint8_t blue = CheerLights.showBlue();
-
-        Serial.print("Red: ");
-        Serial.print(red);
-        Serial.print(" Green: ");
-        Serial.print(green);
-        Serial.print(" Blue: ");
-        Serial.println(blue);
-
-        // Show the color name
-        Serial.print("CheerLights Color Name: ");
-        Serial.println(CheerLights.showColorName());
-
-        // Set all pixels to the CheerLights color using the RGB values
-        for (int i = 0; i < NUM_LEDS; i++) {
-            strip.setPixelColor(i, strip.Color(red, green, blue));
-        }
-        strip.show();
+        Serial.println(CheerLights.currentColorName());
+        setLEDColors(CheerLights.currentRed(), CheerLights.currentGreen(), CheerLights.currentBlue());
     }
-
-    // Other non-blocking code can go here
 }
+
+void setLEDColors(uint8_t red, uint8_t green, uint8_t blue) {    
+    for (int i = 0; i < NUM_LEDS; i++) {
+        strip.setPixelColor(i, strip.Color(red, green, blue));
+    }
+    strip.show();
+}

keywords.txt

@@ -1,8 +1,8 @@
-CheerLights	    KEYWORD1
-getCurrentColor	KEYWORD2
-showColorName	KEYWORD2
-showColorHex	KEYWORD2
-showRed	        KEYWORD2
-showGreen	    KEYWORD2
-showBlue	    KEYWORD2
-begin	        KEYWORD2
+CheerLights		    KEYWORD1
+getCurrentColor		KEYWORD2
+currentColorName	KEYWORD2
+currentColorHex		KEYWORD2
+currentRed		    KEYWORD2
+currentGreen		KEYWORD2
+currentBlue		    KEYWORD2
+begin		        KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=CheerLights
-version=1.0.1
+version=1.0.2
 author=Hans Scharler <hscharler@gmail.com>
 maintainer=Hans Scharler <hscharler@gmail.com>
 sentence=Fetch and use the latest CheerLights color.

src/CheerLights.cpp

@@ -1,6 +1,7 @@
 #include "CheerLights.h"
 
 #define MIN_UPDATE_INTERVAL 5000
+#define TIMEOUT             5000
 
 CheerLights::CheerLights() {
   _colorName = "black";
@@ -83,7 +84,7 @@ void CheerLights::_fetchColor() {
   // Wait for response
   unsigned long timeout = millis();
   while (client.connected() && !client.available()) {
-    if (millis() - timeout > 5000) { // 5 seconds timeout
+    if (millis() - timeout > TIMEOUT) {
       Serial.println(F(">>> Client Timeout!"));
       client.stop();
       return;
@@ -97,7 +98,6 @@ void CheerLights::_fetchColor() {
     line.trim();
 
     if (!headersEnd) {
-      // Check for end of headers
       if (line.length() == 0) {
         headersEnd = true;
       }
@@ -155,22 +155,22 @@ String CheerLights::getCurrentColor() {
   return _colorName;
 }
 
-String CheerLights::showColorName() {
+String CheerLights::currentColorName() {
   return _colorName;
 }
 
-uint32_t CheerLights::showColorHex() {
+uint32_t CheerLights::currentColorHex() {
   return _colorHex;
 }
 
-uint8_t CheerLights::showRed() {
+uint8_t CheerLights::currentRed() {
   return (_colorHex >> 16) & 0xFF;
 }
 
-uint8_t CheerLights::showGreen() {
+uint8_t CheerLights::currentGreen() {
   return (_colorHex >> 8) & 0xFF;
 }
 
-uint8_t CheerLights::showBlue() {
+uint8_t CheerLights::currentBlue() {
   return _colorHex & 0xFF;
 }

src/CheerLights.h

@@ -4,38 +4,16 @@
 #include <Arduino.h>
 #include <WiFiClient.h>
 
-// Include the correct WiFi library based on the board
-#if defined(ESP8266)
-  #include <ESP8266WiFi.h>
-#elif defined(ESP32)
-  #include <WiFi.h>
-#elif defined(ARDUINO_SAMD_MKR1000)
-  // For Arduino MKR1000 using WiFi101 library
-  #include <WiFi101.h>
-#elif defined(ARDUINO_SAMD_MKRWIFI1010)
-  // For Arduino MKR WiFi 1010 using WiFiNINA library
-  #include <WiFiNINA.h>
-#elif defined(ARDUINO_AVR_UNO_WIFI_REV2)
-  // For Arduino Uno WiFi Rev2
-  #include <WiFiNINA.h>
-#elif defined(ARDUINO_ARCH_SAMD)
-  // For other SAMD boards
-  #include <WiFiNINA.h>
-#else
-  // Default to WiFi.h
-  #include <WiFi.h>
-#endif
-
 class CheerLights {
   public:
     CheerLights();
     void begin(const char* ssid, const char* password);
     String getCurrentColor();
-    String showColorName();
-    uint32_t showColorHex();
-    uint8_t showRed();
-    uint8_t showGreen();
-    uint8_t showBlue();
+    String currentColorName();
+    uint32_t currentColorHex();
+    uint8_t currentRed();
+    uint8_t currentGreen();
+    uint8_t currentBlue();
 
   private:
     void _connectToWiFi();