Diff: color_pixels.h

Revision:

1:0322642447e2

Parent:

0:1e1ce549ad91

Child:

2:5c805323a2c0

--- a/color_pixels.h	Thu Jul 31 11:14:14 2014 +0000
+++ b/color_pixels.h	Thu Jul 31 12:02:23 2014 +0000
@@ -1,77 +1,94 @@
-/** Color pixels library using WS2812B and nRF51822 (16Hz)
- *  It's for
- *    + http://www.seeedstudio.com/depot/Digital-RGB-LED-FlexiStrip-60-LED-1-Meter-p-1666.html
- *    + http://www.seeedstudio.com/depot/WS2812B-Digital-RGB-LED-Waterproof-FlexiStrip-144-LEDmeter-2-meter-p-1869.html
- *    + http://www.seeedstudio.com/depot/WS2812B-RGB-LED-with-Integrated-Driver-Chip-10-PCs-pack-p-1675.html
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2014 Seeed Technology Inc.
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
-
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
-
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
- */
-
-#ifndef __COLOR_PIXELS_H__
-#define __COLOR_PIXELS_H__
-
-#include <stdint.h>
-
-class ColorPixels {
-public:
-    /** Initilaze
-     * \param pin    number of GPIO
-     * \param num    number of pixels
-     */
-    ColorPixels(uint8_t pin, uint16_t num);
-
-    /**
-     */
-    ~ColorPixels();
-
-    /** Set the color of a pixel (without update)
-     * \param index  index of a pixel
-     * \param r      red
-     * \param g      green
-     * \param b      blue
-     */
-    void set_color(uint16_t index, uint8_t r, uint8_t g, uint8_t b);
-
-    /** Update
-     */
-    void update();
-
-    /** Turn off all pixels
-     */
-    void clear();
-
-private:
-    typedef union {
-        struct {
-            uint8_t g, r, b;
+/** Color pixels library using WS2812B and nRF51822 (16Hz)
+ *  It's for
+ *    + http://www.seeedstudio.com/depot/Digital-RGB-LED-FlexiStrip-60-LED-1-Meter-p-1666.html
+ *    + http://www.seeedstudio.com/depot/WS2812B-Digital-RGB-LED-Waterproof-FlexiStrip-144-LEDmeter-2-meter-p-1869.html
+ *    + http://www.seeedstudio.com/depot/WS2812B-RGB-LED-with-Integrated-Driver-Chip-10-PCs-pack-p-1675.html
+ *
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2014 Seeed Technology Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+#ifndef __COLOR_PIXELS_H__
+#define __COLOR_PIXELS_H__
+
+#include <stdint.h>
+
+/** Color pixels class using WS2812B and nRF51822 (16Hz)
+ *
+ * Example:
+ * @code
+ * #include "mbed.h"
+ * #include "color_pixels.h"
+ *
+ * ColorPixels pixels(1, 32);
+ *
+ * int main() {
+ *    pixels.set_color(0, 0, 255, 0);
+ *    pixels.update();
+ *
+ *    while(1) {
+ *    }
+ * }
+ * @endcode
+ */
+class ColorPixels
+{
+public:
+    /** Initilaze
+     * \param pin    number of GPIO
+     * \param num    number of pixels
+     */
+    ColorPixels(uint8_t pin, uint16_t num);
+
+    ~ColorPixels();
+
+    /** Set the color of a pixel (without update)
+     * \param index  index of a pixel
+     * \param r      red
+     * \param g      green
+     * \param b      blue
+     */
+    void set_color(uint16_t index, uint8_t r, uint8_t g, uint8_t b);
+
+    /** Update
+     */
+    void update();
+
+    /** Turn off all pixels
+     */
+    void clear();
+
+private:
+    typedef union {
+        struct {
+            uint8_t g, r, b;
         };
-        uint32_t grb;
-    } color_t;
-
-    uint8_t  pin;
-    uint16_t num;
-    color_t *colors;
-
-};
-
-#endif // __COLOR_PIXELS_H__
+        uint32_t grb;
+    } color_t;
+
+    uint8_t  pin;
+    uint16_t num;
+    color_t *colors;
+
+};
+
+#endif // __COLOR_PIXELS_H__