]> oss.titaniummirror.com Git - rgblamp.git/blobdiff - main.c
Add README
[rgblamp.git] / main.c
diff --git a/main.c b/main.c
index c258972d20e9717696c8df660d9aa42fe502fef0..6eaf3d77159fdcfe566e85dbf2f7b2ec06a77aa1 100644 (file)
--- a/main.c
+++ b/main.c
@@ -1,3 +1,32 @@
+/*
+ * Copyright © 2011, 2012, Titanium Mirror, Inc..
+ * All Rights Reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ * - Neither the name of Titanium Mirror, Inc. nor the names of its
+ *   contributors may be used to endorse or promote products derived from
+ *   this software without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
+ * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
+ * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
 /*
  * File:   main.c
  *
@@ -38,6 +67,7 @@
 #include <stdlib.h>
 #include "picinit.h"
 #include "unused.h"
+#include "lfsr.h"
 #include "btn.h"
 #include "rgb.h"
 #include "tmr.h"
 #include "task.h"
 #include "adc_random.h"
 
-#if 1
-#define AUTO_OFF_COUNT   450  /* 15 mins on*/
-#define AUTO_ON_COUNT    1350 /* 45 mins off */
-#else
 #define AUTO_OFF_COUNT   9000U  /*  5 hrs in 2 sec units */
 #define AUTO_ON_COUNT    34200U /* 19 hrs in 2 sec units */
-#endif
 #define dbgpin_init()    do { \
                              /* Set RA2 as output low */ \
                              RA2 = 0; \
 #define dbgpin_toggle()  (RA2 = (LATA2 == 0) ? 1 : 0)
 
 enum {
-  HELD_TMR_PERIODS = 1,  /* Held timer fires every 32.768 msec */
-  HELD_PERIODS = 16,     /* Held this long before held events fire */
-  COLOR_WHITE = 0,
-  COLOR_COUNT = 19,
-  BRIGHT_TOP = 100,
-  BRIGHT_BOTTOM = -5,
-  BRIGHT_MAX = 85,
-  BRIGHT_MIN = 1,
-  BRIGHT_INIT = 42, /* later, get from eeprom */
-
-  MODE_SOLID = 0,
-  //MODE_CANDLE,
-  MODE_FADE,
-  MODE_PARTY,
+  /* Operating modes */
+  MODE_SOLID = 0,        /* Cycle through colors[][] before next mode */
+  MODE_CYCLE,             /* Auto cycle through colors */
+  MODE_PARTY,            /* Random yet fast incolor and fade */
   MODE_COUNT,
 
+  /* Indexes in colors[][] for LEDs */
   LED_RED = 0,
   LED_GRN,
   LED_BLU,
   LED_WHT,
   LED_COUNT,
+
+  HELD_TMR_PERIODS = 1,  /* Held timer fires every 32.768 msec */
+  HELD_PERIODS = 16,     /* Held this long before held events fire */
+  COLOR_COUNT = 12,
+  COLOR_CANDLE = 0,      /* Color index for the candle color */
+  COLOR_WHITE = 11,      /* Color index for white */
+  BRIGHT_TOP = 100,      /* Bright ramps up to top ... */
+  BRIGHT_BOTTOM = -5,    /* ... then down to bottom */
+  BRIGHT_MAX = 85,       /* Bright values are constrained for computations */
+  BRIGHT_MIN = 1,        /* ... by min and max. */
+  BRIGHT_INIT = 42,      /* Initial value is replaced by value from eeprom */
+  CBRIGHT_VARIANCE = 20, /* Brightness range for candle flicker */
+  STD_FADE = 16,         /* Fade time in 32.768 ms units */
+  STD_INCOLOR = 29491,   /* Time in color when MODE_CYCLE, in 32.768 ms units */
+  PARTY_MIN = 8,         /* Min party fade and incolor units */
+  PARTY_RANGE = 8,       /* Party fade/incolor range mask for lfsr_get() */
+                         /* ... see start_fade() */
+  CFG_ADDR = 0,          /* EEPROM address of start of configuration */
+  CFG_DELAY = 183,        /* 6 seconds in 32.768 msec units */
 };
 
 typedef struct {
@@ -91,102 +126,126 @@ typedef struct {
   signed char remainder;
 } led_t;
 
-/* 18 available colors plus white, 2 bits per color, no white mix */
+/* Offsets to brightness used for candle color */
+const signed char offsets[4] = { -1, -1, 1, 1 };
+
+/* Available colors, 6 bits per color (no values above 0x3f) */
 const unsigned char colors[COLOR_COUNT][LED_COUNT] = {
-  { 3, 0, 0, 0 },
-  { 3, 1, 0, 0 },
-  { 3, 2, 0, 0 },
-  { 3, 3, 0, 0 },
-  { 2, 3, 0, 0 },
-  { 1, 3, 0, 0 },
-  { 0, 3, 0, 0 },
-  { 0, 3, 1, 0 },
-  { 0, 3, 2, 0 },
-  { 0, 3, 3, 0 },
-  { 0, 2, 3, 0 },
-  { 0, 1, 3, 0 },
-  { 0, 0, 3, 0 },
-  { 1, 0, 3, 0 },
-  { 2, 0, 3, 0 },
-  { 3, 0, 3, 0 },
-  { 3, 0, 2, 0 },
-  { 3, 0, 1, 0 },
-  { 3, 3, 3, 3 },
+  { 0x2c, 0x20, 0x00, 0x18 }, /* candle */
+  { 0x28, 0x00, 0x00, 0x00 }, /* red */
+  { 0x30, 0x20, 0x00, 0x00 }, /* orange */
+  { 0x2c, 0x2c, 0x00, 0x00 }, /* yellow */
+  { 0x20, 0x2c, 0x00, 0x00 }, /* yellow-green */
+  { 0x00, 0x30, 0x00, 0x00 }, /* green */
+  { 0x00, 0x30, 0x18, 0x00 }, /* green-cyan */
+  { 0x00, 0x30, 0x28, 0x00 }, /* cyan */
+  { 0x00, 0x18, 0x30, 0x00 }, /* cyan-blue */
+  { 0x00, 0x00, 0x30, 0x00 }, /* blue */
+  { 0x1c, 0x00, 0x30, 0x00 }, /* magenta */
+  { 0x3f, 0x3f, 0x3f, 0x3f }, /* white */
 };
 
-const static int std_fade = 16;
-const static int std_incolor = 29491;
-const static int party_min = 8;
-const static int party_range = 8;
-
 unsigned char mode = MODE_SOLID;
-unsigned char color = COLOR_WHITE;
+unsigned char color = COLOR_CANDLE;
+signed char bright = BRIGHT_INIT;
+bit bright_up;
 led_t red;
 led_t grn;
 led_t blu;
 led_t wht;
 bit on;
 int fade_steps;
-signed char bright = BRIGHT_INIT;
-bit bright_up;
 signed char pbHeldCount;
+signed char cbright;
 
-/* Return the constrained brightness level for use in computing RGB values */
-unsigned char bright_get()
+void cfg_write()
 {
-  if (bright > BRIGHT_MAX)
-    return BRIGHT_MAX;
-  else if (bright < BRIGHT_MIN)
-    return BRIGHT_MIN;
-  else
-    return bright;
+  unsigned char addr = CFG_ADDR;
+  unsigned char m, c;
+  signed char b;
+
+  m = eeprom_read(addr++);
+  c = eeprom_read(addr++);
+  b = eeprom_read(addr);
+  if (mode != m || color != c || bright != b) {
+    addr = CFG_ADDR;
+    eeprom_write(addr++, mode);
+    eeprom_write(addr++, color);
+    eeprom_write(addr, bright);
+  }
 }
 
-/* RGB values will not illuminate the LED */
-unsigned char led_get(unsigned value)
+void cfg_read()
 {
-  value = (value * bright_get()) >> 8;
-#ifdef CEIL256
-  if (value && value < 0x26)
-    return 0x26;
-#else
-  if (value && value < 4)
-    return 4;
-#endif
-  return value;
+  unsigned char addr = CFG_ADDR;
+  unsigned char tmp;
+
+  tmp = eeprom_read(addr++);
+  if (tmp < MODE_COUNT)
+    mode = tmp;
+
+  tmp = eeprom_read(addr++);
+  if (tmp < COLOR_COUNT)
+    color = tmp;
+
+  tmp = eeprom_read(addr);
+  if ((signed char)tmp >= BRIGHT_BOTTOM && (signed char)tmp <= BRIGHT_TOP)
+    bright = tmp;
 }
 
-/* Set the LEDs using both color and brightness values. */
+/* Combine LED color value and brightness level to generate an RGB value.
+ * bright will be BRIGHT_MIN...BRIGHT_MAX
+ *
+ * @param value 0...1023 (6 bit color, left shifted 4 bits, for 10 bits)
+ * @param b brightness value BRIGHT_MIN...BRIGHT_MAX
+ * @return An RGB drive value, 0...255
+ */
+unsigned char led_get(int value, signed char b)
+{
+  return (unsigned long)value * b / 4 / BRIGHT_MAX;
+}
+
+/* Set the LEDs using color values and current brightness. */
 void leds_set()
 {
-  rgb_set(led_get((red).value),
-      led_get((grn).value), led_get((blu).value),
-      led_get((wht).value));
+  signed char b;
+
+  /* Use correct brightness value, then constrain it */
+  if (mode != MODE_PARTY && color != COLOR_WHITE)
+    b = cbright;
+  else
+    b = bright;
+  if (b > BRIGHT_MAX)
+    b = BRIGHT_MAX;
+  else if (b < BRIGHT_MIN)
+    b = BRIGHT_MIN;
+
+  rgb_set(led_get((red).value, b), led_get((grn).value, b),
+      led_get((blu).value, b), led_get((wht).value, b));
 }
 
 void start_fade()
 {
-  /* RGB PWM values are 8 bits, but computations are done in 15
-    * (leaving room for a sign bit), so leds_set() uses >>7 to convert
-    * to PWM values.
-    */
+  /* RGB PWM values are 8 bits.  Color values are 12 bits.  See led_get()
+   * for the conversion of color values and brightness to RGB values.
+   */
   int newr, newg, newb, neww;
 
   /* Select the destination color and fade-to time depending upon mode. */
-  fade_steps = std_fade;
+  fade_steps = STD_FADE;
   if (mode == MODE_PARTY) {
-    color = rand() % COLOR_COUNT;
-    fade_steps = party_min + (rand() % party_range);
-  } else if (mode == MODE_FADE) {
+    color = lfsr_get() % COLOR_COUNT;
+    fade_steps = PARTY_MIN + (lfsr_get() % PARTY_RANGE);
+  } else if (mode == MODE_CYCLE) {
     if (++color == COLOR_COUNT)
       color = 0;
   }
 
   /* Retrieve the destination color */
-  newr = colors[color][LED_RED] << 8;
-  newg = colors[color][LED_GRN] << 8;
-  newb = colors[color][LED_BLU] << 8;
-  neww = colors[color][LED_WHT] << 8;
+  newr = colors[color][LED_RED] << 4;
+  newg = colors[color][LED_GRN] << 4;
+  newb = colors[color][LED_BLU] << 4;
+  neww = colors[color][LED_WHT] << 4;
 
   /* Compute increment per fade step, and remainder, for each led */
   red.increment = (newr - red.value) / fade_steps;
@@ -199,6 +258,7 @@ void start_fade()
   wht.remainder = neww - (wht.value + wht.increment * fade_steps);
 
   /* Start the fade timer */
+  tmr_stop(TMR_CANDLE);
   tmr_stop(TMR_INCOLOR);
   tmr_startPeriodic(TMR_FADE, 1);  /* 32.768 msec */
 }
@@ -212,9 +272,11 @@ void turnOn()
   btn_pben();
 }
 
+/* Event on to off, either by switch or auto-off timer */
 void turnOff()
 {
-  /* Event on to off, either by switch or auto-off timer */
+  tmr_stop(TMR_CFG);
+  tmr_stop(TMR_CANDLE);
   tmr_stop(TMR_INCOLOR);
   tmr_stop(TMR_FADE);
   rgb_off();
@@ -237,13 +299,14 @@ void pb_clicked()
       mode = 0;
       color = 0;
     }
+    tmr_start(TMR_CFG, CFG_DELAY);
     start_fade();
   }
 }
 
+/* The button is being held.  Change the color magnitude. */
 void pb_held()
 {
-  /* The button has been held.  Change the color magnitude. */
   if (bright_up) {
     if (bright == BRIGHT_TOP)
       bright_up = 0;
@@ -255,6 +318,7 @@ void pb_held()
     else
       bright--;
   }
+  tmr_start(TMR_CFG, CFG_DELAY);
   leds_set();
 }
 
@@ -308,6 +372,21 @@ void rs_task()
   }
 }
 
+void candle_task()
+{
+  /* Flicker by using the brightness value */
+  cbright += offsets[lfsr_get() & 0x03];
+
+  /* Constraight cbright to a range about bright */
+  if (cbright > bright)
+    cbright = bright;
+  else if (cbright < bright - CBRIGHT_VARIANCE)
+    cbright = bright - CBRIGHT_VARIANCE;
+
+  /* Adjust the LEDs */
+  leds_set();
+}
+
 void fade_task()
 {
   red.value += red.increment;
@@ -322,11 +401,18 @@ void fade_task()
     grn.value += grn.remainder;
     blu.value += blu.remainder;
     wht.value += wht.remainder;
+    tmr_stop(TMR_CANDLE);
     tmr_stop(TMR_FADE);
-    if (mode == MODE_FADE)
-      tmr_start(TMR_INCOLOR, std_incolor);
-    else if (mode == MODE_PARTY)
-      tmr_start(TMR_INCOLOR, party_min + (rand() % party_range));
+    if (mode == MODE_PARTY)
+      tmr_start(TMR_INCOLOR, PARTY_MIN + (lfsr_get() % PARTY_RANGE));
+    else {
+      if (mode == MODE_CYCLE)
+        tmr_start(TMR_INCOLOR, STD_INCOLOR);
+      if (color != COLOR_WHITE) {
+        cbright = bright - CBRIGHT_VARIANCE / 2;
+        tmr_startPeriodic(TMR_CANDLE, 1);
+      }
+    }
   }
   leds_set();
 }
@@ -344,19 +430,11 @@ void auto_offon_task()
   }
 }
 
-void config_read()
-{
-  /* Read configuration fields from eeprom, notably current mode and
-   * brightness level.
-   */
-  /* FIXME: implement this */
-}
-
 void user_boot()
 {
   dbgpin_high();
-  srand((adc_random() << 8) + adc_random());
-  config_read();
+  lfsr_init((adc_random() << 8) + adc_random());
+  cfg_read();
   rs_task();
 }
 
@@ -366,24 +444,30 @@ void user_tasks(unsigned char block)
 
   while ((tid = task_get(block)) >= 0) {
     switch (tid) {
-      case TASK_BTN_PB:         /* pushbutton state change */
+      case TASK_BTN_PB:
         pb_task();
         break;
-      case TASK_BTN_RS:         /* rocker switch state change */
+      case TASK_BTN_RS:
         rs_task();
         break;
-      case TASK_BTN_PB_HELD: /* pushbutton is being held down */
+      case TASK_BTN_PB_HELD:
         pb_held_task();
         break;
-      case TASK_FADE:           /* fade timer has fired */
+      case TASK_FADE:
         fade_task();
         break;
-      case TASK_INCOLOR:        /* in-color timer has fired */
+      case TASK_INCOLOR:
         start_fade();
         break;
-      case TASK_TMR32:          /* auto on/off event */
+      case TASK_CANDLE:
+        candle_task();
+        break;
+      case TASK_TMR32:
         auto_offon_task();
         break;
+      case TASK_CFG:
+        cfg_write();
+        break;
     }
   }
 }