src/lpd8806/lpd8806.h

   1 /*
   2  * Author: Yevgeniy Kiveisha <yevgeniy.kiveisha@intel.com>
   3  * Copyright (c) 2014 Intel Corporation.
   4  *
   5  * Permission is hereby granted, free of charge, to any person obtaining
   6  * a copy of this software and associated documentation files (the
   7  * "Software"), to deal in the Software without restriction, including
   8  * without limitation the rights to use, copy, modify, merge, publish,
   9  * distribute, sublicense, and/or sell copies of the Software, and to
  10  * permit persons to whom the Software is furnished to do so, subject to
  11  * the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be
  14  * included in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24 #pragma once
  25
  26 #include <string>
  27 #include <mraa/aio.h>
  28 #include <mraa/gpio.h>
  29 #include <mraa/spi.h>
  30
  31 #define HIGH                    1
  32 #define LOW                     0
  33
  34 namespace upm {
  35
  36 /**
  37  * @brief C++ API for LPD8806
  38  *
  39  * This file defines the LPD8806 C++ interface for liblpd8806
  40  *
  41  */
  42 class LPD8806 {
  43     public:
  44
  45         /**
  46          * Instanciates a LPD8806 object
  47          *
  48          * @param pixelCount number of pixels in the strip
  49          * @param csn chip slect pin
  50          */
  51         LPD8806 (uint16_t pixelCount, uint8_t csn);
  52
  53         /**
  54          * LPD8806 object destructor, basicaly it close SPI and the GPIO.
  55          */
  56         ~LPD8806 ();
  57
  58         /**
  59          * @param pixelOffset pixel offset in the strip of pixel
  60          * @param r red led
  61          * @param g green led
  62          * @param b blue led
  63          */
  64         void setPixelColor (uint16_t pixelOffset, uint8_t r, uint8_t g, uint8_t b);
  65
  66         /**
  67          * Write the data stored in array of pixels to the chip
  68          */
  69         void show (void);
  70
  71         /**
  72          * Return length of the led strip
  73          */
  74         uint16_t getStripLength (void);
  75
  76         /**
  77          * Return name of the component
  78          */
  79         std::string name()
  80         {
  81             return m_name;
  82         }
  83     private:
  84         std::string m_name;
  85         mraa_spi_context        m_spi;
  86         mraa_gpio_context       m_csnPinCtx;
  87
  88         uint8_t*                m_pixels;
  89         uint8_t                 m_pixelsCount;
  90
  91         uint8_t readRegister (uint8_t reg);
  92         void writeRegister (uint8_t reg, uint8_t data);
  93
  94         /**
  95          * Set chip select pin LOW
  96          */
  97         mraa_result_t CSOn ();
  98
  99         /**
 100          * Set chip select pin HIGH
 101          */
 102         mraa_result_t CSOff ();
 103 };
 104
 105 }