Initial commit

Author: marqdevx

README.md

@@ -0,0 +1,20 @@
+# Arduino_APA102
+Drive rgb LEDs **APA102**, Serial LEDs connected with 2 pins.
+
+# License
+
+  Copyright (c) 2020 Arduino SA. All rights reserved.
+
+  This library is free software; you can redistribute it and/or
+  modify it under the terms of the GNU Lesser General Public
+  License as published by the Free Software Foundation; either
+  version 2.1 of the License, or (at your option) any later version.
+    
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA

docs/api.md

@@ -0,0 +1,214 @@
+# APA102 library
+
+## Methods
+
+### `Arduino_APA102(numLEDs, newDataPin , newClockPin)`
+
+Attach the LEDs to the pins, and save the number of total LEDs.
+
+#### Syntax
+
+```
+Arduino_APA102 leds(totalLEDs, dataPin, clockPin);
+```
+
+#### Parameters
+
+* numLEDs : Amount of the LEDs to control
+* dataPin : Pin connected to SDI (DATA)
+* clockPin : Pîn connected to CKI (CLOCK)
+
+
+#### Example
+
+```
+#include <Arduino_APA102.h> 
+
+Arduino_APA102 leds(5, 5, 4);
+
+void setup() {} 
+void loop() {} 
+```
+
+#### See also
+
+* [begin()](#attached)
+* [setPixelColor()](#setPixelColor)
+* [show()](#show)
+
+### `begin()`
+
+Initialize the pins to control the devices attached.
+
+#### Syntax
+
+```
+leds.begin()
+```
+
+#### Example
+
+```
+#include <Arduino_APA102.h> 
+
+Arduino_APA102 leds(5, 5, 4);
+
+void setup() {
+  leds.begin();
+} 
+void loop() {} 
+```
+#### See also
+
+* [setPixelColor()](#setPixelColor)
+* [show()](#show)
+* [end()](#end)
+
+### `end()`
+
+Disable the lines
+
+#### Syntax
+
+```
+leds.end()
+```
+
+#### See also
+
+* [begin()](#setPixelColor)
+
+
+### `setPixelColor()`
+
+Saves the color value 
+
+#### Syntax
+
+````
+leds.setPixelColor(indexLed, newColor)
+````
+
+#### Parameters
+
+* indexLed: LED index number
+* newColor: the value of the R G and B togetger i.e 0xFFFFFF(white) or 255,255,255 (int)
+
+#### Example
+
+```
+#include <Arduino_APA102.h> 
+
+Arduino_APA102 leds(5, 5, 4);
+
+void setup() {
+  leds.begin();
+} 
+void loop() {
+  leds.setPixelColor(0, 0xFF00FF);
+  leds.setPixelColor(1, 255, 0, 255);
+  leds.setPixelColor(2, 0, 0, 255);
+  leds.show();
+} 
+```
+
+#### See also
+
+* [fill()](#fill)
+* [setBrightness()](#setBrightness)
+* [show()](#show)
+
+
+### `fill()`
+
+Write the color to a consecutive chain of LEDs, i.e from 4th count 5 then LEDs 4 to 9 will be saved with the same color.
+
+#### Syntax
+
+````
+leds.fill(newColor, startLed, count)
+````
+
+#### Parameters
+
+* newColor: color value see[Color](#Color)
+* startLed: Index to start counting
+* count: Forwarding LEDs that are going to be set.
+
+#### See also
+
+* [setPixelColor()](#setPixelColor)
+* [setBrightness()](#show)
+* [show()](#show)
+
+### `setBrightness()`
+
+Set the brightness of the LEDs, this scales the values that have been set by [setPixelColor()](#setPixelColor) and scale them by the percentage used in the parameter.
+
+#### Syntax
+
+```
+led.setBrightness(50)
+```
+
+#### Parameters
+
+* (optional) IndexLed: Choose one LED to change its value
+* newBrightness: Percentage amount to scale the color's values of the LEDs (0% - 100%)
+
+
+#### Example
+
+```
+#include <Arduino_APA102.h> 
+
+Arduino_APA102 leds(5, 5, 4);
+
+void setup() {
+  leds.begin();
+
+  leds.setPixelColor(0, 0xFFFFFF);
+  leds.setPixelColor(1, 0xFFFFFF);
+  leds.show();
+  delay(1000);
+} 
+
+void loop() {
+  leds.setBrightness(50); //Set global brightness
+  leds.show();
+  delay(1000);
+
+  leds.setBrightness(0, 10);  //Change LED 0 's brightness
+  leds.show();
+  delay(1000);
+} 
+```
+
+#### See also
+
+* [setPixelColor()](#setPixelColor)
+* [setBrightness()](#show)
+* [show()](#show)
+
+### `setCurrent()`
+
+Control the internal PWM duty cycle of the LEDs, remember that this is not the same as brightness, with the same duty cycle you can have different brightness depending on the colors used.
+
+Value from 0(min) to 31(max)
+
+#### Syntax
+
+```
+leds.setCurrent(31)   //Global
+leds.setCurrent(0,31) //Individual
+```
+
+#### Parameters
+* (optional)indexLed: LED to set
+* newCurrent: PWM duty cycle, from 0 to 31
+
+#### See also
+
+* [setPixelColor()](#setPixelColor)
+* [setBrightness()](#show)
+* [show()](#show)

docs/readme.md

@@ -0,0 +1,18 @@
+# APA102 RBG LEDs library
+
+
+This library allows an Arduino board to control the **APA102** RGB LEDs. This RGB devices can be controlled with 2 lines and the wiring is serial.
+
+To use this library:
+
+```
+#include <Arduino_APA102.h>
+
+Arduino_APA102(totalLEDs, dataLine, ClockLine);
+```
+
+## Circuit
+
+Connect both SCK and SDA pins to a digital pin in your Arduino.
+
+## Examples

examples/Fade/Fade.ino

@@ -0,0 +1,61 @@
+#include "Arduino_APA102.h"
+
+int dataPin = 5;
+int clockPin = 4;
+int totalLEDs = 5;
+
+// Construct object, Arduino_APA102(nLEDS, data line, clock line)
+Arduino_APA102 leds(totalLEDs, dataPin, clockPin);
+
+uint32_t color = random(0, 0xFFFFFF);                    // 0x[R][G][B]
+//uint32_t color_white = leds.Color( 255 , 255 , 255);  // Save yor color
+
+void setup() {
+  // put your setup code here, to run once:
+  leds.begin();
+
+  leds.fill(color, 0, totalLEDs);
+  leds.show();
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+  int brightness = 0;
+
+  // ALL FADE
+  // FADE IN
+  for (brightness = 0; brightness < 101; brightness++ ) {
+    leds.setBrightness(brightness);
+    leds.show();
+    delay(10);
+  }
+  // FADE OUT
+  for (brightness = 100; brightness > -1; brightness-- ) {
+    leds.setBrightness(brightness);
+    leds.show();
+    delay(10);
+  }
+
+  //Change color
+  color = random(0, 0xFFFFFF);
+  leds.fill(color, 0, totalLEDs);
+
+  // INDIVIDUAL FADE
+  for (int i = 0; i < totalLEDs; i++) {
+    // FADE IN
+    for (int brightness = 0; brightness < 101; brightness++) {
+      leds.setBrightness(i , brightness);
+      leds.show();
+    }
+  }
+
+  // INDIVIDUAL FADE
+  for (int i = 0; i < totalLEDs; i++) {
+    // FADE OUT
+    for (int brightness = 100; brightness > -1; brightness--) {
+      leds.setBrightness(i , brightness);
+      leds.show();
+    }
+  }
+}

examples/Low_Power/Low_Power.ino

@@ -0,0 +1,51 @@
+#include "Arduino_APA102.h"
+
+int dataPin = 5;
+int clockPin = 4;
+int totalLEDs = 5;
+
+// Construct object, Arduino_APA102(nLEDS, data line, clock line)
+Arduino_APA102 leds(totalLEDs, dataPin, clockPin);
+
+//uint32_t color = random(0, 0xFFFFFF);                    // 0x[R][G][B]
+uint32_t color_red = leds.Color( 255 , 0 , 0);  // Save yor color
+uint32_t color_blue = leds.Color( 0 , 255 , 0);  // Save yor color
+uint32_t color_green = leds.Color( 0 , 0 , 255);  // Save yor color
+
+
+int r = 0;
+int g = 100;
+int b = 250;
+
+void setup() {
+  // put your setup code here, to run once:
+  leds.begin();
+
+  leds.setPixelColor(0 , color_red);
+  leds.setPixelColor(1 , color_red);
+  leds.setPixelColor(2 , color_green);
+  leds.setPixelColor(3 , color_green);
+  leds.setPixelColor(4 , color_blue);
+  leds.show();
+
+  delay(2500);  
+  // Brigtness doesnt change the Max Current, you controll the PWM duty cycle of the APA102
+  // With the same Max current set in 2 LEDs, you can see different phyisical brightness
+  // depending on the use of each or combination of the internal rgb LEDs wich each APA102 component has
+  // You can see the effect:
+  //
+  // Current can be set from 0-31
+  // Brightness from 0% - 100%
+  
+  leds.setCurrent(0,5);
+  leds.setCurrent(1,31);
+  leds.setCurrent(2,0);
+  leds.setCurrent(3,1);
+  leds.setCurrent(4,20);
+  leds.show();
+}
+
+void loop() {
+  // put your main code here, to run repeatedly:
+
+}