Add README

[rgblamp.git] / tmr_defs.h

diff --git a/tmr_defs.h b/tmr_defs.h
index ea94e9c16a2e7af2d3fbea94f14ac7c2b0a2b25f..ba0b64bccbf892914e2a7893016317bbffe82a6a 100644 (file)
--- a/tmr_defs.h
+++ b/tmr_defs.h
@@ -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:   tmr_defs.h
  *
@@ -14,12 +43,18 @@
  * accordingly.
  */
 enum {
-  TMR_BTN_PB = 0,
-  TMR_BTN_RS,
-  TMR_AUTO_OFFON,
-  TMR_FADE,
-  TMR_INCOLOR,
-  //TMR_DIM,
+  TMR_BTN_PB = 0,    /* Pushbutton debounce */
+  TMR_BTN_RS,        /* Rocker switch debounce */
+  TMR_BTN_PB_HELD,   /* Time elapsed determines clicked vs held */
+  TMR_FADE,          /* Time between fade iterations */
+  TMR_INCOLOR,       /* Time a given color remains active (no fade) */
+  TMR_CANDLE,        /* Time between candle variations */
+
+  /* Time expired before a changed configuration is written.  In this way,
+   * several changes to the configuration within TMR_CFG time generate a
+   * single EEPROM write.
+   */
+  TMR_CFG,
 
   TMR_COUNT
 };