1 feature wrapper (#12)

Author: totally-not-frito-lays

.gitignore

@@ -1,3 +1,87 @@
+# Developer files
+test-bin
+*.iml
+.idea
+.directory
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Windows ###
+# Windows thumbnail cache files
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+
+# Dump file
+*.stackdump
+
+# Folder config file
+[Dd]esktop.ini
+
+# Recycle Bin used on file shares
+$RECYCLE.BIN/
+
+# Windows Installer files
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+
+# Windows shortcuts
+*.lnk
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
 # Prerequisites
 *.d
 

Lantern.cpp

@@ -0,0 +1,58 @@
+#include "Lantern.h"
+
+Lantern::Lantern() {
+  _pin  = 8;            // default is set to #8, integrated neopixel.
+  _numPixels = 1;       // assumes single LED.
+  _brightness = 50;     // default is set to ~1/5th brightness. Max is 255.
+  _pixels  =  Adafruit_NeoPixel(_numPixels, _pin, NEO_GRB + NEO_KHZ800);
+}
+
+Lantern::Lantern(uint8_t pin, uint8_t numPixels, uint8_t brightness) {
+  _pin  = pin;
+  _numPixels = numPixels;
+  _brightness = brightness;
+  _pixels  =  Adafruit_NeoPixel(_numPixels, _pin, NEO_GRB + NEO_KHZ800);
+}
+
+void Lantern::begin() {
+  _pixels.setBrightness(_brightness);
+  _pixels.begin();
+}
+
+void Lantern::setBrightness(uint8_t brightness) {
+  _pixels.setBrightness(brightness);  
+}
+
+uint32_t Lantern::color(uint8_t red, uint8_t green, uint8_t blue) {
+  // The red, green, and blue values are bitwise ANDed with 0xFF to ensure they 
+  // fit within the range of 0-255, and then left-shifted and combined using 
+  // bitwise OR operations.
+
+  // a 32-bit color is composed of 8-bit red, green, and blue values
+  // | RED      | GREEN   | BLUE   |
+  // | 32 -> 24 | 24 -> 16 | 16 -> 8 |
+  return _pixels.Color(red, green, blue);
+}
+
+void Lantern::setColor(float seconds, uint8_t red, uint8_t green, uint8_t blue) {
+  setColor(seconds, color(red, green, blue));
+}
+
+void Lantern::setColor(float duration, uint32_t color) {
+  _pixels.setPixelColor(0, color);
+  _pixels.show();
+  wait(duration);
+}
+
+static void Lantern::wait(float seconds) {
+  static const float THREE_DAYS = 259200;
+  // Bounds check
+  if (seconds < 0) {
+    Serial.println("Can't wait negative seconds, waiting default of 0.25 seconds");
+    seconds = 0.25;
+  } else if (seconds > THREE_DAYS) {
+    Serial.println("Are you sure you want to keep this color for longer than 3 days? That's a long time!");
+  }
+
+  delay(int(seconds * 1000));
+}

Lantern.h

@@ -0,0 +1,98 @@
+/**
+ * @file Lantern.h
+ * @author Ryan ([email protected])
+ * @brief Wrapper library for Adafruit_NeoPixel
+ * @version 0.1
+ * @date 2024-02-19
+ * 
+ * @copyright Copyright (c) 2024
+ * 
+ */
+#ifndef Lantern_h
+#define Lantern_h
+
+#include "Arduino.h"
+#include "Adafruit_NeoPixel.h"
+
+class Lantern {
+  public:
+    
+    /**
+     * @brief Constructs a new Lantern object with safe default values. Uses 
+     * integrated neopixel.
+     * 
+     */
+    Lantern();
+
+    /**
+     * @brief Construct a new Lantern object with specified brightness.
+     * 
+     * @param pin output pin on the adafruit flora.
+     * @param numLed number of LED lights.
+     * @param brightness takes input from 0-255 and controls brightness from 
+     * darkest `0` to brightest `255`.
+     */
+    Lantern(uint8_t pin, uint8_t numLed, uint8_t brightness);
+
+    /**
+     * @brief Starts or restarts LED at current brightness.
+     * 
+     * To change brightness, use `setBrightness(int brightness)`.
+     */
+    void begin();
+
+    /**
+     * @brief Sets the brightness of the LED.
+     * 
+     * @param brightness takes input from 0-255 and controls brightness from 
+     * darkest `0` to brightest `255`.
+     */
+    void setBrightness(uint8_t brightness);
+
+    /**
+     * @brief Packs red, green, blue values into `uint32` to play nicely with 
+     * Adafruit color functions.
+     * 
+     * @param red 
+     * @param green 
+     * @param blue 
+     * @return uint32_t 
+     */
+    uint32_t color(uint8_t red, uint8_t green, uint8_t blue);
+
+    /**
+     * @brief Set the color using just seconds, red, green, and blue
+     * 
+     * @param seconds duration to be set
+     * @param red how red your color will be
+     * @param green how green your color will be
+     * @param blue how blue your color will be
+     */
+    void setColor(float seconds, uint8_t red, uint8_t green, uint8_t blue);
+
+    /**
+     * @brief Set the color using Adafruit's `Color()` function.
+     * 
+     * @param seconds how long the light will stay that color
+     * @param color packed RGB color value for the light
+     */
+    void setColor(float seconds, uint32_t color);
+
+    /**
+     * @brief Wait for the amount of seconds before continuing. Used to hold 
+     * the current color value for some time.
+     * 
+     * It just calls delay in units of seconds instead of microseconds.
+     * 
+     * @param seconds 
+     */
+    static void wait(float seconds);
+
+  private:
+    int _pin;
+    int _numPixels;
+    int _brightness;
+    Adafruit_NeoPixel _pixels;
+};
+
+#endif

examples/act1-lights/act1-lights.ino

@@ -0,0 +1,41 @@
+/**
+ * Activity 1: Get those lights on!
+ * 
+ */
+#include <Lantern.h>
+
+Lantern lantern;
+
+/**
+ * @brief This function only runs once to "setup" the Lantern.
+ * 
+ */
+void setup() {
+  lantern.begin();
+}
+
+/**
+ * @brief This function repeats itself, like a loop!
+ * 
+ */
+void loop() {
+  checkLight();
+}
+
+/**
+ * @brief Sets color values for our lantern. Used to check if our Lantern is 
+ * ready to accept instructions.
+ * 
+ * Not getting the color you want? Check out this website to learn how to pick
+ * your color using just Red, Green, and Blue!
+ * - [RGB Color Picker](https://www.w3schools.com/colors/colors_rgb.asp)
+ */
+void checkLight() {
+  // Set color values here! Colors range from 0 to 255
+  int red = 0;
+  int green = 150;
+  int blue = 0;
+  float seconds = 0.5;
+
+  lantern.setColor(seconds, lantern.color(red, green, blue));
+}

examples/act2-traffic/act2-traffic.ino

@@ -0,0 +1,41 @@
+/**
+ * Activity 2: Why repeat when you can loop?
+ */
+
+#include <Lantern.h>
+
+Lantern lantern;
+
+void setup() {
+  lantern.begin();
+}
+
+void loop() {
+  redlight(1);
+  yellowlight(1);
+  greenlight(1);
+}
+
+void redlight(int seconds) {
+  int Red = 150;
+  int Green = 0;
+  int Blue = 0;
+  
+  lantern.setColor(seconds, lantern.color(Red, Green, Blue));
+}
+
+void yellowlight(int seconds) {
+  int Red = 150;
+  int Green = 150;
+  int Blue = 0;
+  
+  lantern.setColor(seconds, lantern.color(Red, Green, Blue));
+}
+
+void greenlight(int seconds) {
+  int Red = 0;
+  int Green = 150;
+  int Blue = 0;
+  
+  lantern.setColor(seconds, lantern.color(Red, Green, Blue));
+}