Revision 0:8dc213146b30, committed 2018-05-19

Comitter:

thegink

Date:

Sat May 19 14:27:12 2018 +0000

Commit message:

Initial commit

Changed in this revision

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EEPROM.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,17 @@
+#include "EEPROM.h"
+
+uint8_t EEPROM::eeprom_data[EEPROM_SIZE] = {0};         //initialise to all 0's
+
+uint8_t EEPROM::read(uint32_t address)
+{
+    if (address < EEPROM_SIZE)
+        return eeprom_data[address];
+    
+    return 0;
+}
+
+void EEPROM::update(uint32_t address, uint8_t value)
+{
+    if (address < EEPROM_SIZE)
+        eeprom_data[address] = value;
+}
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EEPROM.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,19 @@
+#ifndef EEPROM_H
+#define EEPROM_H
+
+#include "mbed.h"
+#include "board.h"
+
+class EEPROM
+{
+public:
+    static uint8_t read(uint32_t addr);
+    static void update(uint32_t addr, uint8_t value);
+    
+private:
+    static uint8_t eeprom_data[EEPROM_SIZE];
+
+};
+
+
+#endif
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EffectPlugs.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,33 @@
+#include "EffectPlugs.h"
+
+EffectPlugs::EffectPlugs(uint8_t _num, DigitalInOut *_pins) 
+{
+  num = _num;
+  pins = _pins;
+  
+  for (uint8_t i = 0; i < num; i++) 
+  {
+    pins[i].input();
+    pins[i].mode(PullUp);
+  }
+}
+
+uint8_t EffectPlugs::pluggedConnection() 
+{
+  uint8_t connection = 0, foundConnection = 0;
+  for (uint8_t i = 0; i < num; i++) 
+  {
+    pins[i].output();
+    pins[i].write(0);
+    
+    for (uint8_t j = i + 1; j < num; j++) 
+    {
+      connection++;
+      if (pins[j].read() == 0) 
+        foundConnection = connection;
+    }
+    pins[i].input();
+    pins[i].mode(PullUp);
+  }
+  return foundConnection;
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/EffectPlugs.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,17 @@
+#ifndef EFFECT_PLUGS_H
+#define EFFECT_PLUGS_H
+
+#include "mbed.h"
+#include "board.h"
+
+class EffectPlugs {
+  public:
+    EffectPlugs(uint8_t _num, DigitalInOut *_pins);
+    uint8_t pluggedConnection();
+
+  private:
+    uint8_t num;
+    DigitalInOut* pins;
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Effects.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,237 @@
+#include "Effects.h"
+
+Effects::Effects(LEDs *_leds)
+{
+    lastUpdate = 0;
+    lastEffect = 0;
+    leds = _leds;
+    timer.start();
+}
+
+void Effects::doEffect(uint8_t effect, Rotary::Action action) {
+  uint32_t ms = timer.read_ms();
+
+  switch (effect) {
+    case 1:
+      scroll(ms, action);
+      break;
+    case 3:
+      makeRainbow(effect != lastEffect, ms, action);
+      break;
+    case 2:
+      blink(effect != lastEffect, action);
+      break;
+    case 4:
+      colorChase(ms, action);
+      break;
+    case 5:
+      knightRider(ms);
+      break;
+    case 6:
+      leftRightColorFade(ms, action);
+    default:
+      break;
+  }
+  lastEffect = effect;
+}
+
+void Effects::noEffect() {
+  if (lastEffect == 3) {
+    leds->loadStateFromEEPROMAndDim(0);
+  }
+  lastEffect = 0;
+}
+
+void Effects::scroll(uint32_t ms, Rotary::Action action) {
+  static int8_t MAX_SCROLL_SPEED = 8;
+  static uint16_t SCROLL_SPEED_TO_MS[8] = {
+    500, 400, 300, 200, 150, 100, 66, 33
+  };
+  static int8_t scrollSpeed = 2;
+
+  if (ms > SCROLL_SPEED_TO_MS[abs(scrollSpeed)]) {
+    if (scrollSpeed > 0) leds->scrollStripToRight(); else leds->scrollStripToLeft();
+    timer.reset();
+  }
+  switch (action) {
+    case Rotary::LEFT:
+      if (scrollSpeed > -MAX_SCROLL_SPEED + 1) scrollSpeed--;
+      break;
+    case Rotary::RIGHT:
+      if (scrollSpeed < MAX_SCROLL_SPEED - 1) scrollSpeed++;
+      break;
+    default:
+      break;
+  }
+}
+
+void Effects::knightRider(uint32_t ms) {
+  static uint8_t DELAY = 50;
+  static int8_t position = 0;
+  static int8_t direction = 1;
+
+  for (int8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS; i++) {
+    if      (i == position)                     leds->setStripLEDRGB(i, 200, 0, 0);
+    else if (i == (position - direction))       leds->setStripLEDRGB(i, 100, 0, 0);
+    else if (i == (position - (direction * 2))) leds->setStripLEDRGB(i, 75, 0, 0);
+    else if (i == (position - (direction * 3))) leds->setStripLEDRGB(i, 50, 0, 0);
+    else if (i == (position - (direction * 4))) leds->setStripLEDRGB(i, 25, 0, 0);
+    else leds->setStripLEDRGB(i, 0, 0, 0);
+  }
+  leds->show();
+  if (ms > DELAY) {
+    position += direction;
+    if (position >= LEDS_MAIN_STRIP_NUM_LEDS) {
+      direction = -direction;
+    } else if (position < 0) {
+      direction = -direction;
+    }
+    timer.reset();
+  }
+}
+
+void Effects::blink(bool firstTime, Rotary::Action action) {
+  static uint8_t MAX_BLINK_SPEED = 4;
+  static int8_t blinkSpeed = 1;
+  static int16_t dimAmount = 0;
+  static int8_t direction = 1;
+  if (firstTime) leds->saveStateToEEPROM();           //TODO: Replace this with something else
+  leds->loadStateFromEEPROMAndDim(dimAmount);
+  dimAmount += direction * blinkSpeed * 2;
+  if (dimAmount > 255) {
+    dimAmount = 255;
+    direction = -direction;
+  } else if (dimAmount < 0) {
+    dimAmount = 0;
+    direction = -direction;
+  }
+  switch (action) {
+    case Rotary::LEFT:
+      if (blinkSpeed > 0 ) blinkSpeed--;
+      break;
+    case Rotary::RIGHT:
+      if (blinkSpeed < MAX_BLINK_SPEED) blinkSpeed++;
+      break;
+    default:
+      break;
+  }
+}
+
+void Effects::makeRainbow(bool firstTime, uint32_t ms, Rotary::Action action) {
+  static uint8_t MAX_SPEED = 8;
+  static uint16_t SPEED_TO_MS[8] = {
+    500, 400, 300, 200, 150, 100, 66, 33
+  };
+  static uint8_t speed = 4;
+  static int8_t step = 0;
+  static bool phase2 = false;
+
+  if (firstTime) {
+    step = 0;
+    phase2 = false;
+    speed = 4;
+  }
+  if (ms > SPEED_TO_MS[speed]) {
+    timer.reset();
+    if (step < LEDS_MAIN_STRIP_NUM_LEDS) {
+      for (uint8_t i = 0; i <= step; i++) {
+        if (phase2) {
+          leds->setStripLED(i, 0, 0, 0);
+        } else {
+          leds->setStripLED(i, 255.0 / LEDS_MAIN_STRIP_NUM_LEDS * i, 250, 200);
+        }
+      }
+      step++;
+    } else {
+      phase2 = !phase2;
+      step = 0;
+    }
+  }
+
+  switch (action) {
+    case Rotary::LEFT:
+      if (speed > 0 ) speed--;
+      break;
+    case Rotary::RIGHT:
+      if (speed < MAX_SPEED - 1) speed++;
+      break;
+    default:
+      break;
+  }
+}
+
+void Effects::colorChase(uint32_t ms, Rotary::Action action) {
+  static uint8_t DELAY_MS = 200;
+  static uint8_t COLOR_STEPS = 6;
+  static uint8_t step = 0;
+  static uint8_t colorStep = 0;
+
+  if (ms > DELAY_MS) {
+    timer.reset();
+    if (step > 0) leds->setStripLED(step - 1, 0, 0, 0);
+    if (step < LEDS_MAIN_STRIP_NUM_LEDS) {
+      leds->setStripLED(step, 255.0 / COLOR_STEPS * colorStep, 250, 200);
+      step++;
+    } else {
+      colorStep++;
+      if (colorStep >= COLOR_STEPS) colorStep = 0;
+      step = 0;
+    }
+  }
+
+  switch (action) {
+    case Rotary::LEFT:
+      if (step > 0) step--;
+      leds->scrollStripToLeft();
+      break;
+    case Rotary::RIGHT:
+      if (step < LEDS_MAIN_STRIP_NUM_LEDS) step++;
+      leds->scrollStripToRight();
+      break;
+    default:
+      break;
+  }
+}
+
+void Effects::leftRightColorFade(uint32_t ms, Rotary::Action action) {
+  static uint8_t DELAY_MS = 50;
+  static uint8_t COLOR_STEPS = 8;
+  static uint8_t center = LEDS_MAIN_STRIP_NUM_LEDS / 2;
+  static uint8_t step = 0;
+  static uint8_t colorStep = 0;
+  static bool turnOff = false;
+
+  if (ms > DELAY_MS) {
+    timer.reset();
+    for (uint8_t i = 0; i < step; i++) {
+      if (i <= center) {
+        leds->setStripLED(center - i, 255.0 / COLOR_STEPS * colorStep, 200, turnOff ? 0 : 200);
+      }
+      if (center + i < LEDS_MAIN_STRIP_NUM_LEDS) {
+        leds->setStripLED(center + i, 255.0 / COLOR_STEPS * colorStep, 200, turnOff ? 0 : 200);
+      }
+    }
+    leds->setStripLED(center, 0, 0, 200);
+    if (step > center && center + step >= LEDS_MAIN_STRIP_NUM_LEDS) {
+      step = 0;
+      if (turnOff) {
+        colorStep++;
+        if (colorStep == COLOR_STEPS) colorStep = 0;
+      }
+      turnOff = !turnOff;
+    } else {
+      step++;
+    }
+  }
+
+  switch (action) {
+    case Rotary::LEFT:
+      if (center > 5) center--;
+      break;
+    case Rotary::RIGHT:
+      if (center < 9) center++;
+      break;
+    default:
+      break;
+  }
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Effects.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,28 @@
+#ifndef EFFECTS_H
+#define EFFECTS_H
+
+#include "mbed.h"
+#include "LEDs.h"
+#include "Rotary.h"
+
+class Effects {
+  public:
+    Effects(LEDs *_leds);
+    void doEffect(uint8_t effect, Rotary::Action action);
+    void noEffect();
+
+  private:
+    void scroll(uint32_t ms, Rotary::Action action);
+    void knightRider(uint32_t ms);
+    void blink(bool firstTime, Rotary::Action action);
+    void makeRainbow(bool firstTime, uint32_t ms, Rotary::Action action);
+    void colorChase(uint32_t ms, Rotary::Action action);
+    void leftRightColorFade(uint32_t ms, Rotary::Action action);
+
+    LEDs *leds;
+    uint32_t lastUpdate;
+    uint8_t lastEffect;
+    Timer timer;
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/InteractionTimeout.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,14 @@
+#include "InteractionTimeout.h"
+
+InteractionTimeout::InteractionTimeout(uint16_t seconds) {
+  timeoutSeconds = seconds;
+  timer.start();
+}
+
+void InteractionTimeout::reset() {
+  timer.reset();
+}
+
+bool InteractionTimeout::timedOut() {
+  return (timer.read_ms() / 1000) > timeoutSeconds;
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/InteractionTimeout.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,17 @@
+#ifndef INTERACTION_TIMEOUT_H
+#define INTERACTION_TIMEOUT_H
+
+#include "mbed.h"
+
+class InteractionTimeout {
+  public:
+    InteractionTimeout(uint16_t _seconds);
+    void reset();
+    bool timedOut();
+
+  private:
+    uint16_t timeoutSeconds;
+    Timer timer;
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LEDs.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,230 @@
+#include "LEDs.h"
+
+LEDs::LEDs(PinName main, PinName single):
+    mainStrip(main),
+    singleStrip(single)
+{
+  currentIndex = 0;
+}
+
+void LEDs::updateSingleLED(uint8_t colorH, uint8_t colorS, uint8_t colorV) {
+  hsv_color hsv = {colorH, colorS, colorV};
+  for (uint8_t i=0; i < LEDS_SINGLE_STRIP_NUM_LEDS; i++)
+    singleColours[i] = HsvToRgb(hsv);
+  show();
+}
+
+void LEDs::updateStripLED(uint8_t index, uint8_t colorH, uint8_t colorS, uint8_t colorV) {
+hsv_color hsv = {colorH, colorS, colorV};
+  uint8_t stripIndex = LEDS_MAIN_STRIP_TOGGLE_OFFSET + index;
+  mainColours[stripIndex] = HsvToRgb(hsv);
+  show();
+}
+
+void LEDs::setStripLEDRGB(uint8_t index, uint8_t colorR, uint8_t colorG, uint8_t colorB) {
+  rgb_color rgb = {colorR, colorG, colorB};
+  mainColours[index] = rgb;
+}
+
+
+void LEDs::setStripLED(uint8_t index, uint8_t colorH, uint8_t colorS, uint8_t colorV) {
+  hsv_color hsv = {colorH, colorS, colorV};
+  mainColours[index] = HsvToRgb(hsv);
+}
+
+void LEDs::turnOffStripLED(uint8_t index) {
+  uint8_t stripIndex = LEDS_MAIN_STRIP_TOGGLE_OFFSET + index;
+  rgb_color rgb = {0,0,0};
+  mainColours[stripIndex] = rgb;
+  show();
+}
+
+bool LEDs::isStripLEDOn(uint8_t index) {
+  uint8_t stripIndex = LEDS_MAIN_STRIP_TOGGLE_OFFSET + index;
+  return mainColours[stripIndex].red != 0 || mainColours[stripIndex].green != 0 || mainColours[stripIndex].blue != 0;
+}
+
+void LEDs::scrollStripToLeft() {
+  rgb_color first = mainColours[0];
+  for (uint8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS - 1; i++) {
+    mainColours[i] = mainColours[i + 1];
+  }
+  mainColours[LEDS_MAIN_STRIP_NUM_LEDS - 1] = first;
+}
+
+void LEDs::scrollStripToRight() {
+  rgb_color last = mainColours[LEDS_MAIN_STRIP_NUM_LEDS - 1];
+  for (uint8_t i = LEDS_MAIN_STRIP_NUM_LEDS - 1; i > 0; i--) {
+    mainColours[i] = mainColours[i - 1];
+  }
+  mainColours[0] = last;
+}
+
+void LEDs::show() {
+  mainStrip.write(mainColours, LEDS_MAIN_STRIP_NUM_LEDS);
+  singleStrip.write(singleColours, LEDS_SINGLE_STRIP_NUM_LEDS);
+}
+
+void LEDs::off() {
+  
+  rgb_color black = {0,0,0};
+  
+  for (uint8_t j = 0; j < 10; j++) {
+    for (uint8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS; i++) 
+    {
+        fadeToBlackBy(64,mainColours[i]);
+    }
+    
+    for (uint8_t i = 0; i < LEDS_SINGLE_STRIP_NUM_LEDS; i++)
+    {
+        fadeToBlackBy(64, singleColours[i]);
+    }
+    
+    show();
+    wait_ms(50);
+  }
+
+  for (uint8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS; i++) {
+    mainColours[i] = black;
+  }
+  for (uint8_t i = 0; i < LEDS_SINGLE_STRIP_NUM_LEDS; i++) {
+    singleColours[i] = black;
+  }
+  
+  show();
+}
+
+rgb_color LEDs::HsvToRgb(hsv_color hsv)
+{
+    rgb_color rgb;
+    unsigned char region, p, q, t;
+    unsigned int h, s, v, remainder;
+
+    if (hsv.s == 0)
+    {
+        rgb.red = hsv.v;
+        rgb.green = hsv.v;
+        rgb.blue = hsv.v;
+        return rgb;
+    }
+
+    // converting to 16 bit to prevent overflow
+    h = hsv.h;
+    s = hsv.s;
+    v = hsv.v;
+
+    region = h / 43;
+    remainder = (h - (region * 43)) * 6; 
+
+    p = (v * (255 - s)) >> 8;
+    q = (v * (255 - ((s * remainder) >> 8))) >> 8;
+    t = (v * (255 - ((s * (255 - remainder)) >> 8))) >> 8;
+
+    switch (region)
+    {
+        case 0:
+            rgb.red = v;
+            rgb.green = t;
+            rgb.blue = p;
+            break;
+        case 1:
+            rgb.red = q;
+            rgb.green = v;
+            rgb.blue = p;
+            break;
+        case 2:
+            rgb.red = p;
+            rgb.green = v;
+            rgb.blue = t;
+            break;
+        case 3:
+            rgb.red = p;
+            rgb.green = q;
+            rgb.blue = v;
+            break;
+        case 4:
+            rgb.red = t;
+            rgb.green = p;
+            rgb.blue = v;
+            break;
+        default:
+            rgb.red = v;
+            rgb.green = p;
+            rgb.blue = q;
+            break;
+    }
+
+    return rgb;
+}
+
+hsv_color LEDs::RgbToHsv(rgb_color rgb)
+{
+    hsv_color hsv;
+    unsigned char rgbMin, rgbMax;
+
+    rgbMin = rgb.red < rgb.green ? (rgb.red < rgb.blue ? rgb.red : rgb.blue) : (rgb.green < rgb.blue ? rgb.green : rgb.blue);
+    rgbMax = rgb.red > rgb.green ? (rgb.red > rgb.blue ? rgb.red : rgb.blue) : (rgb.green > rgb.blue ? rgb.green : rgb.blue);
+
+    hsv.v = rgbMax;
+    if (hsv.v == 0)
+    {
+        hsv.h = 0;
+        hsv.s = 0;
+        return hsv;
+    }
+
+    hsv.s = 255 * ((long)(rgbMax - rgbMin)) / hsv.v;
+    if (hsv.s == 0)
+    {
+        hsv.h = 0;
+        return hsv;
+    }
+
+    if (rgbMax == rgb.red)
+        hsv.h = 0 + 43 * (rgb.green - rgb.blue) / (rgbMax - rgbMin);
+    else if (rgbMax == rgb.green)
+        hsv.h = 85 + 43 * (rgb.blue - rgb.red) / (rgbMax - rgbMin);
+    else
+        hsv.h = 171 + 43 * (rgb.red - rgb.green) / (rgbMax - rgbMin);
+
+    return hsv;
+}
+
+void LEDs::saveStateToEEPROM() {
+  for (uint8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS; i++) 
+  {
+    eeprom.update(i * 3 + 0, mainColours[i].red);
+    eeprom.update(i * 3 + 1, mainColours[i].green);
+    eeprom.update(i * 3 + 2, mainColours[i].blue);
+  }
+}
+
+void LEDs::loadStateFromEEPROM() {
+  for (int16_t j = 255; j > 0; j -= 26) 
+  {
+    loadStateFromEEPROMAndDim(j);
+    wait_ms(30);
+  }
+  loadStateFromEEPROMAndDim(0);
+}
+
+void LEDs::loadStateFromEEPROMAndDim(uint8_t dimAmount) {
+  for (uint8_t i = 0; i < LEDS_MAIN_STRIP_NUM_LEDS; i++) {
+    mainColours[i].red = eeprom.read(i * 3 + 0);
+    mainColours[i].green = eeprom.read(i * 3 + 1);
+    mainColours[i].blue = eeprom.read(i * 3 + 2);
+    fadeToBlackBy(dimAmount, mainColours[i]);
+  }
+  show();
+}
+
+void LEDs::fadeToBlackBy(uint8_t amount, rgb_color& colour)
+{
+    //fades colour by 'amount' 256ths
+    if (amount)
+    {
+        colour.red = (uint8_t)(((uint16_t)colour.red * (uint16_t)amount + 128)/256);
+        colour.green = (uint8_t)(((uint16_t)colour.green * (uint16_t)amount + 128)/256);
+        colour.blue = (uint8_t)(((uint16_t)colour.blue * (uint16_t)amount + 128)/256);
+    }
+}
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LEDs.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,48 @@
+#ifndef LEDS_H
+#define LEDS_H
+
+#include "mbed.h"
+#include "board.h"
+#include "EEPROM.h"
+#include "PololuLedStrip.h"
+
+#define LEDS_MAIN_STRIP_TOGGLE_OFFSET 5
+
+typedef struct hsv_color
+{
+    unsigned char h;
+    unsigned char s;
+    unsigned char v;
+} hsv_color;
+
+class LEDs {
+  public:
+    LEDs(PinName main, PinName single);
+    void updateSingleLED(uint8_t colorH, uint8_t colorS, uint8_t colorV);
+    void updateStripLED(uint8_t index, uint8_t colorH, uint8_t colorS, uint8_t colorV);
+    void setStripLED(uint8_t index, uint8_t colorH, uint8_t colorS, uint8_t colorV);
+    void setStripLEDRGB(uint8_t index, uint8_t colorH, uint8_t colorS, uint8_t colorV);
+    void turnOffStripLED(uint8_t index);
+    bool isStripLEDOn(uint8_t index);
+    void scrollStripToLeft();
+    void scrollStripToRight();
+    void off();
+    void show();
+    void saveStateToEEPROM();
+    void loadStateFromEEPROM();
+    void loadStateFromEEPROMAndDim(uint8_t dimAmount);
+    void fadeToBlackBy(uint8_t amount, rgb_color& colour);
+    rgb_color mainColours[LEDS_MAIN_STRIP_NUM_LEDS];
+    rgb_color singleColours[LEDS_SINGLE_STRIP_NUM_LEDS];
+  private:
+    hsv_color RgbToHsv(rgb_color rgb);
+    rgb_color HsvToRgb(hsv_color hsv);
+  
+    PololuLedStrip mainStrip;
+    PololuLedStrip singleStrip;
+    
+    uint8_t currentIndex;
+    EEPROM eeprom;
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/LICENSE	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,674 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ 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.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    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 <http://www.gnu.org/licenses/>.
+
+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:
+
+    <program>  Copyright (C) <year>  <name of author>
+    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
+<http://www.gnu.org/licenses/>.
+
+  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
+<http://www.gnu.org/philosophy/why-not-lgpl.html>.

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Makefile	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,16 @@
+TARGET        = Lichtspiel
+ARDMK_DIR     = /usr/local/opt/arduino-mk
+MONITOR_PORT  = /dev/cu.usbmodem1421
+
+ISP_PROG	   = stk500v1
+ISP_PORT     = /dev/cu.usbmodem1421
+AVRDUDE_ISP_BAUDRATE = 57600
+
+BOARD_TAG     = uno
+ARDUINO_QUIET = 1
+ARDUINO_LIBS = EEPROM FastLED
+
+CPPFLAGS = -DDEV
+
+include ${ARDMK_DIR}/Arduino.mk
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/PololuLedStrip.lib	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,1 @@
+https://os.mbed.com/users/thegink/code/PololuLedStrip/#9a62663f3de2

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Pulser.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,31 @@
+#include "Pulser.h"
+
+Pulser::Pulser(PinName _pin):
+out(_pin)
+{
+  lastUpdate = 0;
+  value = 65535;
+  direction = -256;
+  timer.start();
+}
+
+void Pulser::pulse() {
+  uint32_t now = timer.read_ms();
+  while (now - lastUpdate > delay) {
+    lastUpdate += delay;
+    value += direction;
+    if (value >= 69120 || value <= 53760) direction = -direction;
+  }
+  if (value < 65535) out.write_u16(value);
+}
+
+void Pulser::steady() {
+  out.write_u16(32768);
+}
+
+void Pulser::off() {
+  out.write_u16(0);
+  value = 65535;
+  direction = -256;
+  lastUpdate = timer.read_ms();
+}

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Pulser.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,21 @@
+#ifndef PULSER_H
+#define PULSER_H
+
+#include "mbed.h"
+
+class Pulser {
+  public:
+    Pulser(PinName _pin);
+    void pulse();
+    void steady();
+    void off();
+  private:
+    static const uint8_t delay = 30;
+    uint32_t value;
+    int16_t direction;
+    uint32_t lastUpdate;
+    AnalogOut out;
+    Timer timer;
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,13 @@
+This is the mbed port of the software for the “Lichtspiel”, an Arduino-based device which Stefan made as a birthday present for his niece, and I made for my son. Read more about the original LichtSpiel here: https://noniq.at/0017/the-lichtspiel/
+
+
+TODO: 
+- Buttons change colour of single-colour pattern
+- Pulse Single LED strip, not Standby LED
+- More patterns?
+- Better HSV-> RGB conversion
+
+DONE:
+- Any input wakes from standby
+- LED Strip driver - support GRB strips while keeping colour in rgb order
+

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Rotary.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,28 @@
+#ifndef ROTARY_H
+#define ROTARY_H
+
+#include "mbed.h"
+
+class Rotary {
+  public:
+    enum Action {
+      NONE, LEFT, RIGHT, TIMEOUT
+    };
+
+#ifdef DEV
+		static const uint32_t TIMEOUT_MILLIS = 20 * 1000UL;
+#else
+		static const uint32_t TIMEOUT_MILLIS = 120 * 1000UL;
+#endif
+
+    Rotary(PinName _pinA, PinName _pinB);
+    Action read();
+    Action waitForAction();
+
+  private:
+    uint8_t _prevPos, _flags;
+    DigitalIn pinA, pinB;
+    uint8_t readEnc();
+};
+
+#endif

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/board.h	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,31 @@
+#ifndef BOARD_H
+#define BOARD_H
+
+
+static const PinName BUTTON_PINS[] = {p21, p22, p23, p24, p25};
+static const uint8_t NUM_BUTTONS = sizeof(BUTTON_PINS)/sizeof(BUTTON_PINS[0]);
+
+static const PinName ANALOG_H_IN_PIN = p15;
+static const PinName ANALOG_S_IN_PIN = p16;
+static const PinName ANALOG_V_IN_PIN = p17;
+static const PinName STANDBY_BUTTON_LED_PIN = p18;
+static const PinName STANDBY_BUTTON_PIN = p26;
+static const PinName EFFECT_PLUGS_PINS[] = {p5, p6, p7, p8};    //p9, p10};
+static const uint8_t NUM_EFFECT_PLUGS = sizeof(EFFECT_PLUGS_PINS)/sizeof(EFFECT_PLUGS_PINS[0]);
+
+static const PinName LEDS_SINGLE_STRIP_PIN = p20;
+static const uint8_t LEDS_SINGLE_STRIP_NUM_LEDS = 3;
+static const PinName LEDS_MAIN_STRIP_PIN = p19;
+static const uint8_t LEDS_MAIN_STRIP_NUM_LEDS = 15;
+
+
+static const PinName ROTARY_PIN_A = p29;
+static const PinName ROTARY_PIN_B = p30;
+
+static const uint32_t EEPROM_SIZE = 256;
+
+
+
+
+
+#endif
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/lichtspiel.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,336 @@
+#include "mbed.h"
+#include "EffectPlugs.h"
+#include "Effects.h"
+#include "InteractionTimeout.h"
+#include "LEDs.h"
+#include "Rotary.h"
+#include "Pulser.h"
+#include "board.h"
+
+//#define DEV
+
+#ifdef DEV
+static const uint16_t INTERACTION_TIMEOUT_SECONDS = 60;
+#define DEBUG(...); pc.printf(__VA_ARGS__);
+#else
+static const uint16_t INTERACTION_TIMEOUT_SECONDS = 180;
+#define DEBUG(...);
+#endif
+
+
+bool standBy = false;
+uint8_t lastButtonState[NUM_BUTTONS] = {1,1,1,1,1};
+bool buttonIsUpdatingLED[NUM_BUTTONS] = {false,false,false,false,false};
+
+// Generated with Ruby: (0..255).map{|i| (64 + (256 - 64) / 256.0 * i).round }.join(',')
+uint8_t mapS[256] = {
+  64,65,66,66,67,68,69,69,70,71,72,72,73,74,75,75,
+  76,77,78,78,79,80,81,81,82,83,84,84,85,86,87,87,
+  88,89,90,90,91,92,93,93,94,95,96,96,97,98,99,99,
+  100,101,102,102,103,104,105,105,106,107,108,108,
+  109,110,111,111,112,113,114,114,115,116,117,117,
+  118,119,120,120,121,122,123,123,124,125,126,126,
+  127,128,129,129,130,131,132,132,133,134,135,135,
+  136,137,138,138,139,140,141,141,142,143,144,144,
+  145,146,147,147,148,149,150,150,151,152,153,153,
+  154,155,156,156,157,158,159,159,160,161,162,162,
+  163,164,165,165,166,167,168,168,169,170,171,171,
+  172,173,174,174,175,176,177,177,178,179,180,180,
+  181,182,183,183,184,185,186,186,187,188,189,189,
+  190,191,192,192,193,194,195,195,196,197,198,198,
+  199,200,201,201,202,203,204,204,205,206,207,207,
+  208,209,210,210,211,212,213,213,214,215,216,216,
+  217,218,219,219,220,221,222,222,223,224,225,225,
+  226,227,228,228,229,230,231,231,232,233,234,234,
+  235,236,237,237,238,239,240,240,241,242,243,243,
+  244,245,246,246,247,248,249,249,250,251,252,252,253,254,255,255
+};
+
+// Generated with Ruby: (0..255).map{|i| (i / 2.0 + 48).round }.join(',')
+uint8_t mapV[256] = {
+  32,33,33,34,34,35,36,36,37,37,38,39,39,40,40,41,
+  42,42,43,43,44,45,45,46,46,47,48,48,49,50,50,51,
+  51,52,53,53,54,54,55,56,56,57,57,58,59,59,60,60,
+  61,62,62,63,63,64,65,65,66,66,67,68,68,69,69,70,
+  71,71,72,72,73,74,74,75,75,76,77,77,78,78,79,80,
+  80,81,82,82,83,83,84,85,85,86,86,87,88,88,89,89,
+  90,91,91,92,92,93,94,94,95,95,96,97,97,98,98,99,
+  100,100,101,101,102,103,103,104,104,105,106,106,
+  107,107,108,109,109,110,110,111,112,112,113,114,
+  114,115,115,116,117,117,118,118,119,120,120,121,
+  121,122,123,123,124,124,125,126,126,127,127,128,
+  129,129,130,130,131,132,132,133,133,134,135,135,
+  136,136,137,138,138,139,139,140,141,141,142,142,
+  143,144,144,145,146,146,147,147,148,149,149,150,
+  150,151,152,152,153,153,154,155,155,156,156,157,
+  158,158,159,159,160,161,161,162,162,163,164,164,
+  165,165,166,167,167,168,168,169,170,170,171,171,
+  172,173,173,174,174,175,176,176,177,178,178,179,
+  179,180,181,181,182,182,183,184,184,185,185,186
+};
+
+uint8_t lastH, lastS, lastV, lastEffect;
+
+DigitalInOut effectsPins[NUM_EFFECT_PLUGS] = {DigitalInOut(EFFECT_PLUGS_PINS[0]),
+                                                DigitalInOut(EFFECT_PLUGS_PINS[1]),
+                                                DigitalInOut(EFFECT_PLUGS_PINS[2]),
+                                                DigitalInOut(EFFECT_PLUGS_PINS[3])};
+
+DigitalIn buttons[NUM_BUTTONS] = {DigitalIn(BUTTON_PINS[0], PullUp),
+                                    DigitalIn(BUTTON_PINS[1], PullUp),
+                                    DigitalIn(BUTTON_PINS[2], PullUp),
+                                    DigitalIn(BUTTON_PINS[3], PullUp),
+                                    DigitalIn(BUTTON_PINS[4], PullUp)};
+
+InteractionTimeout interactionTimeout(INTERACTION_TIMEOUT_SECONDS);
+Rotary rotary(ROTARY_PIN_A, ROTARY_PIN_B);
+Rotary::Action action;
+LEDs leds(LEDS_MAIN_STRIP_PIN, LEDS_SINGLE_STRIP_PIN);
+Pulser standBySwitchPulser(STANDBY_BUTTON_LED_PIN);
+EffectPlugs effectPlugs(4, effectsPins);
+Effects effects(&leds);
+
+DigitalIn StdbyButton(STANDBY_BUTTON_PIN, PullUp);
+AnalogIn ainH(ANALOG_H_IN_PIN);
+AnalogIn ainS(ANALOG_S_IN_PIN);
+AnalogIn ainV(ANALOG_V_IN_PIN);
+Serial pc(USBTX, USBRX);
+
+void setup() {
+  DEBUG("INIT");
+  
+  lastH = 0;
+  lastS = 0;
+  lastV = 0;
+  lastEffect = 0;
+  leds.off();
+}
+
+bool buttonPressed(uint8_t index) {
+  uint8_t state = buttons[index].read();
+  if (state == 0 && lastButtonState[index] == 1) {
+    lastButtonState[index] = 0;
+    return true;
+  };
+  lastButtonState[index] = state;
+  return false;
+}
+
+bool buttonDown(uint8_t index) {
+  uint8_t state = buttons[index].read();
+  return state == 0;
+}
+
+bool standByButtonPressed() {
+  static uint8_t lastState;
+  uint8_t state = StdbyButton.read();
+  if (state == 0 && lastState == 1) {
+    lastState = 0;
+    return true;
+  }
+  lastState = state;
+  return false;
+}
+
+void enterStandBy() {
+  standBySwitchPulser.off(); // Turn off pulser while writing LED state to EEPROM.
+  leds.saveStateToEEPROM();
+  leds.off();
+  standBy = true;
+}
+
+void leaveStandBy() {
+  leds.loadStateFromEEPROM();
+  standBySwitchPulser.steady();
+  standBy = false;
+  interactionTimeout.reset();
+}
+
+void dev_loop()
+{
+    static uint8_t old_h = 0, old_s = 0, old_v = 0;
+    
+    uint8_t h = ainH.read_u16() >> 8;
+    uint8_t s = ainS.read_u16() >> 8;
+    uint8_t v = ainV.read_u16() >> 8;
+    
+    if (h != old_h)
+    {
+        DEBUG("\r\nH: %u", h);
+        old_h = h;
+    }
+    
+    if (s != old_s)
+    {
+        DEBUG("\r\nS: %u", s);
+        old_s = s;
+    }
+    
+    if (v != old_v)
+    {
+        DEBUG("\r\nV: %u", v);
+        old_v = v;
+    }
+    
+    
+    for (uint8_t i = 0; i < NUM_BUTTONS; i++) 
+    {
+        if (buttonPressed(i)) 
+        {
+            DEBUG("\r\nButton %u Pressed", i);
+        }
+        
+        if (buttonDown(i)) 
+        {
+            DEBUG("\r\nButton %u Down", i);
+        }
+    }
+    
+    static uint8_t old_connection = 0;
+    
+    uint8_t connection = effectPlugs.pluggedConnection();
+    
+    if (connection != old_connection)
+    {
+        DEBUG("Connection %u made", connection);
+        old_connection = connection;
+    }    
+    
+    action = rotary.read();
+    
+    if (action != Rotary::NONE)
+    {
+        DEBUG("Rotary action: %u", action);
+    }
+    
+    static uint8_t hue = 0;
+    
+    leds.updateSingleLED(hue++, 127, 127);
+    effects.doEffect(2, Rotary::NONE);
+    
+    wait_ms(10);
+}
+
+void loop() 
+{
+    if (standBy) 
+    {
+        standBySwitchPulser.pulse();
+   
+        if (standByButtonPressed()) 
+        {
+            leaveStandBy();
+            return;
+        }
+
+        Rotary::Action act = rotary.read();
+
+        if ((act == Rotary::LEFT) || (act == Rotary::RIGHT))
+        {
+            leaveStandBy();
+            return;
+        }
+        
+        for (uint8_t i = 0; i < NUM_BUTTONS; i++) 
+        {
+            if (buttonPressed(i)) 
+            {
+                leaveStandBy();
+                return;
+            }
+        }
+        
+        if (lastEffect != effectPlugs.pluggedConnection())
+        {
+            leaveStandBy();
+            return;
+        }
+    } 
+    else 
+    {
+        uint8_t h = ainH.read_u16() >> 8;
+        uint8_t s = (ainS.read_u16() >> 8);
+        uint8_t v = (ainV.read_u16() >> 8);
+        leds.updateSingleLED(h, mapS[s], mapV[v]);
+        
+        if (abs(h - lastH) > 2 || abs(s - lastS) > 2 || abs(v - lastV) > 2) 
+        {
+            interactionTimeout.reset();
+            lastH = h;
+            lastS = s;
+            lastV = v;
+        }
+    
+        for (uint8_t i = 0; i < NUM_BUTTONS; i++) 
+        {
+            if (buttonPressed(i)) 
+                buttonIsUpdatingLED[i] = !leds.isStripLEDOn(i);
+          
+            if (buttonDown(i)) 
+            {
+                if (buttonIsUpdatingLED[i]) 
+                {
+                    leds.updateStripLED(i, h, mapS[s], mapV[v]);
+                } 
+                else 
+                {
+                    leds.turnOffStripLED(i);
+                }
+                
+                interactionTimeout.reset();
+            }
+        }
+    
+        uint8_t chosenEffect = effectPlugs.pluggedConnection();
+        
+        if (lastEffect != chosenEffect)
+        {
+            lastEffect = chosenEffect;
+        }
+        
+        action = rotary.read();
+        if (chosenEffect) 
+        {
+            effects.doEffect(chosenEffect, action);
+        } 
+        else 
+        {
+            effects.noEffect();
+            switch (action) 
+            {
+                case Rotary::LEFT:
+                    leds.scrollStripToLeft();
+                break;
+            
+                case Rotary::RIGHT:
+                    leds.scrollStripToRight();
+                break;
+            
+                default:
+                break;
+            }
+        }
+        
+        if (action != Rotary::NONE) 
+            interactionTimeout.reset();
+    
+        if (interactionTimeout.timedOut()) 
+            enterStandBy();
+    }
+}
+
+int main(void)
+{
+    setup();
+    
+    while (1)
+    {
+        #ifdef DEV
+        dev_loop();
+        #else
+        loop();
+        #endif
+    }
+    
+    return 0;
+}
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed.bld	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,1 @@
+http://mbed.org/users/mbed_official/code/mbed/builds/994bdf8177cb
\ No newline at end of file

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/rotary.cpp	Sat May 19 14:27:12 2018 +0000
@@ -0,0 +1,68 @@
+#include "Rotary.h"
+
+#define bit_is_set(var, ofs) (((var) & (1<<(ofs))) == (1<<(ofs)))
+
+
+uint8_t Rotary::readEnc() {
+  return (pinA.read() == 1 ? 0b01 : 0b00) | (pinB.read() == 1 ? 0b10 : 0b00);
+}
+
+Rotary::Rotary(PinName _pinA, PinName _pinB):
+    pinA(_pinA, PullUp),
+    pinB(_pinB, PullUp)
+{
+  _prevPos = readEnc();
+  _flags = 0;
+}
+
+Rotary::Action Rotary::read() {
+  Action action = NONE;
+  uint8_t curPos = readEnc();
+
+  if (curPos != _prevPos) {
+
+    if (_prevPos == 0b00) {
+      if (curPos == 0b01 || curPos == 0b10) { // First edge
+        _flags |= curPos;
+      }
+    }
+
+    if (curPos == 0b11) { // “Middle” of a step
+      _flags |= 0b10000;
+    } else if (curPos == 0b00) { // Final edge
+      if (_prevPos == 0b10) {
+        _flags |= 0b00100;
+      } else if (_prevPos == 0b01) {
+        _flags |= 0b01000;
+      }
+
+      // check the first and last edge
+      // or maybe one edge is missing, if missing then require the middle state
+      // this will reject bounces and false movements
+      if (bit_is_set(_flags, 0) && (bit_is_set(_flags, 2) || bit_is_set(_flags, 4))) {
+        action = RIGHT;
+      }
+      else if (bit_is_set(_flags, 2) && (bit_is_set(_flags, 0) || bit_is_set(_flags, 4))) {
+        action = RIGHT;
+      }
+      else if (bit_is_set(_flags, 1) && (bit_is_set(_flags, 3) || bit_is_set(_flags, 4))) {
+        action = LEFT;
+      }
+      else if (bit_is_set(_flags, 3) && (bit_is_set(_flags, 1) || bit_is_set(_flags, 4))) {
+        action = LEFT;
+      }
+
+      _flags = 0;
+    }
+  }
+  _prevPos = curPos;
+  return action;
+}
+
+Rotary::Action Rotary::waitForAction() {
+  Action action;
+  Timer time;
+  time.start();
+  while ((action = read()) == NONE && time.read_ms() < TIMEOUT_MILLIS);
+  return (action == NONE ? TIMEOUT : action);
+}