AceSegment  0.3.0
An adjustable, configurable, and extensible framework for rendering seven segment LED displays.
DigitDriver.h
1 /*
2 MIT License
3 
4 Copyright (c) 2018 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_DIGIT_DRIVER_H
26 #define ACE_SEGMENT_DIGIT_DRIVER_H
27 
28 #include <stdint.h>
29 #include "Driver.h"
30 
31 namespace ace_segment {
32 
33 class DimmablePattern;
34 
39 class DigitDriver: public Driver {
40  public:
42  explicit DigitDriver(LedMatrix* ledMatrix,
43  DimmablePattern* dimmablePatterns,
44  uint8_t numDigits, bool ownsLedMatrix = false):
45  Driver(ledMatrix, dimmablePatterns, numDigits, ownsLedMatrix)
46  {}
47 
48  virtual void configure() override {
50  mCurrentDigit = 0;
51  mPrevDigit = mNumDigits - 1;
52  mSegmentPattern = 0;
53  }
54 
55  virtual uint16_t getFieldsPerFrame() override { return mNumDigits; }
56 
57  virtual bool isBrightnessSupported() override { return false; }
58 
59  virtual void displayCurrentField() override;
60 
61  virtual void prepareToSleep() override;
62 
63  protected:
69  uint8_t mCurrentDigit;
70 
76  uint8_t mPrevDigit;
77 
78  SegmentPatternType mSegmentPattern;
79 
80  private:
81  // disable copy-constructor and assignment operator
82  DigitDriver(const DigitDriver&) = delete;
83  DigitDriver& operator=(const DigitDriver&) = delete;
84 
85 };
86 
87 }
88 
89 #endif
uint8_t SegmentPatternType
Integer type used to store the segment bit patterns of a single digit.
Definition: Driver.h:51
virtual bool isBrightnessSupported() override
Returns true if the driver supports brightness.
Definition: DigitDriver.h:57
virtual void configure() override
Configure the driver.
Definition: DigitDriver.h:48
virtual void prepareToSleep() override
Prepare to go to sleep by clearing the frame, and setting a flag so that it doesn&#39;t turn itself back ...
Definition: DigitDriver.cpp:58
virtual uint16_t getFieldsPerFrame() override
Return number of fields per frame.
Definition: DigitDriver.h:55
virtual void configure()
Configure the driver.
Definition: Driver.cpp:37
Class that represents the abstraction of a particular LED display wiring.
Definition: LedMatrix.h:49
uint8_t mPrevDigit
Within the displayCurrentField() method, the mPrevDigit is the digit that was displayed on the previo...
Definition: DigitDriver.h:76
DigitDriver(LedMatrix *ledMatrix, DimmablePattern *dimmablePatterns, uint8_t numDigits, bool ownsLedMatrix=false)
Constructor.
Definition: DigitDriver.h:42
Base class of drivers which knows how to transfer the bit patterns stored in the array of DimmablePat...
Definition: Driver.h:44
A Driver that assumes that the resistors are on the segments so the multiplexing occurs by scanning t...
Definition: DigitDriver.h:39
uint8_t mCurrentDigit
Within the displayCurrentField() method, mCurrentDigit is the current digit that is being drawn...
Definition: DigitDriver.h:69
virtual void displayCurrentField() override
Display the current field of the frame.
Definition: DigitDriver.cpp:32