upm  1.3.0
Sensor/Actuator repository for libmraa (v1.7.0)
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
apa102.hpp
1 /*
2  * Author: Yannick Adam <yannick.adam@gmail.com>
3  * Copyright (c) 2016 Yannick Adam
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 <mraa/gpio.hpp>
27 #include <mraa/spi.hpp>
28 #include <string>
29 
30 #define HIGH 1
31 #define LOW 0
32 
33 namespace upm
34 {
58 class APA102
59 {
60  public:
70  APA102(uint16_t ledCount, uint8_t spiBus, bool batchMode = false, int8_t csn = -1);
71 
75  ~APA102();
76 
86  void setLed(uint16_t ledIdx, uint8_t brightness, uint8_t r, uint8_t g, uint8_t b);
87 
94  void setLedBrightness(uint16_t ledIdx, uint8_t brightness);
95 
104  void setAllLeds(uint8_t brightness, uint8_t r, uint8_t g, uint8_t b);
105 
116  void
117  setLeds(uint16_t startIdx, uint16_t endIdx, uint8_t brightness, uint8_t r, uint8_t g, uint8_t b);
118 
126  void
127  setLedsBrightness(uint16_t startIdx, uint16_t endIdx, uint8_t brightness);
128 
140  void setLeds(uint16_t startIdx, uint16_t endIdx, uint8_t* colors);
141 
149  void setBusSpeed(int hz);
150 
156  void pushState();
157 
158  private:
159  /* Disable implicit copy and assignment operators */
160  APA102(const APA102&) = delete;
161  APA102 &operator=(const APA102&) = delete;
162 
163  mraa::Spi* m_spi;
164  mraa::Gpio* m_csnPinCtx;
165 
166  uint16_t m_ledCount;
167  uint8_t* m_leds;
168  uint16_t m_frameLength;
169 
170  bool m_batchMode;
171 
172  mraa::Result CSOn();
173  mraa::Result CSOff();
174 };
175 }
void setLeds(uint16_t startIdx, uint16_t endIdx, uint8_t brightness, uint8_t r, uint8_t g, uint8_t b)
Definition: apa102.cxx:112
~APA102()
Definition: apa102.cxx:74
void setLedsBrightness(uint16_t startIdx, uint16_t endIdx, uint8_t brightness)
Definition: apa102.cxx:130
void setBusSpeed(int hz)
Definition: apa102.cxx:156
APA102(uint16_t ledCount, uint8_t spiBus, bool batchMode=false, int8_t csn=-1)
Definition: apa102.cxx:35
void pushState()
Definition: apa102.cxx:165
void setLed(uint16_t ledIdx, uint8_t brightness, uint8_t r, uint8_t g, uint8_t b)
Definition: apa102.cxx:94
void setAllLeds(uint8_t brightness, uint8_t r, uint8_t g, uint8_t b)
Definition: apa102.cxx:106
void setLedBrightness(uint16_t ledIdx, uint8_t brightness)
Definition: apa102.cxx:100
API for controlling APA102/DotStar RGB LED Strips.
Definition: apa102.hpp:58