Daniel Wiese / DD-Booster-mbed

This is a library for the DIGI-DOT-BOOSTER which can control LED stripes using the single wire protocol - ws2812 and compatible as well as RGBW LEDs like SK6812. Detailed information including the datasheet and protocol description are available here: http://www.led-genial.de/DIGI-DOT-Booster-WS2812-und-SK6812-ueber-SPI-Schnittstelle-ansteuern DIGI-DOT-BOOSTER acts as a SPI slave and waits for commands sent by a SPI master. This Library provides an easy to use abstraction layer for commands supported by the DD-Booster and adds some additional effects.

Dependents:   DD-Booster-waterdrop BLE_DD-Booster

Files at this revision

API Documentation at this revision

Revision 2:4c1e47117cf8, committed 2017-03-08

Comitter:
Gamadril
Date:
Wed Mar 08 08:49:00 2017 +0000
Parent:
1:7d80447d1ac0
Commit message:
docs update

Changed in this revision

DDBooster.h Show annotated file Show diff for this revision Revisions of this file 
diff -r 7d80447d1ac0 -r 4c1e47117cf8 DDBooster.h
--- a/DDBooster.h	Mon Mar 06 14:00:31 2017 +0000
+++ b/DDBooster.h	Wed Mar 08 08:49:00 2017 +0000
@@ -13,11 +13,9 @@
  * @brief Class acts as a wrapper around SPI calls to control the Digi-Dot-Booster.
  * 
  * After creation of the class instance SPI is configured with default values (12MHz, MSB first, mode 0).
- * By default the library uses the SS pin of mbed platform for the communication with the Digi-Dot-Booster.
- * If you prefer to use another digital pin for chip select use configurePins to set it.
- * Using configurePins you can also set a reset pin used to toggle the hardware reset of the DD-Booster.
+ * Used SPI pins has to be passed to the constructor. RESET pin is optional. If omitted reset() call has no effect.
  *  
- * Before calling any functions you have first to initialize the DD-Booster by calling init() with the number of the LEDs (max. 256),
+ * Before calling any functions you have first to initialize the DD-Booster by calling init() with the number of the LEDs (max. 256 for RGB and max. 192 for RGBW),
  * their type (RGB or RGBW) and the color order (RGB or GRB). Both last parameters are optional - DD-Booster is
  * configured for the ws2812 LEDS (RGB type with GRB color order).
  * 
@@ -68,7 +66,7 @@
 
     /**
      * Performs a hardware reset of the DD-Booster by toggling it's RESET pin.
-     * To use this function, set the corresponding pin first using configurePins otherwise
+     * Does nothing if RESET pin was not configured in the constructor.
      * the call of reset() does nothing.
      */
     void reset();