Bringing Arduino Lib up to SF specs

Added boundary checks for parameters to functions
Tested out examples
Bumped version number on library.properties

Author: makin-stuff

examples/Example04_SetBrightness/Example04_SetBrightness.ino

@@ -36,9 +36,13 @@ void setup() {
   }
 
   Serial.println("Qwiic LED Stick ready!");
+
+  //Start by resetting the state of the LEDs
+  LEDStick.LEDOff();
 
   //Color the LEDStick according to the 3 arrays
   LEDStick.setLEDColor(redArray, greenArray, blueArray, 10);
+  delay(10);
 }
 
 void loop() {

examples/Example05_BinaryCounter/Example05_BinaryCounter.ino

@@ -29,6 +29,9 @@ void setup() {
   }
 
   Serial.println("Qwiic LED Stick ready!");
+
+  //Start by resetting the state of the LEDs
+  LEDStick.LEDOff();
 }
 
 void loop() {

examples/Example06_ColorGradient/Example06_ColorGradient.ino

@@ -28,6 +28,9 @@ void setup() {
   }
 
   Serial.println("Qwiic LED Stick ready!");
+
+  //Start by resetting the state of the LEDs
+  LEDStick.LEDOff();
 
   //Set colors for the gradient
   //These are for the first color
@@ -62,6 +65,6 @@ void colorGradient(byte r1, byte g1, byte b1, byte r2, byte g2, byte b2, byte LE
     byte bValue = b1 + bSlope * i;
     //Set the (i+1)th pixel to the calculated color
     //the first LED corresponds to the 0th point on the line
-    LEDStick.setLEDColor(i + 1, rValue, gValue, bValue);
+    LEDStick.setLEDColor(i, rValue, gValue, bValue);
   }
 }

examples/Example09_ChangeLength/Example09_ChangeLength.ino

@@ -33,6 +33,8 @@ void setup() {
 
   //First, turn all LEDs off
   LEDStick.LEDOff();
+  delay(500); //Wait for settings to be updated
+  
   //Change LED length to 5
   //This will allow you to write to a maximum of 5 LEDs
   LEDStick.changeLength(5);

library.properties

@@ -1,5 +1,5 @@
 name=SparkFun Qwiic LED Stick Library
-version=1.0.3
+version=1.0.4
 author=SparkFun Electronics
 maintainer=SparkFun Electronics
 sentence=Library for the SparkFun Qwiic LED Stick

src/Qwiic_LED_Stick.cpp

@@ -45,6 +45,20 @@ boolean LED::isConnected() {
 //each color must be a value between 0-255
 //LEDS indexed starting at 1
 boolean LED::setLEDColor(uint8_t number, uint8_t red, uint8_t green, uint8_t blue) {
+  // First, boundary check
+  if (red > 255)
+    red = 255;
+  if (red < 0)
+    red = 0;
+  if (green > 255)
+    green = 255;
+  if (green < 0)
+    green = 0;
+  if (blue > 255)
+    blue = 255;
+  if (blue < 0)
+    blue = 0;
+  
   _i2cPort->beginTransmission(_LEDAddress); //communicate using address
   _i2cPort->write(COMMAND_WRITE_SINGLE_LED_COLOR); //command to change single LED's color
   _i2cPort->write(number); //choose which LED
@@ -61,6 +75,20 @@ boolean LED::setLEDColor(uint8_t number, uint8_t red, uint8_t green, uint8_t blu
 //Change the color of all LEDs
 //each color must be a value between 0-255
 boolean LED::setLEDColor(uint8_t red, uint8_t green, uint8_t blue) {
+  // First, boundary check
+  if (red > 255)
+    red = 255;
+  if (red < 0)
+    red = 0;
+  if (green > 255)
+    green = 255;
+  if (green < 0)
+    green = 0;
+  if (blue > 255)
+    blue = 255;
+  if (blue < 0)
+    blue = 0;
+
   _i2cPort->beginTransmission(_LEDAddress); //communicate using address
   _i2cPort->write(COMMAND_WRITE_ALL_LED_COLOR); //command to change all LEDs' colors
   _i2cPort->write(red); //update red value
@@ -77,6 +105,22 @@ boolean LED::setLEDColor(uint8_t red, uint8_t green, uint8_t blue) {
 //Pass in 3 arrays of color values
 //each color must be a value between 0-255
 boolean LED::setLEDColor(uint8_t redArray[], uint8_t greenArray[], uint8_t blueArray[], uint8_t length) {
+  // First, boundary check
+  for (int i = 0; i < length; i++){
+    if (redArray[i] > 255)
+      redArray[i] = 255;
+    if (redArray[i] < 0)
+      redArray[i] = 0;
+    if (greenArray[i] > 255)
+      greenArray[i] = 255;
+    if (greenArray[i] < 0)
+      greenArray[i] = 0;
+    if (blueArray[i] > 255)
+      blueArray[i] = 255;
+    if (blueArray[i] < 0)
+      blueArray[i] = 0;
+  }
+
    //ATtiny has a 16 uint8_t limit on a single I2C transmission,
    //so multiple calls to commands are required
   uint8_t n;
@@ -158,6 +202,12 @@ boolean LED::setLEDColor(uint8_t redArray[], uint8_t greenArray[], uint8_t blueA
 //To turn LEDs off but remember their previous color, set brightness to 0
 //LEDS indexed starting at 1
 boolean LED::setLEDBrightness(uint8_t number, uint8_t brightness) {
+  // First, boundary check
+  if (brightness > 31)
+    brightness = 31;
+  if (brightness < 0)
+    brightness = 0;
+
   _i2cPort->beginTransmission(_LEDAddress); //Communicate using the address
   _i2cPort->write(COMMAND_WRITE_SINGLE_LED_BRIGHTNESS); //Command to write single brightness
   _i2cPort->write(number); //Choose which LED
@@ -174,6 +224,12 @@ boolean LED::setLEDBrightness(uint8_t number, uint8_t brightness) {
 //brightness must be a value between 0-31
 //To turn all LEDs off but remember their previous color, set brightness to 0
 boolean LED::setLEDBrightness(uint8_t brightness) {
+  // First, boundary check
+  if (brightness > 31)
+    brightness = 31;
+  if (brightness < 0)
+    brightness = 0;
+
   _i2cPort->beginTransmission(_LEDAddress); //Communicate using the address
   _i2cPort->write(COMMAND_WRITE_ALL_LED_BRIGHTNESS); //Commaand to change all brightness
   _i2cPort->write(brightness); //Update brightness