AceSegment  0.8.0
A framework for rendering seven segment LED displays using the TM1637, MAX7219, HT16K33, or 74HC595 controller chips
LedModule.h
1 /*
2 MIT License
3 
4 Copyright (c) 2021 Brian T. Park
5 
6 Permission is hereby granted, free of charge, to any person obtaining a copy
7 of this software and associated documentation files (the "Software"), to deal
8 in the Software without restriction, including without limitation the rights
9 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10 copies of the Software, and to permit persons to whom the Software is
11 furnished to do so, subject to the following conditions:
12 
13 The above copyright notice and this permission notice shall be included in all
14 copies or substantial portions of the Software.
15 
16 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22 SOFTWARE.
23 */
24 
25 #ifndef ACE_SEGMENT_LED_MODULE_H
26 #define ACE_SEGMENT_LED_MODULE_H
27 
28 #include <stdint.h>
29 
30 namespace ace_segment {
31 
44 class LedModule {
45  public:
55  explicit LedModule(uint8_t numDigits) : mNumDigits(numDigits) {}
56 
61  uint8_t getNumDigits() const { return mNumDigits; }
62 
64  virtual void setPatternAt(uint8_t pos, uint8_t pattern) = 0;
65 
67  virtual uint8_t getPatternAt(uint8_t pos) = 0;
68 
73  virtual void setBrightness(uint8_t brightness) = 0;
74 
75  private:
76  // disable copy-constructor and assignment operator
77  LedModule(const LedModule&) = delete;
78  LedModule& operator=(const LedModule&) = delete;
79 
80  private:
81  uint8_t const mNumDigits;
82 };
83 
84 } // ace_segment
85 
86 #endif
ace_segment::LedModule::setBrightness
virtual void setBrightness(uint8_t brightness)=0
Set global brightness of all digits.
ace_segment::LedModule::getPatternAt
virtual uint8_t getPatternAt(uint8_t pos)=0
Get the led digit pattern at position pos.
ace_segment::LedModule
General interface that represents a generic seven-segment LED module with multiple digits.
Definition: LedModule.h:44
ace_segment::LedModule::getNumDigits
uint8_t getNumDigits() const
Return the number of digits supported by this display instance.
Definition: LedModule.h:61
ace_segment::LedModule::setPatternAt
virtual void setPatternAt(uint8_t pos, uint8_t pattern)=0
Set the led digit pattern at position pos.
ace_segment::LedModule::LedModule
LedModule(uint8_t numDigits)
Constructor.
Definition: LedModule.h:55