Initial Commit

Author: nothans

README.md

@@ -1 +1,76 @@
-# cheerlights-arduino-library
+# CheerLights Arduino Library
+
+An Arduino library to synchronize with the global CheerLights color by fetching the latest color from the CheerLights API.
+
+## Features
+
+- Fetch the latest CheerLights color name.
+- Retrieve RGB values for the current color.
+- Easy integration with LED strips like NeoPixels.
+
+## IDE Installation
+
+1. Open the Arduino IDE.
+2. Select Tools > Manage Libraries.
+3. Search for "CheerLights" and install.
+
+## Usage
+
+Include the library in your sketch and initialize it with your WiFi credentials. Use the provided methods to fetch and use the current CheerLights color.
+
+## Methods
+
+- `begin(const char* ssid, const char* password)`: Initialize the library with your WiFi credentials.
+- `getColorName()`: Get the current CheerLights color name.
+- `getColorHex()`: Get the current CheerLights color as a hex value.
+- `getRed()`, `getGreen()`, `getBlue()`: Get the RGB values for the current CheerLights color.
+
+## Example
+
+```cpp
+#include <CheerLights.h>
+#include <WiFiClientSecure.h>
+#include <Adafruit_NeoPixel.h> // For controlling NeoPixels
+
+#define LED_PIN    6
+#define NUM_LEDS   8
+
+// Replace with your network credentials
+const char* ssid = "your_SSID";
+const char* password = "your_PASSWORD";
+
+CheerLights cheerLights;
+Adafruit_NeoPixel strip(NUM_LEDS, LED_PIN, NEO_GRB + NEO_KHZ800);
+
+void setup() {
+    Serial.begin(115200);
+    cheerLights.begin(ssid, password);
+    strip.begin();
+    strip.show(); // Initialize all pixels to 'off'
+}
+
+void loop() {
+    // Fetch and update the color
+    cheerLights.getColorHex();
+
+    // Now get the RGB values
+    uint8_t red = cheerLights.getRed();
+    uint8_t green = cheerLights.getGreen();
+    uint8_t blue = cheerLights.getBlue();
+
+    Serial.print("Current CheerLights Color: ");
+    Serial.println(cheerLights.getColorName());
+
+    // Set all pixels to the CheerLights color
+    for (int i = 0; i < NUM_LEDS; i++) {
+        strip.setPixelColor(i, strip.Color(red, green, blue));
+    }
+    strip.show();
+
+    delay(15000); // Update every 15 seconds
+}
+```
+
+## License
+
+This project is licensed under the MIT License.

examples/CheerLightsExample/CheerLightsExample.ino

@@ -0,0 +1,47 @@
+/*
+'CheerLightsExample' demonstrates how to use the CheerLights 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 <WiFiClientSecure.h>
+#include <Adafruit_NeoPixel.h> // For controlling NeoPixels
+
+#define LED_PIN    6
+#define NUM_LEDS   8
+
+// Replace with your network credentials
+const char* ssid = "your_SSID";
+const char* password = "your_PASSWORD";
+
+CheerLights cheerLights;
+Adafruit_NeoPixel strip(NUM_LEDS, LED_PIN, NEO_GRB + NEO_KHZ800);
+
+void setup() {
+    Serial.begin(115200);
+    cheerLights.begin(ssid, password);
+    strip.begin();
+    strip.show(); // Initialize all pixels to 'off'
+}
+
+void loop() {
+    // Fetch and update the color
+    cheerLights.getColorHex();
+
+    // Now get the RGB values
+    uint8_t red = cheerLights.getRed();
+    uint8_t green = cheerLights.getGreen();
+    uint8_t blue = cheerLights.getBlue();
+
+    Serial.print("Current CheerLights Color: ");
+    Serial.println(cheerLights.getColorName());
+
+    // Set all pixels to the CheerLights color
+    for (int i = 0; i < NUM_LEDS; i++) {
+        strip.setPixelColor(i, strip.Color(red, green, blue));
+    }
+    strip.show();
+
+    delay(15000); // Update every 15 seconds
+}

keywords.txt

@@ -0,0 +1,4 @@
+CheerLights	    KEYWORD1
+getColorName	KEYWORD2
+getColorHex	    KEYWORD2
+begin	        KEYWORD2

library.properties

@@ -0,0 +1,9 @@
+name=CheerLights
+version=1.0.0
+author=Hans Scharler <hscharler@gmail.com>
+maintainer=Hans Scharler <hscharler@gmail.com>
+sentence=Fetch and use the latest CheerLights color.
+paragraph=An Arduino library to synchronize with the global CheerLights color by fetching the latest color from the CheerLights API.
+category=Communication
+url=https://github.com/cheerlights/cheerlights-arduino-library
+architectures=*

src/CheerLights.cpp

@@ -0,0 +1,118 @@
+#include "CheerLights.h"
+
+#define MIN_UPDATE_INTERVAL 5000
+
+CheerLights::CheerLights() {
+  _colorName = "black";
+  _colorHex = 0x000000;
+}
+
+void CheerLights::begin(const char* ssid, const char* password) {
+  Serial.begin(115200);
+
+  // Connect to WiFi
+  Serial.print("Connecting to WiFi");
+  
+  #if defined(ESP8266) || defined(ESP32)
+    WiFi.begin(ssid, password);
+    while (WiFi.status() != WL_CONNECTED) {
+      delay(500);
+      Serial.print(".");
+    }
+  #elif defined(ARDUINO_SAMD_MKR1000) || defined(ARDUINO_SAMD_MKRWIFI1010) || defined(ARDUINO_AVR_UNO_WIFI_REV2) || defined(ARDUINO_ARCH_SAMD)
+    while (WiFi.begin(ssid, password) != WL_CONNECTED) {
+      delay(5000);
+      Serial.print(".");
+    }
+  #else
+    // Default WiFi connection method
+    WiFi.begin(ssid, password);
+    while (WiFi.status() != WL_CONNECTED) {
+      delay(500);
+      Serial.print(".");
+    }
+  #endif
+
+  Serial.println("\nConnected to WiFi");
+}
+
+void CheerLights::_fetchColor() {
+  static unsigned long lastUpdate = 0;
+  unsigned long currentTime = millis();
+
+  if (currentTime - lastUpdate < MIN_UPDATE_INTERVAL) {
+    return;
+  }
+  lastUpdate = currentTime;
+
+  if (WiFi.status() != WL_CONNECTED) {
+    Serial.println(F("WiFi not connected"));
+    return;
+  }
+
+  HTTPClient http;
+  http.begin(F("http://api.thingspeak.com/channels/1417/field/1/last.txt"));
+  int httpCode = http.GET();
+  
+  if (httpCode != HTTP_CODE_OK) {
+    Serial.println(F("Failed to fetch color"));
+    http.end();
+    return;
+  }
+
+  _colorName = http.getString();
+  http.end();
+
+  _colorName.trim();
+  _colorName.toLowerCase();
+
+  // Use progmem for color mapping
+  static const struct {
+    const char* name;
+    uint32_t color;
+  } colorMap[] PROGMEM = {
+    {"red", 0xFF0000},
+    {"green", 0x00FF00},
+    {"blue", 0x0000FF},
+    {"cyan", 0x00FFFF},
+    {"white", 0xFFFFFF},
+    {"warmwhite", 0xFDF5E6},
+    {"oldlace", 0xFDF5E6},
+    {"magenta", 0xFF00FF},
+    {"yellow", 0xFFFF00},
+    {"orange", 0xFFA500},
+    {"purple", 0x800080},
+    {"pink", 0xFFC0CB},
+    {"black", 0x000000}
+  };
+
+  _colorHex = 0x000000; // Default to black
+  for (const auto& color : colorMap) {
+    if (_colorName == FPSTR(color.name)) {
+      _colorHex = pgm_read_dword(&color.color);
+      break;
+    }
+  }
+}
+
+String CheerLights::getColorName() {
+  _fetchColor();
+  return _colorName;
+}
+
+uint32_t CheerLights::getColorHex() {
+  _fetchColor();
+  return _colorHex;
+}
+
+uint8_t CheerLights::getRed() {
+  return (_colorHex >> 16) & 0xFF;
+}
+
+uint8_t CheerLights::getGreen() {
+  return (_colorHex >> 8) & 0xFF;
+}
+
+uint8_t CheerLights::getBlue() {
+  return _colorHex & 0xFF;
+}

src/CheerLights.h

@@ -0,0 +1,55 @@
+#ifndef CHEERLIGHTS_H
+#define CHEERLIGHTS_H
+
+#include <Arduino.h>
+
+// Include the correct WiFi library based on the board
+#if defined(ESP8266)
+  #include <ESP8266WiFi.h>
+  #include <ESP8266HTTPClient.h>
+#elif defined(ESP32)
+  #include <WiFi.h>
+  #include <HTTPClient.h>
+#elif defined(ARDUINO_SAMD_MKR1000)
+  // For Arduino MKR1000 using WiFi101 library
+  #include <WiFi101.h>
+  #include <WiFiClient.h>
+  #include <HTTPClient.h>
+#elif defined(ARDUINO_SAMD_MKRWIFI1010)
+  // For Arduino MKR WiFi 1010 using WiFiNINA library
+  #include <WiFiNINA.h>
+  #include <WiFiClient.h>
+  #include <HTTPClient.h>
+#elif defined(ARDUINO_AVR_UNO_WIFI_REV2)
+  // For Arduino Uno WiFi Rev2
+  #include <WiFiNINA.h>
+  #include <WiFiClient.h>
+  #include <HTTPClient.h>
+#elif defined(ARDUINO_ARCH_SAMD)
+  // For other SAMD boards
+  #include <WiFiNINA.h>
+  #include <WiFiClient.h>
+  #include <HTTPClient.h>
+#else
+  // Default to WiFi.h and HTTPClient.h
+  #include <WiFi.h>
+  #include <HTTPClient.h>
+#endif
+
+class CheerLights {
+  public:
+    CheerLights();
+    void begin(const char* ssid, const char* password);
+    String getColorName();
+    uint32_t getColorHex();
+    uint8_t getRed();
+    uint8_t getGreen();
+    uint8_t getBlue();
+
+  private:
+    String _colorName;
+    uint32_t _colorHex;
+    void _fetchColor();
+};
+
+#endif // CHEERLIGHTS_H