Brian Daniels / WS2812

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   WS2812_Example WS2812_Example_fade Lamp_03 Lamp_04 ... more

Files at this revision

API Documentation at this revision

Revision 2:6e647820f587, committed 2015-02-12

Comitter:
bridadan
Date:
Thu Feb 12 20:24:15 2015 +0000
Parent:
1:aadbf08c62a2
Commit message:
Updated docs

Changed in this revision

WS2812.h Show annotated file Show diff for this revision Revisions of this file 
--- a/WS2812.h	Thu Feb 12 20:20:10 2015 +0000
+++ b/WS2812.h	Thu Feb 12 20:24:15 2015 +0000
@@ -62,7 +62,8 @@
     void setDelays(int zeroHigh, int zeroLow, int oneHigh, int oneLow);
 
     /**
-    *   Sets the timing parameters for the bit-banged signal
+    *   Writes the given buffer to the LED strip with the given offsets.
+    *   NOTE: This function is timing critical, therefore interrupts are disabled during the transmission section.
     *
     * @param buf Pointer to the PixelArray buffer
     * @param r_offset The offset where each each pixel pulls its red component. Wraps to beginning if end is reached.
@@ -74,7 +75,8 @@
 
 
     /**
-    *   Write the given buffer to the LED strip
+    *   Writes the given buffer to the LED strip
+    *   NOTE: This function is timing critical, therefore interrupts are disabled during the transmission section.
     *
     * @param buf Pointer to the PixelArray buffer
     *