diff --git a/Ala.cpp b/Ala.cpp new file mode 100644 index 0000000..16a9593 --- /dev/null +++ b/Ala.cpp @@ -0,0 +1,23 @@ +#include "Ala.h" + +#include "Arduino.h" + + +int getStep(long t0, long t, int v) +{ + return ((millis()-t0)%t)*v/t; +} + +float getStepFloat(long t0, long t, float v) +{ + return ((millis()-t0)%t)*v/t; +} + +float mapfloat(float x, float in_min, float in_max, float out_min, float out_max) +{ + return (x - in_min) * (out_max - out_min) / (in_max - in_min) + out_min; +} + + + + diff --git a/Ala.h b/Ala.h new file mode 100644 index 0000000..87f78d7 --- /dev/null +++ b/Ala.h @@ -0,0 +1,279 @@ +#ifndef Ala_h +#define Ala_h + +#include + +#include "Arduino.h" + +//////////////////////////////////////////////////////////////////////////////// +// Drivers + +#define ALA_PWM 1 +#define ALA_TLC5940 2 +#define ALA_WS2812 3 + + +//////////////////////////////////////////////////////////////////////////////// +// Animations + +#define ALA_ON 101 +#define ALA_OFF 102 +#define ALA_BLINK 103 +#define ALA_BLINKALT 104 +#define ALA_SPARKLE 105 +#define ALA_SPARKLE2 106 +#define ALA_STROBO 107 + +#define ALA_CYCLECOLORS 151 + +#define ALA_PIXELSHIFTRIGHT 201 +#define ALA_PIXELSHIFTLEFT 202 +#define ALA_PIXELBOUNCE 203 +#define ALA_PIXELSMOOTHSHIFTRIGHT 211 +#define ALA_PIXELSMOOTHSHIFTLEFT 212 +#define ALA_COMET 221 +#define ALA_COMETCOL 222 +#define ALA_BARSHIFTRIGHT 231 +#define ALA_BARSHIFTLEFT 232 +#define ALA_MOVINGBARS 241 +#define ALA_MOVINGGRADIENT 242 + +#define ALA_FADEIN 301 +#define ALA_FADEOUT 302 +#define ALA_FADEINOUT 303 +#define ALA_GLOW 304 + +#define ALA_FADECOLORS 351 +#define ALA_FADECOLORSLOOP 352 +#define ALA_PIXELSFADECOLORS 353 + +#define ALA_FIRE 501 +#define ALA_BOUNCINGBALLS 502 +#define ALA_BUBBLES 503 + +#define ALA_ENDSEQ 0 + +//////////////////////////////////////////////////////////////////////////////// + +// Strobo effect duty cycle (10=1/10) +#define ALA_STROBODC 10 + + +//////////////////////////////////////////////////////////////////////////////// + +typedef struct AlaColor +{ + union + { + struct + { + uint8_t r; + uint8_t g; + uint8_t b; + }; + uint8_t raw[3]; + }; + + inline AlaColor() __attribute__((always_inline)) + { + } + + // allow construction from R, G, B + inline AlaColor( uint8_t ir, uint8_t ig, uint8_t ib) __attribute__((always_inline)) + : r(ir), g(ig), b(ib) + { + } + + // allow construction from 32-bit (really 24-bit) bit 0xRRGGBB color code + inline AlaColor( uint32_t colorcode) __attribute__((always_inline)) + : r((colorcode >> 16) & 0xFF), g((colorcode >> 8) & 0xFF), b((colorcode >> 0) & 0xFF) + { + } + + bool operator == (const AlaColor &c) const + { + return(this->r == c.r and this->g == c.g and this->b == c.b); + } + + AlaColor getPixel(AlaColor maxOut) + { + return AlaColor(r*maxOut.r/255, g*maxOut.g/255, b*maxOut.b/255); + } + + AlaColor sum(AlaColor color) + { + int r0 = min(color.r + r, 255); + int g0 = min(color.g + g, 255); + int b0 = min(color.b + b, 255); + return AlaColor(r0, g0, b0); + } + + AlaColor interpolate(AlaColor color, float x) + { + int r0 = x*(color.r - r) + r; + int g0 = x*(color.g - g) + g; + int b0 = x*(color.b - b) + b; + return AlaColor(r0, g0, b0); + } + + AlaColor scale(float k) + { + int r0 = min(r*k, 255); + int g0 = min(g*k, 255); + int b0 = min(b*k, 255); + return AlaColor(r0, g0, b0); + } + + typedef enum { + Aqua=0x00FFFF, + Black = 0x000000, + Blue = 0x0000FF, + Cyan=0x00FFFF, + Gold=0xFFD700, + Gray = 0x808080, + Green=0x008000, + Lime=0x00FF00, + Magenta=0xFF00FF, + Navy=0x000080, + Olive=0x808000, + Purple=0x800080, + Red=0xFF0000, + Teal=0x008080, + White=0xFFFFFF, + Yellow=0xFFFF00 + } ColorCodes; +} ; + + + +//////////////////////////////////////////////////////////////////////////////// +// Struct definitions +//////////////////////////////////////////////////////////////////////////////// + +typedef struct AlaPalette +{ + int numColors; + AlaColor *colors; + + /** + * Get the interpolated color from the palette. + * The argument is a floating number between 0 and numColors. + */ + AlaColor getPalColor(float i) + { + int i0 = (int)i%(numColors); + int i1 = (int)(i+1)%(numColors); + + // decimal part is used to interpolate between the two colors + //float t0 = i - trunc(i); + float t0 = i - (int)i; + + return colors[i0].interpolate(colors[i1], t0); + } + + bool operator == (const AlaPalette &c) const + { + if (!(this->numColors == c.numColors)) + return false; + + for(int i=0; icolors[i] == c.colors[i])) + return false; + } + return true; + } + +}; + + +typedef struct AlaSeq +{ + int animation; + int speed; + AlaPalette palette; + int duration; +}; + + +//////////////////////////////////////////////////////////////////////////////// +// Colors and palette definitions +//////////////////////////////////////////////////////////////////////////////// + +/* Replaced by enum +static AlaColor alaColorWhite = 0xFFFFFF; +static AlaColor alaColorGray = 0x888888; +static AlaColor alaColorBlack = 0x000000; +static AlaColor alaColorRed = 0xFF0000; +static AlaColor alaColorGreen = 0x00FF00; +static AlaColor alaColorBlue = 0x0000FF; +*/ + +static AlaColor alaPalRgb_[] = { 0xFF0000, 0x00FF00, 0x0000FF }; +static AlaPalette alaPalRgb = { 3, alaPalRgb_ }; + +// Rainbow colors +static AlaColor alaPalRainbow_[] = +{ + 0xFF0000, 0xAB5500, 0xABAB00, 0x00FF00, + 0x00AB55, 0x0000FF, 0x5500AB, 0xAB0055 +}; +static AlaPalette alaPalRainbow = { 8, alaPalRainbow_ }; + +// Rainbow colors with alternating stripes of black +static AlaColor alaPalRainbowStripe_[] = +{ + 0xFF0000, 0x000000, 0xAB5500, 0x000000, 0xABAB00, 0x000000, 0x00FF00, 0x000000, + 0x00AB55, 0x000000, 0x0000FF, 0x000000, 0x5500AB, 0x000000, 0xAB0055, 0x000000 +}; +static AlaPalette alaPalRainbowStripe = { 16, alaPalRainbowStripe_ }; + + +// Blue purple ping red orange yellow (and back) +// Basically, everything but the greens. +// This palette is good for lighting at a club or party. +static AlaColor alaPalParty_[] = +{ + 0x5500AB, 0x84007C, 0xB5004B, 0xE5001B, + 0xE81700, 0xB84700, 0xAB7700, 0xABAB00, + 0xAB5500, 0xDD2200, 0xF2000E, 0xC2003E, + 0x8F0071, 0x5F00A1, 0x2F00D0, 0x0007F9 +}; +static AlaPalette alaPalParty = { 16, alaPalParty_ }; + + +// Approximate "black body radiation" palette, akin to +// the FastLED 'HeatColor' function. +// Recommend that you use values 0-240 rather than +// the usual 0-255, as the last 15 colors will be +// 'wrapping around' from the hot end to the cold end, +// which looks wrong. +static AlaColor alaPalHeat_[] = +{ + 0x000000, 0xFF0000, 0xFFFF00, 0xFFFFCC +}; +static AlaPalette alaPalHeat = { 4, alaPalHeat_ }; + + +static AlaColor alaPalFire_[] = +{ + 0x000000, 0x220000, 0x440000, 0x660000, + 0x990000, 0xCC0000, 0xFF0000, 0xFF3300, + 0xFF6600, 0xFF9900, 0xFFCC00, 0xFFFF00 +}; +static AlaPalette alaPalFire = { 12, alaPalFire_ }; + + + + +//////////////////////////////////////////////////////////////////////////////// +// Utility functions +//////////////////////////////////////////////////////////////////////////////// + +int getStep(long t0, long t, int v); +float getStepFloat(long t0, long t, float v); + +float mapfloat(float x, float in_min, float in_max, float out_min, float out_max); + + +#endif \ No newline at end of file diff --git a/AlaLed.cpp b/AlaLed.cpp new file mode 100644 index 0000000..c20803d --- /dev/null +++ b/AlaLed.cpp @@ -0,0 +1,397 @@ +#include "AlaLed.h" + +#include "ExtTlc5940.h" + + + + +AlaLed::AlaLed() +{ + maxOut=255; + speed = 1000; + animSeqLen = 0; + lastRefreshTime=0; + refreshMillis=1000/50; +} + + + +void AlaLed::initPWM(byte pin) +{ + byte *pins_ = (byte *)malloc(numLeds); + pins_[0] = pin; + + initPWM(1, pins_); +} + + +void AlaLed::initPWM(int numLeds, byte *pins) +{ + this->driver = ALA_PWM; + this->numLeds = numLeds; + this->pins = pins; + + // allocate and clear leds array + if((leds = (byte *)malloc(numLeds))) + { + memset(leds, 0, numLeds); + } +} + +void AlaLed::initTLC5940(int numLeds, byte *pins) +{ + this->driver = ALA_TLC5940; + this->numLeds = numLeds; + this->pins = pins; + + // allocate and clear leds array + if((leds = (byte *)malloc(numLeds))) + { + memset(leds, 0, numLeds); + } + + //pins = (byte *)malloc(numLeds); + //for(int i=0; imaxOut = maxOut; +} + +void AlaLed::setRefreshRate(int refreshRate) +{ + this->refreshMillis = 1000/refreshRate; +} + + +void AlaLed::setAnimation(int animation, int speed) +{ + if (this->animation == animation && this->speed == speed) + return; + + this->animation = animation; + this->speed = speed; + + setAnimationFunc(animation); + animStartTime = millis(); +} + + +void AlaLed::setAnimation(AlaSeq animSeq[]) +{ + this->animSeq = animSeq; + + // initialize animSeqDuration and animSeqLen variables + animSeqDuration = 0; + for(animSeqLen=0; animSeq[animSeqLen].animation!=ALA_ENDSEQ; animSeqLen++) + { + animSeqDuration = animSeqDuration + animSeq[animSeqLen].duration; + } + +} + + +void AlaLed::runAnimation() +{ + // skip the refresh if now enough time has passed since last update + if (millis() < lastRefreshTime + refreshMillis) + return; + lastRefreshTime = millis(); + + if (animSeqLen != 0) + { + // calculate the current animation function + // NOTE: this can be optimized + + long c = 0; + for(int i=0; i=c && t<(c+animSeq[i].duration)) + { + setAnimation(animSeq[i].animation, animSeq[i].speed); + break; + } + c = c + animSeq[i].duration; + } + } + + // can the animation function and refresh if necessary + if (animFunc != NULL) + { + (this->*animFunc)(); + + if(driver==ALA_PWM) + { + for(int i=0; is-l) + leds[x] = maxOut; + else + leds[x] = 0; + } +} + +void AlaLed::barShiftLeft() +{ + int l = numLeds/2+1; // length of the bar + + int s = map(getStep(animStartTime, speed, 1000), 0, 1000, 0, numLeds+l); + + for(int x=0; xs-l) + leds[numLeds-x-1] = maxOut; + else + leds[numLeds-x-1] = 0; + } +} + +//////////////////////////////////////////////////////////////////////////////////////////// +// Fading effects +//////////////////////////////////////////////////////////////////////////////////////////// + +void AlaLed::fadeIn() +{ + int s = getStep(animStartTime, speed, maxOut); + for(int x=0; x GND + * pin 3 > Arduino 11 + * pin 4 > Arduino 13 + * pin 5 > Arduino 9 + * pin 6 > Arduino 10 + XXX resistor to +5V + * pin 7 > GND + * pin 8 > +5V + * pin 9 > xxx resistor to GND + * pin 10 > +5V + * pin 11 > Arduino 3 + * + * It can be used also to drive a single led. + */ + void initTLC5940(int numLeds, byte *pins); + + + /** + * Sets the maximum brightness level (0-255). + */ + void setBrightness(byte maxOut); + + /** + * Sets the maximum refresh rate in Hz (default value is 50 Hz). + * May be useful to reduce flickering in some cases. + */ + void setRefreshRate(int refreshRate); + + + void setAnimation(int animation, int speed); + void setAnimation(AlaSeq animSeq[]); + + void runAnimation(); + + + +private: + + void setAnimationFunc(int animation); + void on(); + void off(); + void blink(); + void blinkAlt(); + void sparkle(); + void strobo(); + + void pixelShiftRight(); + void pixelShiftLeft(); + void pixelBounce(); + void pixelSmoothShiftRight(); + void pixelSmoothShiftLeft(); + void comet(); + void barShiftRight(); + void barShiftLeft(); + + void fadeIn(); + void fadeOut(); + void fadeInOut(); + void glow(); + + + byte driver; + byte *pins; + byte *leds; + int numLeds; + + int maxOut; + int refreshMillis; + + int animation; + long speed; + + AlaSeq *animSeq; + int animSeqLen; + long animSeqDuration; + + void (AlaLed::*animFunc)(); + unsigned long animStartTime; + unsigned long lastRefreshTime; + +}; + +#endif \ No newline at end of file diff --git a/AlaLedRgb.cpp b/AlaLedRgb.cpp new file mode 100644 index 0000000..0d25b57 --- /dev/null +++ b/AlaLedRgb.cpp @@ -0,0 +1,687 @@ +#include "Ala.h" +#include "AlaLedRgb.h" + +#include "Arduino.h" + +#include "ExtNeoPixel.h" +#include "ExtTlc5940.h" + +Adafruit_NeoPixel *neopixels; + + +AlaLedRgb::AlaLedRgb() +{ + // set default values + + maxOut = 0xFFFFFF; + speed = 1000; + animSeqLen = 0; + lastRefreshTime = 0; + refreshMillis = 1000/60; + pxPos = NULL; + pxSpeed = NULL; +} + + +void AlaLedRgb::initPWM(byte pinRed, byte pinGreen, byte pinBlue) +{ + byte *pins_ = (byte *)malloc(3*numLeds); + pins_[0] = pinRed; + pins_[1] = pinGreen; + pins_[2] = pinBlue; + + initPWM(1, pins_); +} + +void AlaLedRgb::initPWM(int numLeds, byte *pins) +{ + this->driver = ALA_PWM; + this->numLeds = numLeds; + this->pins = pins; + + // allocate and clear leds array + if((leds = (AlaColor *)malloc(3*numLeds))) + { + memset(leds, 0, 3*numLeds); + } +} + +void AlaLedRgb::initTLC5940(int numLeds, byte *pins) +{ + this->driver = ALA_TLC5940; + this->numLeds = numLeds; + this->pins = pins; + + // allocate and clear leds array + if(leds = (AlaColor *)malloc(3*numLeds)) + { + memset(leds, 0, 3*numLeds); + } + + //pins = (byte *)malloc(numLeds); + //for(int i=0; idriver = ALA_WS2812; + this->numLeds = numLeds; + this->pins = pins; + + // allocate and clear leds array + if((leds = (AlaColor *)malloc(3*numLeds))) + { + memset(leds, 0, 3*numLeds); + } + + neopixels = new Adafruit_NeoPixel(numLeds, pin, type); + + neopixels->begin(); +} + + + +void AlaLedRgb::setBrightness(AlaColor maxOut) +{ + this->maxOut = maxOut; +} + +void AlaLedRgb::setRefreshRate(int refreshRate) +{ + this->refreshMillis = 1000/refreshRate; +} + +int AlaLedRgb::getRefreshRate() +{ + static long t; + + long el = millis() - t; + t = millis(); + + return 1000/el; +} + + +void AlaLedRgb::setAnimation(int animation, int speed, AlaColor color) +{ + if (this->animation == animation && this->speed == speed && this->palette.numColors == 1 && this->palette.colors[0] == color) + return; + + // delete any previously allocated array + if (pxPos!=NULL) + { delete[] pxPos; pxPos=NULL; } + if (pxSpeed!=NULL) + { delete[] pxSpeed; pxSpeed=NULL; } + + this->animation = animation; + this->speed = speed; + + this->palette.numColors = 1; + this->palette.colors = (AlaColor*)malloc(3); + this->palette.colors[0] = color; + + setAnimationFunc(animation); + animStartTime = millis(); +} + +void AlaLedRgb::setAnimation(int animation, int speed, AlaPalette palette) +{ + if (this->animation == animation && this->speed == speed && this->palette == palette) + return; + + // delete any previously allocated array + if (pxPos!=NULL) + { delete[] pxPos; pxPos=NULL; } + if (pxSpeed!=NULL) + { delete[] pxSpeed; pxSpeed=NULL; } + + this->animation = animation; + this->speed = speed; + this->palette = palette; + + setAnimationFunc(animation); + animStartTime = millis(); +} + + +void AlaLedRgb::setAnimation(AlaSeq animSeq[]) +{ + this->animSeq = animSeq; + + // initialize animSeqDuration and animSeqLen variables + animSeqDuration = 0; + for(animSeqLen=0; animSeq[animSeqLen].animation!=ALA_ENDSEQ; animSeqLen++) + { + animSeqDuration = animSeqDuration + animSeq[animSeqLen].duration; + } +} + +void AlaLedRgb::nextAnimation() +{ + currAnim = (currAnim+1)%animSeqLen; +} + +bool AlaLedRgb::runAnimation() +{ + // skip the refresh if now enough time has passed since last update + if (millis() < lastRefreshTime + refreshMillis) + return false; + lastRefreshTime = millis(); + + if (animSeqLen != 0) + { + if(animSeq[currAnim].duration == 0) + { + setAnimation(animSeq[currAnim].animation, animSeq[currAnim].speed, animSeq[currAnim].palette); + } + else + { + long c = 0; + for(int i=0; i=c && t<(c+animSeq[i].duration)) + { + setAnimation(animSeq[i].animation, animSeq[i].speed, animSeq[i].palette); + break; + } + c = c + animSeq[i].duration; + } + } + } + + if (animFunc != NULL) + { + (this->*animFunc)(); + + if(driver==ALA_PWM) + { + for(int i=0; isetPixelColor(i, neopixels->Color(leds[i].r*maxOut.r/255, leds[i].g*maxOut.g/255, leds[i].b*maxOut.b/255)); + + neopixels->show(); + } + } + + return true; +} + + +/////////////////////////////////////////////////////////////////////////////// + +void AlaLedRgb::setAnimationFunc(int animation) +{ + + switch(animation) + { + case ALA_ON: animFunc = &AlaLedRgb::on; break; + case ALA_OFF: animFunc = &AlaLedRgb::off; break; + case ALA_BLINK: animFunc = &AlaLedRgb::blink; break; + case ALA_BLINKALT: animFunc = &AlaLedRgb::blinkAlt; break; + case ALA_SPARKLE: animFunc = &AlaLedRgb::sparkle; break; + case ALA_SPARKLE2: animFunc = &AlaLedRgb::sparkle2; break; + case ALA_STROBO: animFunc = &AlaLedRgb::strobo; break; + + case ALA_PIXELSHIFTRIGHT: animFunc = &AlaLedRgb::pixelShiftRight; break; + case ALA_PIXELSHIFTLEFT: animFunc = &AlaLedRgb::pixelShiftLeft; break; + case ALA_PIXELBOUNCE: animFunc = &AlaLedRgb::pixelBounce; break; + case ALA_PIXELSMOOTHSHIFTRIGHT: animFunc = &AlaLedRgb::pixelSmoothShiftRight; break; + case ALA_PIXELSMOOTHSHIFTLEFT: animFunc = &AlaLedRgb::pixelSmoothShiftLeft; break; + case ALA_COMET: animFunc = &AlaLedRgb::comet; break; + case ALA_COMETCOL: animFunc = &AlaLedRgb::cometCol; break; + case ALA_MOVINGBARS: animFunc = &AlaLedRgb::movingBars; break; + case ALA_MOVINGGRADIENT: animFunc = &AlaLedRgb::movingGradient; break; + + case ALA_GLOW: animFunc = &AlaLedRgb::glow; break; + case ALA_FADECOLORS: animFunc = &AlaLedRgb::fadeColors; break; + case ALA_PIXELSFADECOLORS: animFunc = &AlaLedRgb::pixelsFadeColors; break; + case ALA_FADECOLORSLOOP: animFunc = &AlaLedRgb::fadeColorsLoop; break; + case ALA_CYCLECOLORS: animFunc = &AlaLedRgb::cycleColors; break; + + case ALA_FIRE: animFunc = &AlaLedRgb::fire; break; + case ALA_BOUNCINGBALLS: animFunc = &AlaLedRgb::bouncingBalls; break; + case ALA_BUBBLES: animFunc = &AlaLedRgb::bubbles; break; + + default: animFunc = &AlaLedRgb::off; + } + +} + + +void AlaLedRgb::on() +{ + for(int i=0; i= 2; k--) { + heat[k] = (heat[k - 1] + heat[k - 2] + heat[k - 2] ) / 3; + } + + // Step 3. Randomly ignite new 'sparks' of heat near the bottom + if( random(255) < SPARKING ) + { + int y = random(7); + heat[y] = min((int)heat[y] + random(160,255), 255); + } + + // Step 4. Map from heat cells to LED colors + for(int j=0; j-0.04 and pxSpeed[i]<0 and pxPos[i]>0 and pxPos[i]<0.1) + pxSpeed[i]=(0.09)-((float)random(10)/1000); + + pxPos[i] = pxPos[i] + pxSpeed[i]; + if(pxPos[i]>=1) + { + pxPos[i]=1; + } + if(pxPos[i]<0) + { + pxPos[i]=-pxPos[i]; + pxSpeed[i]=-0.91*pxSpeed[i]; + } + + pxSpeed[i] = pxSpeed[i]-speedReduction; + } + + for (int x=0; x=1) + { + pxPos[i]=0; + pxSpeed[i]=0; + } + if(random(20)==0 and pxPos[i]==0) + { + pxPos[i]=0.0001; + pxSpeed[i]=0.0001; + } + if(pxPos[i]>0) + { + pxPos[i] = pxPos[i] + pxSpeed[i]; + pxSpeed[i] = pxSpeed[i] + speedDelta; + } + } + + for (int x=0; x0) + { + int p = mapfloat(pxPos[i], 0, 1, 0, numLeds-1); + AlaColor c = palette.colors[i].scale(1-(float)random(10)/30); // add a little flickering + leds[p] = c; + } + } + +} + diff --git a/AlaLedRgb.h b/AlaLedRgb.h new file mode 100644 index 0000000..dfb98c0 --- /dev/null +++ b/AlaLedRgb.h @@ -0,0 +1,112 @@ +#ifndef AlaLedRgb_h +#define AlaLedRgb_h + + +#include "Ala.h" + + +/** + * AlaLedRgb can be used to drive a single or multiple RGB leds to perform animations. + * Available drivers are PWM pin, TLC5940, WS2811. + */ +class AlaLedRgb +{ + +public: + + AlaLedRgb(); + + void initPWM(byte pinsRed, byte pinGreen, byte pinBlue); + void initPWM(int numLeds, byte *pins); + void initTLC5940(int numLeds, byte *pins); + + /** + * Initializes WS2812 LEDs. It be invoked in the setup() function of the main Arduino sketch. + * + * The type field can be used to set the RGB order and chipset frequency. Constants are Adafruit_NeoPixel.h file. + * It is set by default to NEO_GRB + NEO_KHZ800. + */ + void initWS2812(int numLeds, byte pin, byte type=0x01+0x02); + + /** + * Sets the maximum brightness level. + */ + void setBrightness(AlaColor maxOut); + + /** + * Sets the maximum refresh rate in Hz (default value is 50 Hz). + * May be useful to reduce flickering in some cases. + */ + void setRefreshRate(int refreshRate); + + int getRefreshRate(); + + + void setAnimation(int animation, int speed, AlaColor color); + void setAnimation(int animation, int speed, AlaPalette palette); + void setAnimation(AlaSeq animSeq[]); + bool runAnimation(); + void nextAnimation(); + + + +private: + + void setAnimationFunc(int animation); + void on(); + void off(); + void blink(); + void blinkAlt(); + void sparkle(); + void sparkle2(); + void strobo(); + void cycleColors(); + + void pixelShiftRight(); + void pixelShiftLeft(); + void pixelBounce(); + void pixelSmoothShiftRight(); + void pixelSmoothShiftLeft(); + void comet(); + void cometCol(); + + void glow(); + void fadeColors(); + void pixelsFadeColors(); + void fadeColorsLoop(); + + void movingBars(); + void movingGradient(); + + void fire(); + void bouncingBalls(); + void bubbles(); + + + byte driver; + byte *pins; + byte pin; + AlaColor *leds; + int numLeds; + + int animation; + int currAnim; + long speed; + AlaPalette palette; + AlaSeq *animSeq; + int animSeqLen; + long animSeqDuration; + + void (AlaLedRgb::*animFunc)(); + AlaColor maxOut; + int refreshMillis; + unsigned long animStartTime; + unsigned long lastRefreshTime; + + float *pxPos; + float *pxSpeed; + +}; + + +#endif \ No newline at end of file diff --git a/ExtNeoPixel.cpp b/ExtNeoPixel.cpp new file mode 100644 index 0000000..8818bde --- /dev/null +++ b/ExtNeoPixel.cpp @@ -0,0 +1,1028 @@ +/*------------------------------------------------------------------------- + Arduino library to control a wide variety of WS2811- and WS2812-based RGB + LED devices such as Adafruit FLORA RGB Smart Pixels and NeoPixel strips. + Currently handles 400 and 800 KHz bitstreams on 8, 12 and 16 MHz ATmega + MCUs, with LEDs wired for RGB or GRB color order. 8 MHz MCUs provide + output on PORTB and PORTD, while 16 MHz chips can handle most output pins + (possible exception with upper PORT registers on the Arduino Mega). + + Written by Phil Burgess / Paint Your Dragon for Adafruit Industries, + contributions by PJRC and other members of the open source community. + + Adafruit invests time and resources providing this open source code, + please support Adafruit and open-source hardware by purchasing products + from Adafruit! + + ------------------------------------------------------------------------- + This file is part of the Adafruit NeoPixel library. + + NeoPixel 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 3 of + the License, or (at your option) any later version. + + NeoPixel 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 NeoPixel. If not, see + . + -------------------------------------------------------------------------*/ + +#include "ExtNeoPixel.h" + +Adafruit_NeoPixel::Adafruit_NeoPixel(uint16_t n, uint8_t p, uint8_t t) : numLEDs(n), numBytes(n * 3), pin(p), pixels(NULL) + ,type(t), brightness(0), endTime(0) +#ifdef __AVR__ + ,port(portOutputRegister(digitalPinToPort(p))), + pinMask(digitalPinToBitMask(p)) +#endif +{ + if((pixels = (uint8_t *)malloc(numBytes))) { + memset(pixels, 0, numBytes); + } + if(t & NEO_GRB) { // GRB vs RGB; might add others if needed + rOffset = 1; + gOffset = 0; + bOffset = 2; + } else if (t & NEO_BRG) { + rOffset = 1; + gOffset = 2; + bOffset = 0; + } else { + rOffset = 0; + gOffset = 1; + bOffset = 2; + } + +} + +Adafruit_NeoPixel::~Adafruit_NeoPixel() { + if(pixels) free(pixels); + pinMode(pin, INPUT); +} + +void Adafruit_NeoPixel::begin(void) { + pinMode(pin, OUTPUT); + digitalWrite(pin, LOW); +} + +void Adafruit_NeoPixel::show(void) { + + if(!pixels) return; + + // Data latch = 50+ microsecond pause in the output stream. Rather than + // put a delay at the end of the function, the ending time is noted and + // the function will simply hold off (if needed) on issuing the + // subsequent round of data until the latch time has elapsed. This + // allows the mainline code to start generating the next frame of data + // rather than stalling for the latch. + while(!canShow()); + // endTime is a private member (rather than global var) so that mutliple + // instances on different pins can be quickly issued in succession (each + // instance doesn't delay the next). + + // In order to make this code runtime-configurable to work with any pin, + // SBI/CBI instructions are eschewed in favor of full PORT writes via the + // OUT or ST instructions. It relies on two facts: that peripheral + // functions (such as PWM) take precedence on output pins, so our PORT- + // wide writes won't interfere, and that interrupts are globally disabled + // while data is being issued to the LEDs, so no other code will be + // accessing the PORT. The code takes an initial 'snapshot' of the PORT + // state, computes 'pin high' and 'pin low' values, and writes these back + // to the PORT register as needed. + + noInterrupts(); // Need 100% focus on instruction timing + +#ifdef __AVR__ + + volatile uint16_t + i = numBytes; // Loop counter + volatile uint8_t + *ptr = pixels, // Pointer to next byte + b = *ptr++, // Current byte value + hi, // PORT w/output bit set high + lo; // PORT w/output bit set low + + // Hand-tuned assembly code issues data to the LED drivers at a specific + // rate. There's separate code for different CPU speeds (8, 12, 16 MHz) + // for both the WS2811 (400 KHz) and WS2812 (800 KHz) drivers. The + // datastream timing for the LED drivers allows a little wiggle room each + // way (listed in the datasheets), so the conditions for compiling each + // case are set up for a range of frequencies rather than just the exact + // 8, 12 or 16 MHz values, permitting use with some close-but-not-spot-on + // devices (e.g. 16.5 MHz DigiSpark). The ranges were arrived at based + // on the datasheet figures and have not been extensively tested outside + // the canonical 8/12/16 MHz speeds; there's no guarantee these will work + // close to the extremes (or possibly they could be pushed further). + // Keep in mind only one CPU speed case actually gets compiled; the + // resulting program isn't as massive as it might look from source here. + +// 8 MHz(ish) AVR --------------------------------------------------------- +#if (F_CPU >= 7400000UL) && (F_CPU <= 9500000UL) + +#ifdef NEO_KHZ400 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream +#endif + + volatile uint8_t n1, n2 = 0; // First, next bits out + + // Squeezing an 800 KHz stream out of an 8 MHz chip requires code + // specific to each PORT register. At present this is only written + // to work with pins on PORTD or PORTB, the most likely use case -- + // this covers all the pins on the Adafruit Flora and the bulk of + // digital pins on the Arduino Pro 8 MHz (keep in mind, this code + // doesn't even get compiled for 16 MHz boards like the Uno, Mega, + // Leonardo, etc., so don't bother extending this out of hand). + // Additional PORTs could be added if you really need them, just + // duplicate the else and loop and change the PORT. Each add'l + // PORT will require about 150(ish) bytes of program space. + + // 10 instruction clocks per bit: HHxxxxxLLL + // OUT instructions: ^ ^ ^ (T=0,2,7) + +#ifdef PORTD // PORTD isn't present on ATtiny85, etc. + + if(port == &PORTD) { + + hi = PORTD | pinMask; + lo = PORTD & ~pinMask; + n1 = lo; + if(b & 0x80) n1 = hi; + + // Dirty trick: RJMPs proceeding to the next instruction are used + // to delay two clock cycles in one instruction word (rather than + // using two NOPs). This was necessary in order to squeeze the + // loop down to exactly 64 words -- the maximum possible for a + // relative branch. + + asm volatile( + "headD:" "\n\t" // Clk Pseudocode + // Bit 7: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n2] , %[lo]" "\n\t" // 1 n2 = lo + "out %[port] , %[n1]" "\n\t" // 1 PORT = n1 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 6" "\n\t" // 1-2 if(b & 0x40) + "mov %[n2] , %[hi]" "\n\t" // 0-1 n2 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 6: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n1] , %[lo]" "\n\t" // 1 n1 = lo + "out %[port] , %[n2]" "\n\t" // 1 PORT = n2 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 5" "\n\t" // 1-2 if(b & 0x20) + "mov %[n1] , %[hi]" "\n\t" // 0-1 n1 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 5: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n2] , %[lo]" "\n\t" // 1 n2 = lo + "out %[port] , %[n1]" "\n\t" // 1 PORT = n1 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 4" "\n\t" // 1-2 if(b & 0x10) + "mov %[n2] , %[hi]" "\n\t" // 0-1 n2 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 4: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n1] , %[lo]" "\n\t" // 1 n1 = lo + "out %[port] , %[n2]" "\n\t" // 1 PORT = n2 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 3" "\n\t" // 1-2 if(b & 0x08) + "mov %[n1] , %[hi]" "\n\t" // 0-1 n1 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 3: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n2] , %[lo]" "\n\t" // 1 n2 = lo + "out %[port] , %[n1]" "\n\t" // 1 PORT = n1 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 2" "\n\t" // 1-2 if(b & 0x04) + "mov %[n2] , %[hi]" "\n\t" // 0-1 n2 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 2: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n1] , %[lo]" "\n\t" // 1 n1 = lo + "out %[port] , %[n2]" "\n\t" // 1 PORT = n2 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 1" "\n\t" // 1-2 if(b & 0x02) + "mov %[n1] , %[hi]" "\n\t" // 0-1 n1 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "rjmp .+0" "\n\t" // 2 nop nop + // Bit 1: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n2] , %[lo]" "\n\t" // 1 n2 = lo + "out %[port] , %[n1]" "\n\t" // 1 PORT = n1 + "rjmp .+0" "\n\t" // 2 nop nop + "sbrc %[byte] , 0" "\n\t" // 1-2 if(b & 0x01) + "mov %[n2] , %[hi]" "\n\t" // 0-1 n2 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "sbiw %[count], 1" "\n\t" // 2 i-- (don't act on Z flag yet) + // Bit 0: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi + "mov %[n1] , %[lo]" "\n\t" // 1 n1 = lo + "out %[port] , %[n2]" "\n\t" // 1 PORT = n2 + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ + "sbrc %[byte] , 7" "\n\t" // 1-2 if(b & 0x80) + "mov %[n1] , %[hi]" "\n\t" // 0-1 n1 = hi + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo + "brne headD" "\n" // 2 while(i) (Z flag set above) + : [byte] "+r" (b), + [n1] "+r" (n1), + [n2] "+r" (n2), + [count] "+w" (i) + : [port] "I" (_SFR_IO_ADDR(PORTD)), + [ptr] "e" (ptr), + [hi] "r" (hi), + [lo] "r" (lo)); + + } else if(port == &PORTB) { + +#endif // PORTD + + // Same as above, just switched to PORTB and stripped of comments. + hi = PORTB | pinMask; + lo = PORTB & ~pinMask; + n1 = lo; + if(b & 0x80) n1 = hi; + + asm volatile( + "headB:" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n2] , %[lo]" "\n\t" + "out %[port] , %[n1]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 6" "\n\t" + "mov %[n2] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n1] , %[lo]" "\n\t" + "out %[port] , %[n2]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 5" "\n\t" + "mov %[n1] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n2] , %[lo]" "\n\t" + "out %[port] , %[n1]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 4" "\n\t" + "mov %[n2] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n1] , %[lo]" "\n\t" + "out %[port] , %[n2]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 3" "\n\t" + "mov %[n1] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n2] , %[lo]" "\n\t" + "out %[port] , %[n1]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 2" "\n\t" + "mov %[n2] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n1] , %[lo]" "\n\t" + "out %[port] , %[n2]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 1" "\n\t" + "mov %[n1] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "rjmp .+0" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n2] , %[lo]" "\n\t" + "out %[port] , %[n1]" "\n\t" + "rjmp .+0" "\n\t" + "sbrc %[byte] , 0" "\n\t" + "mov %[n2] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "sbiw %[count], 1" "\n\t" + "out %[port] , %[hi]" "\n\t" + "mov %[n1] , %[lo]" "\n\t" + "out %[port] , %[n2]" "\n\t" + "ld %[byte] , %a[ptr]+" "\n\t" + "sbrc %[byte] , 7" "\n\t" + "mov %[n1] , %[hi]" "\n\t" + "out %[port] , %[lo]" "\n\t" + "brne headB" "\n" + : [byte] "+r" (b), [n1] "+r" (n1), [n2] "+r" (n2), [count] "+w" (i) + : [port] "I" (_SFR_IO_ADDR(PORTB)), [ptr] "e" (ptr), [hi] "r" (hi), + [lo] "r" (lo)); + +#ifdef PORTD + } // endif PORTB +#endif + +#ifdef NEO_KHZ400 + } else { // end 800 KHz, do 400 KHz + + // Timing is more relaxed; unrolling the inner loop for each bit is + // not necessary. Still using the peculiar RJMPs as 2X NOPs, not out + // of need but just to trim the code size down a little. + // This 400-KHz-datastream-on-8-MHz-CPU code is not quite identical + // to the 800-on-16 code later -- the hi/lo timing between WS2811 and + // WS2812 is not simply a 2:1 scale! + + // 20 inst. clocks per bit: HHHHxxxxxxLLLLLLLLLL + // ST instructions: ^ ^ ^ (T=0,4,10) + + volatile uint8_t next, bit; + + hi = *port | pinMask; + lo = *port & ~pinMask; + next = lo; + bit = 8; + + asm volatile( + "head20:" "\n\t" // Clk Pseudocode (T = 0) + "st %a[port], %[hi]" "\n\t" // 2 PORT = hi (T = 2) + "sbrc %[byte] , 7" "\n\t" // 1-2 if(b & 128) + "mov %[next], %[hi]" "\n\t" // 0-1 next = hi (T = 4) + "st %a[port], %[next]" "\n\t" // 2 PORT = next (T = 6) + "mov %[next] , %[lo]" "\n\t" // 1 next = lo (T = 7) + "dec %[bit]" "\n\t" // 1 bit-- (T = 8) + "breq nextbyte20" "\n\t" // 1-2 if(bit == 0) + "rol %[byte]" "\n\t" // 1 b <<= 1 (T = 10) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 12) + "rjmp .+0" "\n\t" // 2 nop nop (T = 14) + "rjmp .+0" "\n\t" // 2 nop nop (T = 16) + "rjmp .+0" "\n\t" // 2 nop nop (T = 18) + "rjmp head20" "\n\t" // 2 -> head20 (next bit out) + "nextbyte20:" "\n\t" // (T = 10) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 12) + "nop" "\n\t" // 1 nop (T = 13) + "ldi %[bit] , 8" "\n\t" // 1 bit = 8 (T = 14) + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ (T = 16) + "sbiw %[count], 1" "\n\t" // 2 i-- (T = 18) + "brne head20" "\n" // 2 if(i != 0) -> (next byte) + : [port] "+e" (port), + [byte] "+r" (b), + [bit] "+r" (bit), + [next] "+r" (next), + [count] "+w" (i) + : [hi] "r" (hi), + [lo] "r" (lo), + [ptr] "e" (ptr)); + } +#endif + +// 12 MHz(ish) AVR -------------------------------------------------------- +#elif (F_CPU >= 11100000UL) && (F_CPU <= 14300000UL) + +#ifdef NEO_KHZ400 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream +#endif + + // In the 12 MHz case, an optimized 800 KHz datastream (no dead time + // between bytes) requires a PORT-specific loop similar to the 8 MHz + // code (but a little more relaxed in this case). + + // 15 instruction clocks per bit: HHHHxxxxxxLLLLL + // OUT instructions: ^ ^ ^ (T=0,4,10) + + volatile uint8_t next; + +#ifdef PORTD + + if(port == &PORTD) { + + hi = PORTD | pinMask; + lo = PORTD & ~pinMask; + next = lo; + if(b & 0x80) next = hi; + + // Don't "optimize" the OUT calls into the bitTime subroutine; + // we're exploiting the RCALL and RET as 3- and 4-cycle NOPs! + asm volatile( + "headD:" "\n\t" // (T = 0) + "out %[port], %[hi]" "\n\t" // (T = 1) + "rcall bitTimeD" "\n\t" // Bit 7 (T = 15) + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 6 + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 5 + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 4 + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 3 + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 2 + "out %[port], %[hi]" "\n\t" + "rcall bitTimeD" "\n\t" // Bit 1 + // Bit 0: + "out %[port] , %[hi]" "\n\t" // 1 PORT = hi (T = 1) + "rjmp .+0" "\n\t" // 2 nop nop (T = 3) + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ (T = 5) + "out %[port] , %[next]" "\n\t" // 1 PORT = next (T = 6) + "mov %[next] , %[lo]" "\n\t" // 1 next = lo (T = 7) + "sbrc %[byte] , 7" "\n\t" // 1-2 if(b & 0x80) (T = 8) + "mov %[next] , %[hi]" "\n\t" // 0-1 next = hi (T = 9) + "nop" "\n\t" // 1 (T = 10) + "out %[port] , %[lo]" "\n\t" // 1 PORT = lo (T = 11) + "sbiw %[count], 1" "\n\t" // 2 i-- (T = 13) + "brne headD" "\n\t" // 2 if(i != 0) -> (next byte) + "rjmp doneD" "\n\t" + "bitTimeD:" "\n\t" // nop nop nop (T = 4) + "out %[port], %[next]" "\n\t" // 1 PORT = next (T = 5) + "mov %[next], %[lo]" "\n\t" // 1 next = lo (T = 6) + "rol %[byte]" "\n\t" // 1 b <<= 1 (T = 7) + "sbrc %[byte], 7" "\n\t" // 1-2 if(b & 0x80) (T = 8) + "mov %[next], %[hi]" "\n\t" // 0-1 next = hi (T = 9) + "nop" "\n\t" // 1 (T = 10) + "out %[port], %[lo]" "\n\t" // 1 PORT = lo (T = 11) + "ret" "\n\t" // 4 nop nop nop nop (T = 15) + "doneD:" "\n" + : [byte] "+r" (b), + [next] "+r" (next), + [count] "+w" (i) + : [port] "I" (_SFR_IO_ADDR(PORTD)), + [ptr] "e" (ptr), + [hi] "r" (hi), + [lo] "r" (lo)); + + } else if(port == &PORTB) { + +#endif // PORTD + + hi = PORTB | pinMask; + lo = PORTB & ~pinMask; + next = lo; + if(b & 0x80) next = hi; + + // Same as above, just set for PORTB & stripped of comments + asm volatile( + "headB:" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port], %[hi]" "\n\t" + "rcall bitTimeB" "\n\t" + "out %[port] , %[hi]" "\n\t" + "rjmp .+0" "\n\t" + "ld %[byte] , %a[ptr]+" "\n\t" + "out %[port] , %[next]" "\n\t" + "mov %[next] , %[lo]" "\n\t" + "sbrc %[byte] , 7" "\n\t" + "mov %[next] , %[hi]" "\n\t" + "nop" "\n\t" + "out %[port] , %[lo]" "\n\t" + "sbiw %[count], 1" "\n\t" + "brne headB" "\n\t" + "rjmp doneB" "\n\t" + "bitTimeB:" "\n\t" + "out %[port], %[next]" "\n\t" + "mov %[next], %[lo]" "\n\t" + "rol %[byte]" "\n\t" + "sbrc %[byte], 7" "\n\t" + "mov %[next], %[hi]" "\n\t" + "nop" "\n\t" + "out %[port], %[lo]" "\n\t" + "ret" "\n\t" + "doneB:" "\n" + : [byte] "+r" (b), [next] "+r" (next), [count] "+w" (i) + : [port] "I" (_SFR_IO_ADDR(PORTB)), [ptr] "e" (ptr), [hi] "r" (hi), + [lo] "r" (lo)); + +#ifdef PORTD + } +#endif + +#ifdef NEO_KHZ400 + } else { // 400 KHz + + // 30 instruction clocks per bit: HHHHHHxxxxxxxxxLLLLLLLLLLLLLLL + // ST instructions: ^ ^ ^ (T=0,6,15) + + volatile uint8_t next, bit; + + hi = *port | pinMask; + lo = *port & ~pinMask; + next = lo; + bit = 8; + + asm volatile( + "head30:" "\n\t" // Clk Pseudocode (T = 0) + "st %a[port], %[hi]" "\n\t" // 2 PORT = hi (T = 2) + "sbrc %[byte] , 7" "\n\t" // 1-2 if(b & 128) + "mov %[next], %[hi]" "\n\t" // 0-1 next = hi (T = 4) + "rjmp .+0" "\n\t" // 2 nop nop (T = 6) + "st %a[port], %[next]" "\n\t" // 2 PORT = next (T = 8) + "rjmp .+0" "\n\t" // 2 nop nop (T = 10) + "rjmp .+0" "\n\t" // 2 nop nop (T = 12) + "rjmp .+0" "\n\t" // 2 nop nop (T = 14) + "nop" "\n\t" // 1 nop (T = 15) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 17) + "rjmp .+0" "\n\t" // 2 nop nop (T = 19) + "dec %[bit]" "\n\t" // 1 bit-- (T = 20) + "breq nextbyte30" "\n\t" // 1-2 if(bit == 0) + "rol %[byte]" "\n\t" // 1 b <<= 1 (T = 22) + "rjmp .+0" "\n\t" // 2 nop nop (T = 24) + "rjmp .+0" "\n\t" // 2 nop nop (T = 26) + "rjmp .+0" "\n\t" // 2 nop nop (T = 28) + "rjmp head30" "\n\t" // 2 -> head30 (next bit out) + "nextbyte30:" "\n\t" // (T = 22) + "nop" "\n\t" // 1 nop (T = 23) + "ldi %[bit] , 8" "\n\t" // 1 bit = 8 (T = 24) + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ (T = 26) + "sbiw %[count], 1" "\n\t" // 2 i-- (T = 28) + "brne head30" "\n" // 1-2 if(i != 0) -> (next byte) + : [port] "+e" (port), + [byte] "+r" (b), + [bit] "+r" (bit), + [next] "+r" (next), + [count] "+w" (i) + : [hi] "r" (hi), + [lo] "r" (lo), + [ptr] "e" (ptr)); + } +#endif + +// 16 MHz(ish) AVR -------------------------------------------------------- +#elif (F_CPU >= 15400000UL) && (F_CPU <= 19000000L) + +#ifdef NEO_KHZ400 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream +#endif + + // WS2811 and WS2812 have different hi/lo duty cycles; this is + // similar but NOT an exact copy of the prior 400-on-8 code. + + // 20 inst. clocks per bit: HHHHHxxxxxxxxLLLLLLL + // ST instructions: ^ ^ ^ (T=0,5,13) + + volatile uint8_t next, bit; + + hi = *port | pinMask; + lo = *port & ~pinMask; + next = lo; + bit = 8; + + asm volatile( + "head20:" "\n\t" // Clk Pseudocode (T = 0) + "st %a[port], %[hi]" "\n\t" // 2 PORT = hi (T = 2) + "sbrc %[byte], 7" "\n\t" // 1-2 if(b & 128) + "mov %[next], %[hi]" "\n\t" // 0-1 next = hi (T = 4) + "dec %[bit]" "\n\t" // 1 bit-- (T = 5) + "st %a[port], %[next]" "\n\t" // 2 PORT = next (T = 7) + "mov %[next] , %[lo]" "\n\t" // 1 next = lo (T = 8) + "breq nextbyte20" "\n\t" // 1-2 if(bit == 0) (from dec above) + "rol %[byte]" "\n\t" // 1 b <<= 1 (T = 10) + "rjmp .+0" "\n\t" // 2 nop nop (T = 12) + "nop" "\n\t" // 1 nop (T = 13) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 15) + "nop" "\n\t" // 1 nop (T = 16) + "rjmp .+0" "\n\t" // 2 nop nop (T = 18) + "rjmp head20" "\n\t" // 2 -> head20 (next bit out) + "nextbyte20:" "\n\t" // (T = 10) + "ldi %[bit] , 8" "\n\t" // 1 bit = 8 (T = 11) + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ (T = 13) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 15) + "nop" "\n\t" // 1 nop (T = 16) + "sbiw %[count], 1" "\n\t" // 2 i-- (T = 18) + "brne head20" "\n" // 2 if(i != 0) -> (next byte) + : [port] "+e" (port), + [byte] "+r" (b), + [bit] "+r" (bit), + [next] "+r" (next), + [count] "+w" (i) + : [ptr] "e" (ptr), + [hi] "r" (hi), + [lo] "r" (lo)); + +#ifdef NEO_KHZ400 + } else { // 400 KHz + + // The 400 KHz clock on 16 MHz MCU is the most 'relaxed' version. + + // 40 inst. clocks per bit: HHHHHHHHxxxxxxxxxxxxLLLLLLLLLLLLLLLLLLLL + // ST instructions: ^ ^ ^ (T=0,8,20) + + volatile uint8_t next, bit; + + hi = *port | pinMask; + lo = *port & ~pinMask; + next = lo; + bit = 8; + + asm volatile( + "head40:" "\n\t" // Clk Pseudocode (T = 0) + "st %a[port], %[hi]" "\n\t" // 2 PORT = hi (T = 2) + "sbrc %[byte] , 7" "\n\t" // 1-2 if(b & 128) + "mov %[next] , %[hi]" "\n\t" // 0-1 next = hi (T = 4) + "rjmp .+0" "\n\t" // 2 nop nop (T = 6) + "rjmp .+0" "\n\t" // 2 nop nop (T = 8) + "st %a[port], %[next]" "\n\t" // 2 PORT = next (T = 10) + "rjmp .+0" "\n\t" // 2 nop nop (T = 12) + "rjmp .+0" "\n\t" // 2 nop nop (T = 14) + "rjmp .+0" "\n\t" // 2 nop nop (T = 16) + "rjmp .+0" "\n\t" // 2 nop nop (T = 18) + "rjmp .+0" "\n\t" // 2 nop nop (T = 20) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 22) + "nop" "\n\t" // 1 nop (T = 23) + "mov %[next] , %[lo]" "\n\t" // 1 next = lo (T = 24) + "dec %[bit]" "\n\t" // 1 bit-- (T = 25) + "breq nextbyte40" "\n\t" // 1-2 if(bit == 0) + "rol %[byte]" "\n\t" // 1 b <<= 1 (T = 27) + "nop" "\n\t" // 1 nop (T = 28) + "rjmp .+0" "\n\t" // 2 nop nop (T = 30) + "rjmp .+0" "\n\t" // 2 nop nop (T = 32) + "rjmp .+0" "\n\t" // 2 nop nop (T = 34) + "rjmp .+0" "\n\t" // 2 nop nop (T = 36) + "rjmp .+0" "\n\t" // 2 nop nop (T = 38) + "rjmp head40" "\n\t" // 2 -> head40 (next bit out) + "nextbyte40:" "\n\t" // (T = 27) + "ldi %[bit] , 8" "\n\t" // 1 bit = 8 (T = 28) + "ld %[byte] , %a[ptr]+" "\n\t" // 2 b = *ptr++ (T = 30) + "rjmp .+0" "\n\t" // 2 nop nop (T = 32) + "st %a[port], %[lo]" "\n\t" // 2 PORT = lo (T = 34) + "rjmp .+0" "\n\t" // 2 nop nop (T = 36) + "sbiw %[count], 1" "\n\t" // 2 i-- (T = 38) + "brne head40" "\n" // 1-2 if(i != 0) -> (next byte) + : [port] "+e" (port), + [byte] "+r" (b), + [bit] "+r" (bit), + [next] "+r" (next), + [count] "+w" (i) + : [ptr] "e" (ptr), + [hi] "r" (hi), + [lo] "r" (lo)); + } +#endif + +#else + #error "CPU SPEED NOT SUPPORTED" +#endif + +#elif defined(__arm__) + +#if defined(__MK20DX128__) || defined(__MK20DX256__) // Teensy 3.0 & 3.1 +#define CYCLES_800_T0H (F_CPU / 4000000) +#define CYCLES_800_T1H (F_CPU / 1250000) +#define CYCLES_800 (F_CPU / 800000) +#define CYCLES_400_T0H (F_CPU / 2000000) +#define CYCLES_400_T1H (F_CPU / 833333) +#define CYCLES_400 (F_CPU / 400000) + + uint8_t *p = pixels, + *end = p + numBytes, pix, mask; + volatile uint8_t *set = portSetRegister(pin), + *clr = portClearRegister(pin); + uint32_t cyc; + + ARM_DEMCR |= ARM_DEMCR_TRCENA; + ARM_DWT_CTRL |= ARM_DWT_CTRL_CYCCNTENA; + +#ifdef NEO_KHZ400 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream +#endif + cyc = ARM_DWT_CYCCNT + CYCLES_800; + while(p < end) { + pix = *p++; + for(mask = 0x80; mask; mask >>= 1) { + while(ARM_DWT_CYCCNT - cyc < CYCLES_800); + cyc = ARM_DWT_CYCCNT; + *set = 1; + if(pix & mask) { + while(ARM_DWT_CYCCNT - cyc < CYCLES_800_T1H); + } else { + while(ARM_DWT_CYCCNT - cyc < CYCLES_800_T0H); + } + *clr = 1; + } + } + while(ARM_DWT_CYCCNT - cyc < CYCLES_800); +#ifdef NEO_KHZ400 + } else { // 400 kHz bitstream + cyc = ARM_DWT_CYCCNT + CYCLES_400; + while(p < end) { + pix = *p++; + for(mask = 0x80; mask; mask >>= 1) { + while(ARM_DWT_CYCCNT - cyc < CYCLES_400); + cyc = ARM_DWT_CYCCNT; + *set = 1; + if(pix & mask) { + while(ARM_DWT_CYCCNT - cyc < CYCLES_400_T1H); + } else { + while(ARM_DWT_CYCCNT - cyc < CYCLES_400_T0H); + } + *clr = 1; + } + } + while(ARM_DWT_CYCCNT - cyc < CYCLES_400); + } +#endif + + + + + +#elif defined(__MKL26Z64__) // Teensy-LC + +#if F_CPU == 48000000 + uint8_t *p = pixels, + pix, count, dly, + bitmask = digitalPinToBitMask(pin); + volatile uint8_t *reg = portSetRegister(pin); + uint32_t num = numBytes; + asm volatile( + "L%=_begin:" "\n\t" + "ldrb %[pix], [%[p], #0]" "\n\t" + "lsl %[pix], #24" "\n\t" + "movs %[count], #7" "\n\t" + "L%=_loop:" "\n\t" + "lsl %[pix], #1" "\n\t" + "bcs L%=_loop_one" "\n\t" + "L%=_loop_zero:" + "strb %[bitmask], [%[reg], #0]" "\n\t" + "movs %[dly], #4" "\n\t" + "L%=_loop_delay_T0H:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_loop_delay_T0H" "\n\t" + "strb %[bitmask], [%[reg], #4]" "\n\t" + "movs %[dly], #13" "\n\t" + "L%=_loop_delay_T0L:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_loop_delay_T0L" "\n\t" + "b L%=_next" "\n\t" + "L%=_loop_one:" + "strb %[bitmask], [%[reg], #0]" "\n\t" + "movs %[dly], #13" "\n\t" + "L%=_loop_delay_T1H:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_loop_delay_T1H" "\n\t" + "strb %[bitmask], [%[reg], #4]" "\n\t" + "movs %[dly], #4" "\n\t" + "L%=_loop_delay_T1L:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_loop_delay_T1L" "\n\t" + "nop" "\n\t" + "L%=_next:" "\n\t" + "sub %[count], #1" "\n\t" + "bne L%=_loop" "\n\t" + "lsl %[pix], #1" "\n\t" + "bcs L%=_last_one" "\n\t" + "L%=_last_zero:" + "strb %[bitmask], [%[reg], #0]" "\n\t" + "movs %[dly], #4" "\n\t" + "L%=_last_delay_T0H:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_last_delay_T0H" "\n\t" + "strb %[bitmask], [%[reg], #4]" "\n\t" + "movs %[dly], #10" "\n\t" + "L%=_last_delay_T0L:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_last_delay_T0L" "\n\t" + "b L%=_repeat" "\n\t" + "L%=_last_one:" + "strb %[bitmask], [%[reg], #0]" "\n\t" + "movs %[dly], #13" "\n\t" + "L%=_last_delay_T1H:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_last_delay_T1H" "\n\t" + "strb %[bitmask], [%[reg], #4]" "\n\t" + "movs %[dly], #1" "\n\t" + "L%=_last_delay_T1L:" "\n\t" + "sub %[dly], #1" "\n\t" + "bne L%=_last_delay_T1L" "\n\t" + "nop" "\n\t" + "L%=_repeat:" "\n\t" + "add %[p], #1" "\n\t" + "sub %[num], #1" "\n\t" + "bne L%=_begin" "\n\t" + "L%=_done:" "\n\t" + : [p] "+r" (p), + [pix] "=&r" (pix), + [count] "=&r" (count), + [dly] "=&r" (dly), + [num] "+r" (num) + : [bitmask] "r" (bitmask), + [reg] "r" (reg) + ); +#else +#error "Sorry, only 48 MHz is supported, please set Tools > CPU Speed to 48 MHz" +#endif + + +#else // Arduino Due + + #define SCALE VARIANT_MCK / 2UL / 1000000UL + #define INST (2UL * F_CPU / VARIANT_MCK) + #define TIME_800_0 ((int)(0.40 * SCALE + 0.5) - (5 * INST)) + #define TIME_800_1 ((int)(0.80 * SCALE + 0.5) - (5 * INST)) + #define PERIOD_800 ((int)(1.25 * SCALE + 0.5) - (5 * INST)) + #define TIME_400_0 ((int)(0.50 * SCALE + 0.5) - (5 * INST)) + #define TIME_400_1 ((int)(1.20 * SCALE + 0.5) - (5 * INST)) + #define PERIOD_400 ((int)(2.50 * SCALE + 0.5) - (5 * INST)) + + int pinMask, time0, time1, period, t; + Pio *port; + volatile WoReg *portSet, *portClear, *timeValue, *timeReset; + uint8_t *p, *end, pix, mask; + + pmc_set_writeprotect(false); + pmc_enable_periph_clk((uint32_t)TC3_IRQn); + TC_Configure(TC1, 0, + TC_CMR_WAVE | TC_CMR_WAVSEL_UP | TC_CMR_TCCLKS_TIMER_CLOCK1); + TC_Start(TC1, 0); + + pinMask = g_APinDescription[pin].ulPin; // Don't 'optimize' these into + port = g_APinDescription[pin].pPort; // declarations above. Want to + portSet = &(port->PIO_SODR); // burn a few cycles after + portClear = &(port->PIO_CODR); // starting timer to minimize + timeValue = &(TC1->TC_CHANNEL[0].TC_CV); // the initial 'while'. + timeReset = &(TC1->TC_CHANNEL[0].TC_CCR); + p = pixels; + end = p + numBytes; + pix = *p++; + mask = 0x80; + +#ifdef NEO_KHZ400 + if((type & NEO_SPDMASK) == NEO_KHZ800) { // 800 KHz bitstream +#endif + time0 = TIME_800_0; + time1 = TIME_800_1; + period = PERIOD_800; +#ifdef NEO_KHZ400 + } else { // 400 KHz bitstream + time0 = TIME_400_0; + time1 = TIME_400_1; + period = PERIOD_400; + } +#endif + + for(t = time0;; t = time0) { + if(pix & mask) t = time1; + while(*timeValue < period); + *portSet = pinMask; + *timeReset = TC_CCR_CLKEN | TC_CCR_SWTRG; + while(*timeValue < t); + *portClear = pinMask; + if(!(mask >>= 1)) { // This 'inside-out' loop logic utilizes + if(p >= end) break; // idle time to minimize inter-byte delays. + pix = *p++; + mask = 0x80; + } + } + while(*timeValue < period); // Wait for last bit + TC_Stop(TC1, 0); + +#endif // end Arduino Due + +#endif // end Architecture select + + interrupts(); + endTime = micros(); // Save EOD time for latch on next call +} + +// Set the output pin number +void Adafruit_NeoPixel::setPin(uint8_t p) { + pinMode(pin, INPUT); + pin = p; + pinMode(p, OUTPUT); + digitalWrite(p, LOW); +#ifdef __AVR__ + port = portOutputRegister(digitalPinToPort(p)); + pinMask = digitalPinToBitMask(p); +#endif +} + +// Set pixel color from separate R,G,B components: +void Adafruit_NeoPixel::setPixelColor( + uint16_t n, uint8_t r, uint8_t g, uint8_t b) { + if(n < numLEDs) { + if(brightness) { // See notes in setBrightness() + r = (r * brightness) >> 8; + g = (g * brightness) >> 8; + b = (b * brightness) >> 8; + } + uint8_t *p = &pixels[n * 3]; + p[rOffset] = r; + p[gOffset] = g; + p[bOffset] = b; + } +} + +// Set pixel color from 'packed' 32-bit RGB color: +void Adafruit_NeoPixel::setPixelColor(uint16_t n, uint32_t c) { + if(n < numLEDs) { + uint8_t + r = (uint8_t)(c >> 16), + g = (uint8_t)(c >> 8), + b = (uint8_t)c; + if(brightness) { // See notes in setBrightness() + r = (r * brightness) >> 8; + g = (g * brightness) >> 8; + b = (b * brightness) >> 8; + } + uint8_t *p = &pixels[n * 3]; + p[rOffset] = r; + p[gOffset] = g; + p[bOffset] = b; + } +} + +// Convert separate R,G,B into packed 32-bit RGB color. +// Packed format is always RGB, regardless of LED strand color order. +uint32_t Adafruit_NeoPixel::Color(uint8_t r, uint8_t g, uint8_t b) { + return ((uint32_t)r << 16) | ((uint32_t)g << 8) | b; +} + +// Query color from previously-set pixel (returns packed 32-bit RGB value) +uint32_t Adafruit_NeoPixel::getPixelColor(uint16_t n) const { + if(n >= numLEDs) { + // Out of bounds, return no color. + return 0; + } + uint8_t *p = &pixels[n * 3]; + uint32_t c = ((uint32_t)p[rOffset] << 16) | + ((uint32_t)p[gOffset] << 8) | + (uint32_t)p[bOffset]; + // Adjust this back up to the true color, as setting a pixel color will + // scale it back down again. + if(brightness) { // See notes in setBrightness() + //Cast the color to a byte array + uint8_t * c_ptr =reinterpret_cast(&c); + c_ptr[0] = (c_ptr[0] << 8)/brightness; + c_ptr[1] = (c_ptr[1] << 8)/brightness; + c_ptr[2] = (c_ptr[2] << 8)/brightness; + } + return c; // Pixel # is out of bounds +} + +// Returns pointer to pixels[] array. Pixel data is stored in device- +// native format and is not translated here. Application will need to be +// aware whether pixels are RGB vs. GRB and handle colors appropriately. +uint8_t *Adafruit_NeoPixel::getPixels(void) const { + return pixels; +} + +uint16_t Adafruit_NeoPixel::numPixels(void) const { + return numLEDs; +} + +// Adjust output brightness; 0=darkest (off), 255=brightest. This does +// NOT immediately affect what's currently displayed on the LEDs. The +// next call to show() will refresh the LEDs at this level. However, +// this process is potentially "lossy," especially when increasing +// brightness. The tight timing in the WS2811/WS2812 code means there +// aren't enough free cycles to perform this scaling on the fly as data +// is issued. So we make a pass through the existing color data in RAM +// and scale it (subsequent graphics commands also work at this +// brightness level). If there's a significant step up in brightness, +// the limited number of steps (quantization) in the old data will be +// quite visible in the re-scaled version. For a non-destructive +// change, you'll need to re-render the full strip data. C'est la vie. +void Adafruit_NeoPixel::setBrightness(uint8_t b) { + // Stored brightness value is different than what's passed. + // This simplifies the actual scaling math later, allowing a fast + // 8x8-bit multiply and taking the MSB. 'brightness' is a uint8_t, + // adding 1 here may (intentionally) roll over...so 0 = max brightness + // (color values are interpreted literally; no scaling), 1 = min + // brightness (off), 255 = just below max brightness. + uint8_t newBrightness = b + 1; + if(newBrightness != brightness) { // Compare against prior value + // Brightness has changed -- re-scale existing data in RAM + uint8_t c, + *ptr = pixels, + oldBrightness = brightness - 1; // De-wrap old brightness value + uint16_t scale; + if(oldBrightness == 0) scale = 0; // Avoid /0 + else if(b == 255) scale = 65535 / oldBrightness; + else scale = (((uint16_t)newBrightness << 8) - 1) / oldBrightness; + for(uint16_t i=0; i> 8; + } + brightness = newBrightness; + } +} + +//Return the brightness value +uint8_t Adafruit_NeoPixel::getBrightness(void) const { + return brightness - 1; +} + +void Adafruit_NeoPixel::clear() { + memset(pixels, 0, numBytes); +} diff --git a/ExtNeoPixel.h b/ExtNeoPixel.h new file mode 100644 index 0000000..264c199 --- /dev/null +++ b/ExtNeoPixel.h @@ -0,0 +1,97 @@ +/*-------------------------------------------------------------------- + This file is part of the Adafruit NeoPixel library. + + NeoPixel 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 3 of + the License, or (at your option) any later version. + + NeoPixel 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 NeoPixel. If not, see + . + --------------------------------------------------------------------*/ + +#ifndef ADAFRUIT_NEOPIXEL_H +#define ADAFRUIT_NEOPIXEL_H + +#if (ARDUINO >= 100) + #include +#else + #include + #include +#endif + +// 'type' flags for LED pixels (third parameter to constructor): +#define NEO_RGB 0x00 // Wired for RGB data order +#define NEO_GRB 0x01 // Wired for GRB data order +#define NEO_BRG 0x04 + +#define NEO_COLMASK 0x01 +#define NEO_KHZ800 0x02 // 800 KHz datastream +#define NEO_SPDMASK 0x02 +// Trinket flash space is tight, v1 NeoPixels aren't handled by default. +// Remove the ifndef/endif to add support -- but code will be bigger. +// Conversely, can comment out the #defines to save space on other MCUs. +#ifndef __AVR_ATtiny85__ +#define NEO_KHZ400 0x00 // 400 KHz datastream +#endif + +class Adafruit_NeoPixel { + + public: + + // Constructor: number of LEDs, pin number, LED type + Adafruit_NeoPixel(uint16_t n, uint8_t p=6, uint8_t t=NEO_GRB + NEO_KHZ800); + ~Adafruit_NeoPixel(); + + void + begin(void), + show(void), + setPin(uint8_t p), + setPixelColor(uint16_t n, uint8_t r, uint8_t g, uint8_t b), + setPixelColor(uint16_t n, uint32_t c), + setBrightness(uint8_t), + clear(); + uint8_t + *getPixels(void) const, + getBrightness(void) const; + uint16_t + numPixels(void) const; + static uint32_t + Color(uint8_t r, uint8_t g, uint8_t b); + uint32_t + getPixelColor(uint16_t n) const; + inline bool + canShow(void) { return (micros() - endTime) >= 50L; } + + private: + + const uint16_t + numLEDs, // Number of RGB LEDs in strip + numBytes; // Size of 'pixels' buffer below + uint8_t + pin, // Output pin number + brightness, + *pixels, // Holds LED color values (3 bytes each) + rOffset, // Index of red byte within each 3-byte pixel + gOffset, // Index of green byte + bOffset; // Index of blue byte + const uint8_t + type; // Pixel flags (400 vs 800 KHz, RGB vs GRB color) + uint32_t + endTime; // Latch timing reference +#ifdef __AVR__ + const volatile uint8_t + *port; // Output PORT register + uint8_t + pinMask; // Output PORT bitmask +#endif + +}; + +#endif // ADAFRUIT_NEOPIXEL_H diff --git a/ExtTlc5940.cpp b/ExtTlc5940.cpp new file mode 100644 index 0000000..fa83549 --- /dev/null +++ b/ExtTlc5940.cpp @@ -0,0 +1,372 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +/** \file + Tlc5940 class functions. */ + +#include +#include + +#include "ExtTlc5940Config.h" +#include "ExtTlc5940.h" + +/** Pulses a pin - high then low. */ +#define pulse_pin(port, pin) port |= _BV(pin); port &= ~_BV(pin) + +/** This will be true (!= 0) if update was just called and the data has not + been latched in yet. */ +volatile uint8_t tlc_needXLAT; + +/** Some of the extened library will need to be called after a successful + update. */ +volatile void (*tlc_onUpdateFinished)(void); + +/** Packed grayscale data, 24 bytes (16 * 12 bits) per TLC. + + Format: Lets assume we have 2 TLCs, A and B, daisy-chained with the SOUT of + A going into the SIN of B. + - byte 0: upper 8 bits of B.15 + - byte 1: lower 4 bits of B.15 and upper 4 bits of B.14 + - byte 2: lower 8 bits of B.0 + - ... + - byte 24: upper 8 bits of A.15 + - byte 25: lower 4 bits of A.15 and upper 4 bits of A.14 + - ... + - byte 47: lower 8 bits of A.0 + + \note Normally packing data like this is bad practice. But in this + situation, shifting the data out is really fast because the format of + the array is the same as the format of the TLC's serial interface. */ +uint8_t tlc_GSData[NUM_TLCS * 24]; + +/** Don't add an extra SCLK pulse after switching from dot-correction mode. */ +static uint8_t firstGSInput; + +/** Interrupt called after an XLAT pulse to prevent more XLAT pulses. */ +ISR(TIMER1_OVF_vect) +{ + disable_XLAT_pulses(); + clear_XLAT_interrupt(); + tlc_needXLAT = 0; + if (tlc_onUpdateFinished) { + sei(); + tlc_onUpdateFinished(); + } +} + +/** \defgroup ReqVPRG_ENABLED Functions that Require VPRG_ENABLED + Functions that require VPRG_ENABLED == 1. + You can enable VPRG by changing + \code #define VPRG_ENABLED 0 \endcode to + \code #define VPRG_ENABLED 1 \endcode in tlc_config.h + + You will also have to connect Arduino digital pin 6 to TLC pin 27. (The + pin to be used can be changed in tlc_config.h). If VPRG is not enabled, + the TLC pin should grounded (remember to unconnect TLC pin 27 from GND + if you do enable VPRG). */ +/* @{ */ /* @} */ + +/** \defgroup CoreFunctions Core Libary Functions + These function are all prefixed with "Tlc." */ +/* @{ */ + +/** Pin i/o and Timer setup. The grayscale register will be reset to all + zeros, or whatever initialValue is set to and the Timers will start. + \param initialValue = 0, optional parameter specifing the inital startup + value */ +void Tlc5940::init(uint16_t initialValue) +{ + /* Pin Setup */ + XLAT_DDR |= _BV(XLAT_PIN); + BLANK_DDR |= _BV(BLANK_PIN); + GSCLK_DDR |= _BV(GSCLK_PIN); +#if VPRG_ENABLED + VPRG_DDR |= _BV(VPRG_PIN); + VPRG_PORT &= ~_BV(VPRG_PIN); // grayscale mode (VPRG low) +#endif +#if XERR_ENABLED + XERR_DDR &= ~_BV(XERR_PIN); // XERR as input + XERR_PORT |= _BV(XERR_PIN); // enable pull-up resistor +#endif + BLANK_PORT |= _BV(BLANK_PIN); // leave blank high (until the timers start) + + tlc_shift8_init(); + + setAll(initialValue); + update(); + disable_XLAT_pulses(); + clear_XLAT_interrupt(); + tlc_needXLAT = 0; + pulse_pin(XLAT_PORT, XLAT_PIN); + + + /* Timer Setup */ + + /* Timer 1 - BLANK / XLAT */ + TCCR1A = _BV(COM1B1); // non inverting, output on OC1B, BLANK + TCCR1B = _BV(WGM13); // Phase/freq correct PWM, ICR1 top + OCR1A = 1; // duty factor on OC1A, XLAT is inside BLANK + OCR1B = 2; // duty factor on BLANK (larger than OCR1A (XLAT)) + ICR1 = TLC_PWM_PERIOD; // see tlc_config.h + + /* Timer 2 - GSCLK */ +#if defined(TLC_ATMEGA_8_H) + TCCR2 = _BV(COM20) // set on BOTTOM, clear on OCR2A (non-inverting), + | _BV(WGM21); // output on OC2B, CTC mode with OCR2 top + OCR2 = TLC_GSCLK_PERIOD / 2; // see tlc_config.h + TCCR2 |= _BV(CS20); // no prescale, (start pwm output) +#elif defined(TLC_TIMER3_GSCLK) + TCCR3A = _BV(COM3A1) // set on BOTTOM, clear on OCR3A (non-inverting), + // output on OC3A + | _BV(WGM31); // Fast pwm with ICR3 top + OCR3A = 0; // duty factor (as short a pulse as possible) + ICR3 = TLC_GSCLK_PERIOD; // see tlc_config.h + TCCR3B = _BV(CS30) // no prescale, (start pwm output) + | _BV(WGM32) // Fast pwm with ICR3 top + | _BV(WGM33); // Fast pwm with ICR3 top +#else + TCCR2A = _BV(COM2B1) // set on BOTTOM, clear on OCR2A (non-inverting), + // output on OC2B + | _BV(WGM21) // Fast pwm with OCR2A top + | _BV(WGM20); // Fast pwm with OCR2A top + TCCR2B = _BV(WGM22); // Fast pwm with OCR2A top + OCR2B = 0; // duty factor (as short a pulse as possible) + OCR2A = TLC_GSCLK_PERIOD; // see tlc_config.h + TCCR2B |= _BV(CS20); // no prescale, (start pwm output) +#endif + TCCR1B |= _BV(CS10); // no prescale, (start pwm output) + update(); +} + +/** Clears the grayscale data array, #tlc_GSData, but does not shift in any + data. This call should be followed by update() if you are turning off + all the outputs. */ +void Tlc5940::clear(void) +{ + setAll(0); +} + +/** Shifts in the data from the grayscale data array, #tlc_GSData. + If data has already been shifted in this grayscale cycle, another call to + update() will immediately return 1 without shifting in the new data. To + ensure that a call to update() does shift in new data, use + \code while(Tlc.update()); \endcode + or + \code while(tlc_needXLAT); \endcode + \returns 1 if there is data waiting to be latched, 0 if data was + successfully shifted in */ +uint8_t Tlc5940::update(void) +{ + if (tlc_needXLAT) { + return 1; + } + disable_XLAT_pulses(); + if (firstGSInput) { + // adds an extra SCLK pulse unless we've just set dot-correction data + firstGSInput = 0; + } else { + pulse_pin(SCLK_PORT, SCLK_PIN); + } + uint8_t *p = tlc_GSData; + while (p < tlc_GSData + NUM_TLCS * 24) { + tlc_shift8(*p++); + tlc_shift8(*p++); + tlc_shift8(*p++); + } + tlc_needXLAT = 1; + enable_XLAT_pulses(); + set_XLAT_interrupt(); + return 0; +} + +/** Sets channel to value in the grayscale data array, #tlc_GSData. + \param channel (0 to #NUM_TLCS * 16 - 1). OUT0 of the first TLC is + channel 0, OUT0 of the next TLC is channel 16, etc. + \param value (0-4095). The grayscale value, 4095 is maximum. + \see get */ +void Tlc5940::set(TLC_CHANNEL_TYPE channel, uint16_t value) +{ + TLC_CHANNEL_TYPE index8 = (NUM_TLCS * 16 - 1) - channel; + uint8_t *index12p = tlc_GSData + ((((uint16_t)index8) * 3) >> 1); + if (index8 & 1) { // starts in the middle + // first 4 bits intact | 4 top bits of value + *index12p = (*index12p & 0xF0) | (value >> 8); + // 8 lower bits of value + *(++index12p) = value & 0xFF; + } else { // starts clean + // 8 upper bits of value + *(index12p++) = value >> 4; + // 4 lower bits of value | last 4 bits intact + *index12p = ((uint8_t)(value << 4)) | (*index12p & 0xF); + } +} + +/** Gets the current grayscale value for a channel + \param channel (0 to #NUM_TLCS * 16 - 1). OUT0 of the first TLC is + channel 0, OUT0 of the next TLC is channel 16, etc. + \returns current grayscale value (0 - 4095) for channel + \see set */ +uint16_t Tlc5940::get(TLC_CHANNEL_TYPE channel) +{ + TLC_CHANNEL_TYPE index8 = (NUM_TLCS * 16 - 1) - channel; + uint8_t *index12p = tlc_GSData + ((((uint16_t)index8) * 3) >> 1); + return (index8 & 1)? // starts in the middle + (((uint16_t)(*index12p & 15)) << 8) | // upper 4 bits + *(index12p + 1) // lower 8 bits + : // starts clean + (((uint16_t)(*index12p)) << 4) | // upper 8 bits + ((*(index12p + 1) & 0xF0) >> 4); // lower 4 bits + // that's probably the ugliest ternary operator I've ever created. +} + +/** Sets all channels to value. + \param value grayscale value (0 - 4095) */ +void Tlc5940::setAll(uint16_t value) +{ + uint8_t firstByte = value >> 4; + uint8_t secondByte = (value << 4) | (value >> 8); + uint8_t *p = tlc_GSData; + while (p < tlc_GSData + NUM_TLCS * 24) { + *p++ = firstByte; + *p++ = secondByte; + *p++ = (uint8_t)value; + } +} + +#if VPRG_ENABLED + +/** \addtogroup ReqVPRG_ENABLED + From the \ref CoreFunctions "Core Functions": + - \link Tlc5940::setAllDC Tlc.setAllDC(uint8_t value(0-63)) \endlink - sets + all the dot correction data to value */ +/* @{ */ + +/** Sets the dot correction for all channels to value. The dot correction + value correspondes to maximum output current by + \f$\displaystyle I_{OUT_n} = I_{max} \times \frac{DCn}{63} \f$ + where + - \f$\displaystyle I_{max} = \frac{1.24V}{R_{IREF}} \times 31.5 = + \frac{39.06}{R_{IREF}} \f$ + - DCn is the dot correction value for channel n + \param value (0-63) */ +void Tlc5940::setAllDC(uint8_t value) +{ + tlc_dcModeStart(); + + uint8_t firstByte = value << 2 | value >> 4; + uint8_t secondByte = value << 4 | value >> 2; + uint8_t thirdByte = value << 6 | value; + + for (TLC_CHANNEL_TYPE i = 0; i < NUM_TLCS * 12; i += 3) { + tlc_shift8(firstByte); + tlc_shift8(secondByte); + tlc_shift8(thirdByte); + } + pulse_pin(XLAT_PORT, XLAT_PIN); + + tlc_dcModeStop(); +} + +/* @} */ + +#endif + +#if XERR_ENABLED + +/** Checks for shorted/broken LEDs reported by any of the TLCs. + \returns 1 if a TLC is reporting an error, 0 otherwise. */ +uint8_t Tlc5940::readXERR(void) +{ + return ((XERR_PINS & _BV(XERR_PIN)) == 0); +} + +#endif + +/* @} */ + +#if DATA_TRANSFER_MODE == TLC_BITBANG + +/** Sets all the bit-bang pins to output */ +void tlc_shift8_init(void) +{ + SIN_DDR |= _BV(SIN_PIN); // SIN as output + SCLK_DDR |= _BV(SCLK_PIN); // SCLK as output + SCLK_PORT &= ~_BV(SCLK_PIN); +} + +/** Shifts a byte out, MSB first */ +void tlc_shift8(uint8_t byte) +{ + for (uint8_t bit = 0x80; bit; bit >>= 1) { + if (bit & byte) { + SIN_PORT |= _BV(SIN_PIN); + } else { + SIN_PORT &= ~_BV(SIN_PIN); + } + pulse_pin(SCLK_PORT, SCLK_PIN); + } +} + +#elif DATA_TRANSFER_MODE == TLC_SPI + +/** Initializes the SPI module to double speed (f_osc / 2) */ +void tlc_shift8_init(void) +{ + SIN_DDR |= _BV(SIN_PIN); // SPI MOSI as output + SCLK_DDR |= _BV(SCLK_PIN); // SPI SCK as output + TLC_SS_DDR |= _BV(TLC_SS_PIN); // SPI SS as output + + SCLK_PORT &= ~_BV(SCLK_PIN); + + SPSR = _BV(SPI2X); // double speed (f_osc / 2) + SPCR = _BV(SPE) // enable SPI + | _BV(MSTR); // master mode +} + +/** Shifts out a byte, MSB first */ +void tlc_shift8(uint8_t byte) +{ + SPDR = byte; // starts transmission + while (!(SPSR & _BV(SPIF))) + ; // wait for transmission complete +} + +#endif + +#if VPRG_ENABLED + +/** Switches to dot correction mode and clears any waiting grayscale latches.*/ +void tlc_dcModeStart(void) +{ + disable_XLAT_pulses(); // ensure that no latches happen + clear_XLAT_interrupt(); // (in case this was called right after update) + tlc_needXLAT = 0; + VPRG_PORT |= _BV(VPRG_PIN); // dot correction mode +} + +/** Switches back to grayscale mode. */ +void tlc_dcModeStop(void) +{ + VPRG_PORT &= ~_BV(VPRG_PIN); // back to grayscale mode + firstGSInput = 1; +} + +#endif + +/** Preinstantiated Tlc variable. */ +Tlc5940 Tlc; diff --git a/ExtTlc5940.h b/ExtTlc5940.h new file mode 100644 index 0000000..3d7fd27 --- /dev/null +++ b/ExtTlc5940.h @@ -0,0 +1,87 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC5940_H +#define TLC5940_H + +/** \file + Tlc5940 library header file. */ + +#include +#include "ExtTlc5940Config.h" + +#ifdef TLC_ATMEGA_8_H + +/** Enables the Timer1 Overflow interrupt, which will fire after an XLAT + pulse */ +#define set_XLAT_interrupt() TIFR |= _BV(TOV1); TIMSK = _BV(TOIE1) +/** Disables any Timer1 interrupts */ +#define clear_XLAT_interrupt() TIMSK = 0 + +#else + +/** Enables the Timer1 Overflow interrupt, which will fire after an XLAT + pulse */ +#define set_XLAT_interrupt() TIFR1 |= _BV(TOV1); TIMSK1 = _BV(TOIE1) +/** Disables any Timer1 interrupts */ +#define clear_XLAT_interrupt() TIMSK1 = 0 + +#endif + +/** Enables the output of XLAT pulses */ +#define enable_XLAT_pulses() TCCR1A = _BV(COM1A1) | _BV(COM1B1) +/** Disables the output of XLAT pulses */ +#define disable_XLAT_pulses() TCCR1A = _BV(COM1B1) + +extern volatile uint8_t tlc_needXLAT; +extern volatile void (*tlc_onUpdateFinished)(void); +extern uint8_t tlc_GSData[NUM_TLCS * 24]; + +/** The main Tlc5940 class for the entire library. An instance of this class + will be preinstantiated as Tlc. */ +class Tlc5940 +{ + public: + void init(uint16_t initialValue = 0); + void clear(void); + uint8_t update(void); + void set(TLC_CHANNEL_TYPE channel, uint16_t value); + uint16_t get(TLC_CHANNEL_TYPE channel); + void setAll(uint16_t value); +#if VPRG_ENABLED + void setAllDC(uint8_t value); +#endif +#if XERR_ENABLED + uint8_t readXERR(void); +#endif + +}; + +void tlc_shift8_init(void); +void tlc_shift8(uint8_t byte); + +#if VPRG_ENABLED +void tlc_dcModeStart(void); +void tlc_dcModeStop(void); +#endif + +// for the preinstantiated Tlc variable. +extern Tlc5940 Tlc; + +#endif + diff --git a/ExtTlc5940Config.h b/ExtTlc5940Config.h new file mode 100644 index 0000000..9a81d1e --- /dev/null +++ b/ExtTlc5940Config.h @@ -0,0 +1,173 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_CONFIG_H +#define TLC_CONFIG_H + +#include + +/** \file + Configuration for the Arduino Tlc5940 library. After making changes to + this file, delete Tlc5940.o in this folder so the changes are applied. + + A summary of all the options: + - Number of TLCs daisy-chained: NUM_TLCS (default 1) + - Enable/Disable VPRG functionality: VPRG_ENABLED (default 0) + - Enable/Disable XERR functionality: XERR_ENABLED (default 0) + - Should the library use bit-banging (any pins) or hardware SPI (faster): + DATA_TRANSFER_MODE (default TLC_SPI) + - Which pins to use for bit-banging: SIN_PIN, SIN_PORT, SIN_DDR and + SCLK_PIN, SCLK_PORT, SCLK_DDR + - The PWM period: TLC_PWM_PERIOD (be sure to change TLC_GSCLK_PERIOD + accordingly!) + + How to change the pin mapping: + - Arduino digital pin 0-7 = PORTD, PD0-7 + - Arduino digital pin 8-13 = PORTB, PB0-5 + - Arduino analog pin 0-5 = PORTC, PC0-5 */ + +/** Bit-bang using any two i/o pins */ +#define TLC_BITBANG 1 +/** Use the much faster hardware SPI module */ +#define TLC_SPI 2 + +/* ------------------------ START EDITING HERE ----------------------------- */ + +/** Number of TLCs daisy-chained. To daisy-chain, attach the SOUT (TLC pin 17) + of the first TLC to the SIN (TLC pin 26) of the next. The rest of the pins + are attached normally. + \note Each TLC needs it's own IREF resistor */ +#define NUM_TLCS 1 + +/** Determines how data should be transfered to the TLCs. Bit-banging can use + any two i/o pins, but the hardware SPI is faster. + - Bit-Bang = TLC_BITBANG + - Hardware SPI = TLC_SPI (default) */ +#define DATA_TRANSFER_MODE TLC_SPI + +/* This include is down here because the files it includes needs the data + transfer mode */ +#include "pinouts/chip_includes.h" + +/* Set DATA_TRANSFER_MODE to TLC_BITBANG and change the pins below if you need + to use different pins for sin and sclk. The defaults are defined in + pinouts/ATmega_xx8.h for most Arduino's. */ + +#if DATA_TRANSFER_MODE == TLC_BITBANG +/** SIN (TLC pin 26) */ +#define SIN_PIN DEFAULT_BB_SIN_PIN +#define SIN_PORT DEFAULT_BB_SIN_PORT +#define SIN_DDR DEFAULT_BB_SIN_DDR +/** SCLK (TLC pin 25) */ +#define SCLK_PIN DEFAULT_BB_SCLK_PIN +#define SCLK_PORT DEFAULT_BB_SCLK_PORT +#define SCLK_DDR DEFAULT_BB_SCLK_DDR +#endif + + +/** If more than 16 TLCs are daisy-chained, the channel type has to be uint16_t. + Default is uint8_t, which supports up to 16 TLCs. */ +#define TLC_CHANNEL_TYPE uint8_t + +/** Determines how long each PWM period should be, in clocks. + \f$\displaystyle f_{PWM} = \frac{f_{osc}}{2 * TLC\_PWM\_PERIOD} Hz \f$ + \f$\displaystyle TLC\_PWM\_PERIOD = \frac{f_{osc}}{2 * f_{PWM}} \f$ + This is related to TLC_GSCLK_PERIOD: + \f$\displaystyle TLC\_PWM\_PERIOD = + \frac{(TLC\_GSCLK\_PERIOD + 1) * 4096}{2} \f$ + \note The default of 8192 means the PWM frequency is 976.5625Hz */ +#define TLC_PWM_PERIOD 8192 + +/** Determines how long each period GSCLK is. + This is related to TLC_PWM_PERIOD: + \f$\displaystyle TLC\_GSCLK\_PERIOD = + \frac{2 * TLC\_PWM\_PERIOD}{4096} - 1 \f$ + \note Default is 3 */ +#define TLC_GSCLK_PERIOD 3 + +/** Enables/disables VPRG (TLC pin 27) functionality. If you need to set dot + correction data, this needs to be enabled. + - 0 VPRG is not connected. TLC pin 27 must be grounded! (default) + - 1 VPRG is connected + \note VPRG to GND inputs grayscale data, VPRG to Vcc inputs dot-correction + data */ +#define VPRG_ENABLED 0 + +/** Enables/disables XERR (TLC pin 16) functionality to check for shorted/broken + LEDs + - 0 XERR is not connected (default) + - 1 XERR is connected + \note XERR is active low */ +#define XERR_ENABLED 0 + +/* You can change the VPRG and XERR pins freely. The defaults are defined in + the chip-specific pinouts: see pinouts/ATmega_xx8.h for most Arduino's. */ + +#if VPRG_ENABLED +/** VPRG (TLC pin 27) */ +#define VPRG_PIN DEFAULT_VPRG_PIN +#define VPRG_PORT DEFAULT_VPRG_PORT +#define VPRG_DDR DEFAULT_VPRG_DDR +#endif + +#if XERR_ENABLED +/** XERR (TLC pin 16) */ +#define XERR_PIN DEFAULT_XERR_PIN +#define XERR_PORT DEFAULT_XERR_PORT +#define XERR_DDR DEFAULT_XERR_DDR +#define XERR_PINS DEFAULT_XERR_PINS +#endif + +/* ------------------------- STOP EDITING HERE ----------------------------- */ + +#if DATA_TRANSFER_MODE == TLC_SPI +/** SIN (TLC pin 26) */ +#define SIN_PIN TLC_MOSI_PIN +#define SIN_PORT TLC_MOSI_PORT +#define SIN_DDR TLC_MOSI_DDR +/** SCLK (TLC pin 25) */ +#define SCLK_PIN TLC_SCK_PIN +#define SCLK_PORT TLC_SCK_PORT +#define SCLK_DDR TLC_SCK_DDR +#endif + + + +#if !(DATA_TRANSFER_MODE == TLC_BITBANG \ + || DATA_TRANSFER_MODE == TLC_SPI) +#error "Invalid DATA_TRANSFER_MODE specified, see DATA_TRANSFER_MODE" +#endif + +/* Various Macros */ + +/** Arranges 2 grayscale values (0 - 4095) in the packed array format (3 bytes). + This is for array initializers only: the output is three comma seperated + 8-bit values. */ +#define GS_DUO(a, b) ((a) >> 4), ((a) << 4) | ((b) >> 8), (b) + + +#if VPRG_ENABLED +/** Arranges 4 dot correction values (0 - 63) in the packed array format. + \see setDCtoProgmemArray */ +#define DC_QUARTET(a, b, c, d) ((a) << 2) | ((b) >> 4), \ + ((b) << 4) | ((c) >> 2), \ + ((c) << 6) | (d) +#endif + +#endif + diff --git a/examples/MultiAnimations/MultiAnimations.ino b/examples/MultiAnimations/MultiAnimations.ino new file mode 100644 index 0000000..bbc82ca --- /dev/null +++ b/examples/MultiAnimations/MultiAnimations.ino @@ -0,0 +1,47 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: ALA Example - ComplexMultitasking +// +// Example to demonstrate how to drive different set of LEDs independently +// using Arduino PWM output pins a TLC5940 chip and an WS2812 strip. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-multianimations.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include "AlaLed.h" +#include "AlaLedRgb.h" + +byte tlcPins1[] = { 1, 2, 3 }; +byte tlcPins2[] = { 6,7,8, 9,10,11, 12,13,14 }; + +AlaLed led1; +AlaLed led2; +AlaLed someLeds; +AlaLedRgb rgbLeds; +AlaLedRgb rgbStrip; + + +void setup() +{ + led1.initPWM(5); + led2.initPWM(6); + someLeds.initTLC5940(3, tlcPins1); + rgbLeds.initTLC5940(3, tlcPins2); + rgbStrip.initWS2812(8, 2); + + led1.setAnimation(ALA_STROBO, 1000); + led2.setAnimation(ALA_GLOW, 5000); + someLeds.setAnimation(ALA_PIXELSMOOTHSHIFTLEFT, 2400); + rgbLeds.setAnimation(ALA_FADECOLORSLOOP, 12000, alaPalRgb); + rgbStrip.setAnimation(ALA_COMETCOL, 5000, alaPalRgb); +} + +void loop() +{ + led1.runAnimation(); + led2.runAnimation(); + someLeds.runAnimation(); + rgbLeds.runAnimation(); + rgbStrip.runAnimation(); +} diff --git a/examples/MultiLedSequence/MultiLedSequence.ino b/examples/MultiLedSequence/MultiLedSequence.ino new file mode 100644 index 0000000..530ee67 --- /dev/null +++ b/examples/MultiLedSequence/MultiLedSequence.ino @@ -0,0 +1,46 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: MultiLedSequence +// +// Example to demonstrate the use of animation sequences. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-multiledseq.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include + +AlaLed leds; +byte pins[] = { 5, 6, 9, 10, 11 }; + +AlaSeq seq[] = +{ + { ALA_FADEIN, 1000, 1000 }, + { ALA_ON, 1000, 1000 }, + { ALA_FADEOUT, 1000, 1000 }, + { ALA_BARSHIFTRIGHT, 1000, 1000 }, + { ALA_BARSHIFTLEFT, 1000, 1000 }, + { ALA_OFF, 1000, 1000 }, + { ALA_PIXELSHIFTRIGHT, 700, 1400 }, + { ALA_PIXELSHIFTLEFT, 700, 1400 }, + { ALA_BLINKALT, 500, 3000 }, + { ALA_PIXELSMOOTHSHIFTRIGHT, 1000, 4000 }, + { ALA_PIXELSMOOTHSHIFTLEFT, 1000, 4000 }, + { ALA_FADEINOUT, 1000, 4000 }, + { ALA_COMET, 1000, 4000 }, + { ALA_GLOW, 1000, 4000 }, + { ALA_STROBO, 200, 4000 }, + { ALA_ENDSEQ, 0, 0 } +}; + + +void setup() +{ + leds.initPWM(3, pins); + leds.setAnimation(seq); +} + +void loop() +{ + leds.runAnimation(); +} diff --git a/examples/MultiLedSequence/schematic/MultiLedSequence.fzz b/examples/MultiLedSequence/schematic/MultiLedSequence.fzz new file mode 100644 index 0000000..35ba42c Binary files /dev/null and b/examples/MultiLedSequence/schematic/MultiLedSequence.fzz differ diff --git a/examples/MultiLedSequence/schematic/MultiLedSequence_bb.png b/examples/MultiLedSequence/schematic/MultiLedSequence_bb.png new file mode 100644 index 0000000..d6e46ac Binary files /dev/null and b/examples/MultiLedSequence/schematic/MultiLedSequence_bb.png differ diff --git a/examples/MultiLedSequence/schematic/MultiLedSequence_schem.png b/examples/MultiLedSequence/schematic/MultiLedSequence_schem.png new file mode 100644 index 0000000..c3bacbf Binary files /dev/null and b/examples/MultiLedSequence/schematic/MultiLedSequence_schem.png differ diff --git a/examples/RgbLedSequence/RgbLedSequence.ino b/examples/RgbLedSequence/RgbLedSequence.ino new file mode 100644 index 0000000..3cdac24 --- /dev/null +++ b/examples/RgbLedSequence/RgbLedSequence.ino @@ -0,0 +1,48 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: RgbLedSequence +// +// Example to demonstrate how to create an animation sequence for one RGB LED. +// The example also shows how to create and use a custom color palette. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-rgbledsequence.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include "AlaLedRgb.h" + +#define REDPIN 11 +#define GREENPIN 9 +#define BLUEPIN 10 + +AlaLedRgb rgbLed; + +// custom palette : black , white , black , red , green , blue +AlaColor mycolors_[6] = { 0x000000, 0xFFFFFF, 0x000000, 0xFF0000, 0x00FF00, 0x0000FF }; +AlaPalette mycolors = { 6, colors_ }; + + +AlaSeq seq[] = +{ + { ALA_CYCLECOLORS, 3000, 3000, alaPalRgb }, + { ALA_OFF, 1000, 1000, NULL }, + { ALA_FADECOLORSLOOP, 4000, 8000, alaPalRgb }, + { ALA_FADECOLORSLOOP, 500, 4000, mycolors }, + { ALA_OFF, 1000, 1000, NULL }, + { ALA_FADECOLORS, 5000, 5000, mycolors }, + { ALA_OFF, 1000, 1000, NULL }, + { ALA_ENDSEQ, 0, 0, NULL } +}; + + +void setup() +{ + rgbLed.initPWM(REDPIN, GREENPIN, BLUEPIN); + rgbLed.setBrightness(0x33FF22); + rgbLed.setAnimation(seq); +} + +void loop() +{ + rgbLed.runAnimation(); +} diff --git a/examples/RgbStripButtons/AlaRgbStripDemo.ino b/examples/RgbStripButtons/AlaRgbStripDemo.ino new file mode 100644 index 0000000..459cd72 --- /dev/null +++ b/examples/RgbStripButtons/AlaRgbStripDemo.ino @@ -0,0 +1,84 @@ + +#include "AlaLedRgb.h" +#include "Button.h" + + +AlaLedRgb rgbStrip; +Button button1 = Button(2, PULLDOWN); +Button button2 = Button(3, PULLDOWN); +Button button3 = Button(4, PULLDOWN); + +int animation = 0; +int duration = 0; +int palette = 0; + +int animList[14] = { + ALA_ON, + ALA_SPARKLE, + ALA_SPARKLE2, + ALA_PIXELSHIFTRIGHT, + ALA_PIXELSMOOTHSHIFTRIGHT, + ALA_MOVINGBARS, + ALA_COMET, + ALA_COMETCOL, + ALA_GLOW, + ALA_CYCLECOLORS, + ALA_FADECOLORS, + ALA_FIRE, + ALA_BOUNCINGBALLS, + ALA_BUBBLES +}; + +AlaPalette paletteList[3] = { + alaPalRgb, + alaPalRainbow, + alaPalFire +}; + +int durationList[3] = { + 1000, + 2000, + 5000 +}; + + +void setup() +{ + delay(4000); + + rgbStrip.initWS2812(60, 6); + + updateAnimation(); +} + +void loop() +{ + // button 1 changes the animation + if (button1.uniquePress()) + { + animation++; + updateAnimation(); + } + + // button 2 changes the color palette + if (button2.uniquePress()) + { + palette++; + updateAnimation(); + } + + // button 3 changes the animation speed + if (button3.uniquePress()) + { + duration++; + updateAnimation(); + } + + rgbStrip.runAnimation(); + +} + +void updateAnimation() +{ + rgbStrip.setAnimation(animList[animation%14], durationList[duration%3], paletteList[palette%3]); +} diff --git a/examples/RgbStripDemo/RgbStripDemo.ino b/examples/RgbStripDemo/RgbStripDemo.ino new file mode 100644 index 0000000..ab3a7a5 --- /dev/null +++ b/examples/RgbStripDemo/RgbStripDemo.ino @@ -0,0 +1,55 @@ + +#include "AlaLedRgb.h" + +AlaLedRgb rgbStrip; + + +AlaSeq seq[] = +{ + { ALA_OFF, 1000, alaPalRgb, 2000 }, + { ALA_ON, 1000, alaPalRgb, 2000 }, + { ALA_SPARKLE, 1000, alaPalRgb, 9000 }, + { ALA_CYCLECOLORS, 3000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_FADECOLORSLOOP, 3000, alaPalRgb, 6000 }, + { ALA_SPARKLE2, 1000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_SPARKLE2, 1000, alaPalFire, 6000 }, + { ALA_PIXELSMOOTHSHIFTRIGHT, 2000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_MOVINGBARS, 3000, alaPalRgb, 6000 }, + { ALA_COMET, 3000, alaPalRgb, 6000 }, + { ALA_COMETCOL, 3000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_GLOW, 3000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_FIRE, 1000, alaPalFire, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_BOUNCINGBALLS, 1000, alaPalRgb, 6000 }, + { ALA_OFF, 1000, alaPalRgb, 1000 }, + { ALA_BUBBLES, 1000, alaPalRainbow, 6000 }, + { ALA_ENDSEQ, 0, NULL, 0 } +}; +/* +AlaPalette paletteList[3] = { + alaPalRgb, + alaPalRainbow, + alaPalFire +}; +*/ +void setup() +{ + delay(1000); + + rgbStrip.initWS2812(60, 6); + + rgbStrip.setBrightness(0x444444); + + rgbStrip.setAnimation(seq); +} + +void loop() +{ + rgbStrip.runAnimation(); +} + diff --git a/examples/SimpleLed/SimpleLed.ino b/examples/SimpleLed/SimpleLed.ino new file mode 100644 index 0000000..4c887e1 --- /dev/null +++ b/examples/SimpleLed/SimpleLed.ino @@ -0,0 +1,29 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: SimpleLed +// +// A very simple example about how to fade one LED. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-simpleled.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + + +#include + +AlaLed alaLed; + +void setup() +{ + // initialize the led attached to pin 13 + alaLed.initPWM(13); + + // set a fading animation with a duration of 2 seconds + alaLed.setAnimation(ALA_FADEIN, 2000); +} + +void loop() +{ + // animate the led + alaLed.runAnimation(); +} diff --git a/examples/SimpleLed/schematic/SimpleLed.fzz b/examples/SimpleLed/schematic/SimpleLed.fzz new file mode 100644 index 0000000..882bc83 Binary files /dev/null and b/examples/SimpleLed/schematic/SimpleLed.fzz differ diff --git a/examples/SimpleLed/schematic/SimpleLed_bb.png b/examples/SimpleLed/schematic/SimpleLed_bb.png new file mode 100644 index 0000000..dd58c47 Binary files /dev/null and b/examples/SimpleLed/schematic/SimpleLed_bb.png differ diff --git a/examples/SimpleLed/schematic/SimpleLed_schem.png b/examples/SimpleLed/schematic/SimpleLed_schem.png new file mode 100644 index 0000000..fc4211c Binary files /dev/null and b/examples/SimpleLed/schematic/SimpleLed_schem.png differ diff --git a/examples/SimpleRgbLed/SimpleRgbLed.ino b/examples/SimpleRgbLed/SimpleRgbLed.ino new file mode 100644 index 0000000..f8feffa --- /dev/null +++ b/examples/SimpleRgbLed/SimpleRgbLed.ino @@ -0,0 +1,29 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: SimpleRgbLed +// +// Example to demonstrate how to create a color-fading animation for one RGB LED. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-simplergbled.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include + +#define REDPIN 11 +#define GREENPIN 9 +#define BLUEPIN 10 + +AlaLedRgb rgbLed; + +void setup() +{ + rgbLed.initPWM(REDPIN, GREENPIN, BLUEPIN); + rgbLed.setBrightness(0x66FF44); // calibrate white + rgbLed.setAnimation(ALA_FADECOLORSLOOP, 5000, alaPalRgb); +} + +void loop() +{ + rgbLed.runAnimation(); +} diff --git a/examples/SimpleRgbStrip/SimpleRgbStrip.ino b/examples/SimpleRgbStrip/SimpleRgbStrip.ino new file mode 100644 index 0000000..537b884 --- /dev/null +++ b/examples/SimpleRgbStrip/SimpleRgbStrip.ino @@ -0,0 +1,26 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: RgbStrip +// +// Example to demonstrate how to create display a color-fading animation for a +// WS2812 RGB LED strip. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-rgbstrip.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include "AlaLedRgb.h" + +AlaLedRgb rgbStrip; + +void setup() +{ + rgbStrip.initWS2812(30, 6); + + rgbStrip.setAnimation(ALA_FADECOLORSLOOP, 5000, alaPalRgb); +} + +void loop() +{ + rgbStrip.runAnimation(); +} diff --git a/examples/SimpleTlc5940/SimpleTlc5940.ino b/examples/SimpleTlc5940/SimpleTlc5940.ino new file mode 100644 index 0000000..a835f82 --- /dev/null +++ b/examples/SimpleTlc5940/SimpleTlc5940.ino @@ -0,0 +1,26 @@ +/////////////////////////////////////////////////////////////////////////////////////////// +// +// ALA library example: SimpleTlc5940 +// +// Example to demonstrate how to animate few LEDs using a TLC5940 chip. +// +// Web page: http://yaab-arduino.blogspot.com/p/ala-example-tlc5940.html +// +/////////////////////////////////////////////////////////////////////////////////////////// + +#include + +AlaLed alaLed; + +byte pins[] = { 4, 5, 6, 7, 8 }; + +void setup() +{ + alaLed.initTLC5940(5, pins); + alaLed.setAnimation(ALA_GLOW, 2000); +} + +void loop() +{ + alaLed.runAnimation(); +} diff --git a/keywords.txt b/keywords.txt new file mode 100644 index 0000000..51ce79d --- /dev/null +++ b/keywords.txt @@ -0,0 +1,67 @@ +####################################### +# Syntax Coloring Map For ALA +####################################### + + +####################################### +# Datatypes (KEYWORD1) +####################################### + +AlaLed KEYWORD1 +AlaLedRgb KEYWORD1 + +AlaColor KEYWORD1 +AlaPalette KEYWORD1 +AlaSeq KEYWORD1 + + +####################################### +# Methods and Functions +####################################### + +initPWM KEYWORD2 +initTLC5940 KEYWORD2 +initWS2812 KEYWORD2 +setBrightness KEYWORD2 +setRefreshRate KEYWORD2 +setAnimation KEYWORD2 +runAnimation KEYWORD2 + + +####################################### +# Constants +####################################### + +ALA_ON LITERAL1 +ALA_OFF LITERAL1 +ALA_BLINK LITERAL1 +ALA_BLINKALT LITERAL1 +ALA_SPARKLE LITERAL1 +ALA_SPARKLE2 LITERAL1 +ALA_STROBO LITERAL1 + +ALA_FADECOLORSLOOP LITERAL1 +ALA_FADECOLORS LITERAL1 +ALA_CYCLECOLORS LITERAL1 + +ALA_PIXELSHIFTRIGHT LITERAL1 +ALA_PIXELSHIFTLEFT LITERAL1 +ALA_PIXELBOUNCE LITERAL1 +ALA_PIXELSMOOTHSHIFTRIGHT LITERAL1 +ALA_PIXELSMOOTHSHIFTLEFT LITERAL1 +ALA_COMET LITERAL1 +ALA_COMETCOL LITERAL1 +ALA_BARSHIFTRIGHT LITERAL1 +ALA_BARSHIFTLEFT LITERAL1 +ALA_MOVINGBARS LITERAL1 + +ALA_FADEIN LITERAL1 +ALA_FADEOUT LITERAL1 +ALA_FADEINOUT LITERAL1 +ALA_GLOW LITERAL1 + +ALA_FIRE LITERAL1 +ALA_BOUNCINGBALLS LITERAL1 +ALA_BUBBLES LITERAL1 + +ALA_ENDSEQ LITERAL1 diff --git a/pinouts/ATmega_8.h b/pinouts/ATmega_8.h new file mode 100644 index 0000000..a09b033 --- /dev/null +++ b/pinouts/ATmega_8.h @@ -0,0 +1,86 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_8_H +#define TLC_ATMEGA_8_H + +#if DATA_TRANSFER_MODE == TLC_SPI +#warning SPI cannot be used on the ATmega8 because it interferes with timer2 +#warning setting DATA_TRANSFER_MODE to TLC_BITBANG +#define DATA_TRANSFER_MODE TLC_BITBANG +#endif + +/** \file + SPI and timer pins for the ATmega8. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Arduino digital pin 8) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB0 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Arduino digital pin 12) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Arduino digital pin 7) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PD7 +#define DEFAULT_BB_SIN_PORT PORTD +#define DEFAULT_BB_SIN_DDR DDRD +/** SCLK (Arduino digital pin 4) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PD4 +#define DEFAULT_BB_SCLK_PORT PORTD +#define DEFAULT_BB_SCLK_DDR DDRD + +/** MOSI (Arduino digital pin 11) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB3 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Arduino digital pin 13) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB5 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB2 +#define TLC_SS_DDR DDRB + +/** OC1A (Arduino digital pin 9) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB1 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Arduino digital pin 10) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB2 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Arduino digital pin 3) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD3 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/ATmega_xx4.h b/pinouts/ATmega_xx4.h new file mode 100644 index 0000000..a10e7ea --- /dev/null +++ b/pinouts/ATmega_xx4.h @@ -0,0 +1,80 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_XX8_H +#define TLC_ATMEGA_XX8_H + +/** \file + SPI and timer pins for the ATmega164/324/644. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Sanguino digital pin 15) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PD7 +#define DEFAULT_VPRG_PORT PORTD +#define DEFAULT_VPRG_DDR DDRD + +/** XERR (Sanguino digital pin 6) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB6 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Sanguino digital pin 5) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PB5 +#define DEFAULT_BB_SIN_PORT PORTB +#define DEFAULT_BB_SIN_DDR DDRB +/** SCLK (Sanguino digital pin 7) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PB7 +#define DEFAULT_BB_SCLK_PORT PORTB +#define DEFAULT_BB_SCLK_DDR DDRB + +/** MOSI (Sanguino digital pin 5) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB5 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Sanguino digital pin 7) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB7 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB4 +#define TLC_SS_DDR DDRB + +/** OC1A (Sanguino digital pin 13) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PD5 +#define XLAT_PORT PORTD +#define XLAT_DDR DDRD + +/** OC1B (Sanguino digital pin 12) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PD4 +#define BLANK_PORT PORTD +#define BLANK_DDR DDRD + +/** OC2B (Sanguino digital pin 14) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD6 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/ATmega_xx8.h b/pinouts/ATmega_xx8.h new file mode 100644 index 0000000..e9e9093 --- /dev/null +++ b/pinouts/ATmega_xx8.h @@ -0,0 +1,80 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_XX8_H +#define TLC_ATMEGA_XX8_H + +/** \file + SPI and timer pins for the ATmega168/48/88. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Arduino digital pin 8) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB0 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Arduino digital pin 12) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Arduino digital pin 7) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PD7 +#define DEFAULT_BB_SIN_PORT PORTD +#define DEFAULT_BB_SIN_DDR DDRD +/** SCLK (Arduino digital pin 4) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PD4 +#define DEFAULT_BB_SCLK_PORT PORTD +#define DEFAULT_BB_SCLK_DDR DDRD + +/** MOSI (Arduino digital pin 11) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB3 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Arduino digital pin 13) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB5 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB2 +#define TLC_SS_DDR DDRB + +/** OC1A (Arduino digital pin 9) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB1 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Arduino digital pin 10) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB2 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Arduino digital pin 3) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD3 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/Arduino_Mega.h b/pinouts/Arduino_Mega.h new file mode 100644 index 0000000..6bf735a --- /dev/null +++ b/pinouts/Arduino_Mega.h @@ -0,0 +1,81 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef ARDUINO_MEGA_H +#define ARDUINO_MEGA_H + +/** \file + SPI and timer pins for the Arduino Mega. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Mega pin 50) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB3 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Mega pin 10) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Mega pin 51) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PB2 +#define DEFAULT_BB_SIN_PORT PORTB +#define DEFAULT_BB_SIN_DDR DDRB +/** SCLK (Mega pin 52) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PB1 +#define DEFAULT_BB_SCLK_PORT PORTB +#define DEFAULT_BB_SCLK_DDR DDRB + +/** MOSI (Mega pin 51) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Mega pin 52) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Mega pin 53) +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB0 +#define TLC_SS_DDR DDRB + +/** OC1A (Mega pin 11) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Mega pin 12) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Mega pin 9) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PH6 +#define GSCLK_PORT PORTH +#define GSCLK_DDR DDRH + +#endif + diff --git a/pinouts/Teensy_xxU4.h b/pinouts/Teensy_xxU4.h new file mode 100644 index 0000000..5b38736 --- /dev/null +++ b/pinouts/Teensy_xxU4.h @@ -0,0 +1,39 @@ +#ifndef TLC_Teensy_xxU4_h +#define TLC_Teensy_xxU4_h + +#if DATA_TRANSFER_MODE == TLC_BITBANG +#error "If you want bitbang mode, insert pin defs here" +#endif + +// MOSI (Teensy pin 2) -> SIN (TLC pin 26) +#define TLC_MOSI_PIN 2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +// SCK (Teensy pin 1) -> SCLK (TLC pin 25) +#define TLC_SCK_PIN 1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Teensy pin 0) +#define TLC_SS_PIN 0 +#define TLC_SS_DDR DDRB + +// OC1A (Teensy pin 14) -> XLAT (TLC pin 24) +#define XLAT_PIN 5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +// OC1B (Teensy pin 15) -> BLANK (TLC pin 23) +#define BLANK_PIN 6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +// OC3A (Teensy pin 9) -> GSCLK (TLC pin 18) +#define GSCLK_PIN 6 +#define GSCLK_PORT PORTC +#define GSCLK_DDR DDRC +#define TLC_TIMER3_GSCLK 1 + +#endif + diff --git a/pinouts/Teensypp_xxx6.h b/pinouts/Teensypp_xxx6.h new file mode 100644 index 0000000..a6eb57a --- /dev/null +++ b/pinouts/Teensypp_xxx6.h @@ -0,0 +1,38 @@ +#ifndef TLC_Teensypp_xxx6_H +#define TLC_Teensypp_xxx6_H + +#if DATA_TRANSFER_MODE == TLC_BITBANG +#error "If you want bitbang mode, insert pin defs here" +#endif + +// MOSI (Teensy++ pin 22) -> SIN (TLC pin 26) +#define TLC_MOSI_PIN 2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +// SCK (Teensy++ pin 21) -> SCLK (TLC pin 25) +#define TLC_SCK_PIN 1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Teensy++ pin 20) +#define TLC_SS_PIN 0 +#define TLC_SS_DDR DDRB + +// OC1A (Teensy++ pin 25) -> XLAT (TLC pin 24) +#define XLAT_PIN 5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +// OC1B (Teensy++ pin 26) -> BLANK (TLC pin 23) +#define BLANK_PIN 6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +// OC2B (Teensy++ pin 1) -> GSCLK (TLC pin 18) +#define GSCLK_PIN 1 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/chip_includes.h b/pinouts/chip_includes.h new file mode 100644 index 0000000..7dc1a6f --- /dev/null +++ b/pinouts/chip_includes.h @@ -0,0 +1,118 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_CHIP_INCLUDES_H +#define TLC_CHIP_INCLUDES_H + +/** \file + Includes the chip-specfic defaults and pin definitions. */ + +#include + +#ifndef PB0 +#define PB0 PORTB0 +#define PB1 PORTB1 +#define PB2 PORTB2 +#define PB3 PORTB3 +#define PB4 PORTB4 +#define PB5 PORTB5 +#define PB6 PORTB6 +#define PB7 PORTB7 +#endif +#ifndef PC0 +#define PC0 PORTC0 +#define PC1 PORTC1 +#define PC2 PORTC2 +#define PC3 PORTC3 +#define PC4 PORTC4 +#define PC5 PORTC5 +#define PC6 PORTC6 +#define PC7 PORTC7 +#endif +#ifndef PD0 +#define PD0 PORTD0 +#define PD1 PORTD1 +#define PD2 PORTD2 +#define PD3 PORTD3 +#define PD4 PORTD4 +#define PD5 PORTD5 +#define PD6 PORTD6 +#define PD7 PORTD7 +#endif +#ifndef PH0 +#define PH0 PORTH0 +#define PH1 PORTH1 +#define PH2 PORTH2 +#define PH3 PORTH3 +#define PH4 PORTH4 +#define PH5 PORTH5 +#define PH6 PORTH6 +#define PH7 PORTH7 +#endif + +/* Chip Specific Pinouts */ +#if defined (__AVR_ATmega168__) \ + || defined (__AVR_ATmega168P__) \ + || defined (__AVR_ATmega88P__) \ + || defined (__AVR_ATmega88__) \ + || defined (__AVR_ATmega48P__) \ + || defined (__AVR_ATmega48__) \ + || defined (__AVR_ATmega328P__) + +/* Diecimila / Duemilanove / almost everything */ +#include "ATmega_xx8.h" + +#elif defined (__AVR_ATmega8__) + +/* ATmega8 */ +#include "ATmega_8.h" + +#elif defined (__AVR_ATmega164P__) \ + || defined (__AVR_ATmega324P__) \ + || defined (__AVR_ATmega644__) \ + || defined (__AVR_ATmega644P__) + +/* Sanguino */ +#include "ATmega_xx4.h" + +#elif defined (__AVR_ATmega640__) \ + || defined (__AVR_ATmega1280__) \ + || defined (__AVR_ATmega1281__) \ + || defined (__AVR_ATmega2560__) \ + || defined (__AVR_ATmega2561__) + +/* Arduino Mega */ +#include "Arduino_Mega.h" + +#elif defined (__AVR_ATmega32U4__) + +/* Teensy 2.0 */ +#include "Teensy_xxU4.h" + +#elif defined (__AVR_AT90USB646__) \ + || defined (__AVR_AT90USB1286__) + +/* Teensy++ 2.0 */ +#include "Teensypp_xxx6.h" + +#else +#error "Unknown Chip!" +#endif + +#endif + diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..03f4edb --- /dev/null +++ b/readme.txt @@ -0,0 +1,717 @@ +-------------------------------------------------------------------------------- +Arduino Light Animation (ALA) 1.1 +-------------------------------------------------------------------------------- + +Arduino Light Animation (ALA) is a library for Arduino boards simplify the +development of light animations using a wide variety of LEDs and LED strips. + +The home page of ALA is: http://yaab-arduino.blogspot.com/p/ala.html + + +-------------------------------------------------------------------------------- +CHANGELOG +-------------------------------------------------------------------------------- + +1.2 (2015-xx-xx) +- Added wiring schemas to some examples +- Fixed AlaLed not working with TLC5940 +- Fixed TLC5940 pins initialization +- Added schematics to some examples + +1.1 (2015-03-12) +- Bouncing balls effect +- Bubbles effect +- Other RGB effects added +- Fixed memory issues for Fire effect +- AlaColor scale method now caps at 255 + +1.0 (2015-03-05) +- First official version of the ALA library + +-------------------------------------------------------------------------------- +INCLUDED LIBRARIES +-------------------------------------------------------------------------------- + +Tlc5940 - https://code.google.com/p/tlc5940arduino/ +Adafruit_NeoPixel - https://github.com/adafruit/Adafruit_NeoPixel + +BIG thanks to the authors. + +-------------------------------------------------------------------------------- +LICENSING INFO +-------------------------------------------------------------------------------- + + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +.