alexey.zholtikov/upm
1
0
Fork 0
mirror of https://github.com/eclipse/upm.git synced 2025-07-02 01:41:12 +03:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: more header files edited

Browse Source 
Signed-off-by: Mihai Tudor Panu <mihai.tudor.panu@intel.com>
This commit is contained in:
VadimPopov
2015-08-09 22:51:25 +03:00
committed by Mihai Tudor Panu
parent 55e8076988
commit 04edb9be04
68 changed files with 1172 additions and 1172 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
src/lpd8806/lpd8806.h
View File

@ -34,7 +34,7 @@
namespace upm {
/**
* @brief FastPixel lpd8806 library
* @brief FastPixel LPD8806 library
* @defgroup lpd8806 libupm-lpd8806
* @ingroup adafruit spi led
*/
@ -47,9 +47,9 @@ namespace upm {
* @man adafruit
* @con spi
*
* @brief API for LPD8806
* @brief API for the LPD8806 RGB LED Strip Controller
*
* The FastPixel lpd8806 is an RGB led strip controller.
* FastPixel* LPD8806 is an RGB LED strip controller.
*
* @image html lpd8806.jpg
* @snippet lpd8806.cxx Interesting
@ -58,38 +58,38 @@ class LPD8806 {
public:
/**
* Instanciates a LPD8806 object
* Instantiates an LPD8806 object
*
* @param pixelCount number of pixels in the strip
* @param csn chip select pin
* @param pixelCount Number of pixels in the strip
* @param csn Chip select pin
*/
LPD8806 (uint16_t pixelCount, uint8_t csn);
/**
* LPD8806 object destructor, basicaly it close SPI and the GPIO.
* LPD8806 object destructor; basically, it closes the SPI and the GPIO.
*/
~LPD8806 ();
/**
* @param pixelOffset pixel offset in the strip of pixel
* @param r red led
* @param g green led
* @param b blue led
* @param pixelOffset Pixel offset in the strip of the pixel
* @param r Red LED
* @param g Green LED
* @param b Blue LED
*/
void setPixelColor (uint16_t pixelOffset, uint8_t r, uint8_t g, uint8_t b);
/**
* Write the data stored in array of pixels to the chip
* Writes the data stored in the array of pixels to the chip
*/
void show (void);
/**
* Return length of the led strip
* Returns the length of the LED strip
*/
uint16_t getStripLength (void);
/**
* Return name of the component
* Returns the name of the component
*/
std::string name()
{
@ -107,12 +107,12 @@ class LPD8806 {
void writeRegister (uint8_t reg, uint8_t data);
/**
* Set chip select pin LOW
* Sets the chip select pin to LOW
*/
mraa_result_t CSOn ();
/**
* Set chip select pin HIGH
* Sets the chip select pin to HIGH
*/
mraa_result_t CSOff ();
};