Add README

[rgblamp.git] / task_defs.h

diff --git a/task_defs.h b/task_defs.h
index 5130fba51debb2fed893dd5459aaf2ec4fd798e6..9d7e59c927c6876d7b886a57059be2eeb42a8002 100644 (file)
--- a/task_defs.h
+++ b/task_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:   task_defs.h
  *
@@ -17,14 +46,14 @@
  * _task_ids variable in task.c.
  */
 enum {
-  TASK_BTN_PB = 0,
-  TASK_BTN_RS,
-  TASK_BTN_PB_HELD,
-  TASK_FADE,
-  TASK_INCOLOR,
-  TASK_TMR32,
-  TASK_CANDLE,
-  TASK_CFG,
+  TASK_BTN_PB = 0,     /* Pushbutton state change */
+  TASK_BTN_RS,         /* Rocker switch state change */
+  TASK_BTN_PB_HELD,    /* Pushbutton is being held down */
+  TASK_FADE,           /* Fade timer has fired */
+  TASK_INCOLOR,        /* In-color timer has fired */
+  TASK_TMR32,          /* Auto on/off event */
+  TASK_CANDLE,         /* Periodic adjustment for candle flicker */
+  TASK_CFG,            /* Save config to EEPROM event */
 
   TASK_COUNT
 };