ArduinoLibs
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Charlieplex.h
1 /*
2  * Copyright (C) 2012 Southern Storm Software, Pty Ltd.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
15  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
19  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
20  * DEALINGS IN THE SOFTWARE.
21  */
22 
23 #ifndef Charlieplex_h
24 #define Charlieplex_h
25 
26 #include <inttypes.h>
27 
29 {
30 public:
31  Charlieplex(const uint8_t *pins, uint8_t numPins);
32  ~Charlieplex();
33 
34  int count() const { return _count; }
35 
36  bool led(int index) const { return _values[index] != 0; }
37  void setLed(int index, bool value) { _values[index] = (value ? 255 : 0); }
38 
39  uint8_t pwmLed(int index) const { return _values[index]; }
40  void setPwmLed(int index, uint8_t value) { _values[index] = value; }
41 
42  unsigned long holdTime() const { return _holdTime; }
43  void setHoldTime(unsigned long us) { _holdTime = us; }
44 
45  void loop();
46  void refresh();
47 
48 private:
49  int _count;
50  uint8_t *_pins1;
51  uint8_t *_pins2;
52  uint8_t *_values;
53  unsigned long _holdTime;
54  unsigned long _lastTime;
55  int _currentIndex;
56  uint8_t _pwmPhase;
57 };
58 
59 #endif
void setPwmLed(int index, uint8_t value)
Sets the PWM value of the LED at index in the charliplexed array; between 0 and 255.
Definition: Charlieplex.h:40
~Charlieplex()
Destroys this charlieplexed array.
void setHoldTime(unsigned long us)
Sets the number of microseconds that each LED should be held on for before moving onto the next in lo...
Definition: Charlieplex.h:43
Manage an array of LED's in a charlieplexed arrangement.
Definition: Charlieplex.h:28
void setLed(int index, bool value)
Sets the value of the LED at index in the charliplexed array.
Definition: Charlieplex.h:37
bool led(int index) const
Returns the value of the LED at index in the charplexed array; true if lit; false if not lit...
Definition: Charlieplex.h:36
Charlieplex(const uint8_t *pins, uint8_t numPins)
Constructs a new charliexplexing array where the output pins are specified by the numPins entries in ...
void loop()
Runs the multiplexing loop, to display the LED states on the charlieplexed array. ...
int count() const
Returns the number of LED's in this charlieplexed array based on the number of pins.
Definition: Charlieplex.h:34
unsigned long holdTime() const
Returns the number of microseconds that each LED should be held on for before moving onto the next in...
Definition: Charlieplex.h:42
void refresh()
Refreshes the charlieplexed array by advancing to the next LED that needs to be lit.
uint8_t pwmLed(int index) const
Returns the PWM value of the LED at index in the charplexed array; between 0 and 255.
Definition: Charlieplex.h:39