quantum/light_ws2812.h

   1 /*
   2  * light weight WS2812 lib include
   3  *
   4  * Version 2.3  - Nev 29th 2015
   5  * Author: Tim (cpldcpu@gmail.com)
   6  *
   7  * Please do not change this file! All configuration is handled in "ws2812_config.h"
   8  *
   9  * License: GNU GPL v2 (see License.txt)
  10  +
  11  */
  12
  13 #ifndef LIGHT_WS2812_H_
  14 #define LIGHT_WS2812_H_
  15
  16 #include <avr/io.h>
  17 #include <avr/interrupt.h>
  18 //#include "ws2812_config.h"
  19 //#include "i2cmaster.h"
  20
  21 #ifdef RGBW
  22   #define LED_TYPE struct cRGBW
  23 #else
  24   #define LED_TYPE struct cRGB
  25 #endif
  26
  27
  28 /*
  29  *  Structure of the LED array
  30  *
  31  * cRGB:     RGB  for WS2812S/B/C/D, SK6812, SK6812Mini, SK6812WWA, APA104, APA106
  32  * cRGBW:    RGBW for SK6812RGBW
  33  */
  34
  35 struct cRGB  { uint8_t g; uint8_t r; uint8_t b; };
  36 struct cRGBW { uint8_t g; uint8_t r; uint8_t b; uint8_t w;};
  37
  38
  39
  40 /* User Interface
  41  *
  42  * Input:
  43  *         ledarray:           An array of GRB data describing the LED colors
  44  *         number_of_leds:     The number of LEDs to write
  45  *         pinmask (optional): Bitmask describing the output bin. e.g. _BV(PB0)
  46  *
  47  * The functions will perform the following actions:
  48  *         - Set the data-out pin as output
  49  *         - Send out the LED data
  50  *         - Wait 50�s to reset the LEDs
  51  */
  52
  53 void ws2812_setleds     (LED_TYPE *ledarray, uint16_t number_of_leds);
  54 void ws2812_setleds_pin (LED_TYPE *ledarray, uint16_t number_of_leds,uint8_t pinmask);
  55 void ws2812_setleds_rgbw(LED_TYPE *ledarray, uint16_t number_of_leds);
  56
  57 /*
  58  * Old interface / Internal functions
  59  *
  60  * The functions take a byte-array and send to the data output as WS2812 bitstream.
  61  * The length is the number of bytes to send - three per LED.
  62  */
  63
  64 void ws2812_sendarray     (uint8_t *array,uint16_t length);
  65 void ws2812_sendarray_mask(uint8_t *array,uint16_t length, uint8_t pinmask);
  66
  67
  68 /*
  69  * Internal defines
  70  */
  71 #ifndef CONCAT
  72 #define CONCAT(a, b)            a ## b
  73 #endif
  74 #ifndef CONCAT_EXP
  75 #define CONCAT_EXP(a, b)   CONCAT(a, b)
  76 #endif
  77
  78 // #define ws2812_PORTREG  CONCAT_EXP(PORT,ws2812_port)
  79 // #define ws2812_DDRREG   CONCAT_EXP(DDR,ws2812_port)
  80
  81 #endif /* LIGHT_WS2812_H_ */