AceSegment  0.7.0
A framework for rendering seven segment LED displays using the TM1637, MAX7219, HT16K33, or 74HC595 controller chips
TemperatureWriter.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_TEMPERATURE_WRITER_H
26 #define ACE_SEGMENT_TEMPERATURE_WRITER_H
27 
28 #include <stdint.h>
29 #include "../LedModule.h"
30 #include "NumberWriter.h"
31 
32 namespace ace_segment {
33 
39  public:
41  static const uint8_t kPatternDegree = 0b01100011;
42 
44  static const uint8_t kPatternC = 0b00111001;
45 
47  static const uint8_t kPatternF = 0b01110001;
48 
55  mNumberWriter(ledModule)
56  {}
57 
59  LedModule& ledModule() { return mNumberWriter.ledModule(); }
60 
62  PatternWriter& patternWriter() { return mNumberWriter.patternWriter(); }
63 
67  uint8_t writeTempAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
68  return mNumberWriter.writeSignedDecimalAt(pos, temp, boxSize);
69  }
70 
81  uint8_t writeTempDegAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
82  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
83  boxSize >= 1 ? boxSize - 1 : 0);
84  pos += written;
86  return written + 1;
87  }
88 
92  uint8_t writeTempDegCAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
93  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
94  boxSize >= 2 ? boxSize - 2 : 0);
95  pos += written;
98  return written + 2;
99  }
100 
104  uint8_t writeTempDegFAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
105  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
106  boxSize >= 2 ? boxSize - 2 : 0);
107  pos += written;
110  return written + 2;
111  }
112 
114  void clear() { mNumberWriter.clearToEnd(0); }
115 
117  void clearToEnd(uint8_t pos) { mNumberWriter.clearToEnd(pos); }
118 
119  private:
120  // disable copy-constructor and assignment operator
121  TemperatureWriter(const TemperatureWriter&) = delete;
122  TemperatureWriter& operator=(const TemperatureWriter&) = delete;
123 
124  NumberWriter mNumberWriter;
125 };
126 
127 } // ace_segment
128 
129 #endif
ace_segment::NumberWriter::clearToEnd
void clearToEnd(uint8_t pos)
Clear the display from pos to the end.
Definition: NumberWriter.h:164
ace_segment::PatternWriter::writePatternAt
void writePatternAt(uint8_t pos, uint8_t pattern)
Write the pattern for a given pos.
Definition: PatternWriter.h:61
ace_segment::TemperatureWriter::writeTempAt
uint8_t writeTempAt(uint8_t pos, int16_t temp, int8_t boxSize=0)
Write signed integer temperature without deg or unit within the boxSize.
Definition: TemperatureWriter.h:67
ace_segment::LedModule
General interface that represents a generic seven-segment LED module with multiple digits.
Definition: LedModule.h:44
ace_segment::TemperatureWriter::kPatternF
static const uint8_t kPatternF
The "F" character for "Farenheit".
Definition: TemperatureWriter.h:47
ace_segment::TemperatureWriter::kPatternDegree
static const uint8_t kPatternDegree
The superscript degree symbol for temperature.
Definition: TemperatureWriter.h:41
ace_segment::NumberWriter::writeSignedDecimalAt
uint8_t writeSignedDecimalAt(uint8_t pos, int16_t num, int8_t boxSize=0)
Same as writeUnsignedDecimalAt() but prepends a '-' sign if negative.
Definition: NumberWriter.cpp:84
ace_segment::TemperatureWriter::TemperatureWriter
TemperatureWriter(LedModule &ledModule)
Constructor.
Definition: TemperatureWriter.h:54
ace_segment::TemperatureWriter::clear
void clear()
Clear the entire display.
Definition: TemperatureWriter.h:114
ace_segment::TemperatureWriter::patternWriter
PatternWriter & patternWriter()
Get the underlying LedModule.
Definition: TemperatureWriter.h:62
ace_segment::TemperatureWriter
The TemperatureWriter supports writing integer temperature values in Celcius or Farenheit.
Definition: TemperatureWriter.h:38
ace_segment::TemperatureWriter::clearToEnd
void clearToEnd(uint8_t pos)
Clear the display from pos to the end.
Definition: TemperatureWriter.h:117
ace_segment::TemperatureWriter::kPatternC
static const uint8_t kPatternC
The "C" character for "Celcius".
Definition: TemperatureWriter.h:44
ace_segment::TemperatureWriter::writeTempDegFAt
uint8_t writeTempDegFAt(uint8_t pos, int16_t temp, int8_t boxSize=0)
Write integer temperature with degree symbol and 'F' symbol.
Definition: TemperatureWriter.h:104
ace_segment::NumberWriter::patternWriter
PatternWriter & patternWriter()
Get the underlying LedModule.
Definition: NumberWriter.h:76
ace_segment::TemperatureWriter::writeTempDegAt
uint8_t writeTempDegAt(uint8_t pos, int16_t temp, int8_t boxSize=0)
Write integer temperature with degree symbol.
Definition: TemperatureWriter.h:81
ace_segment::TemperatureWriter::writeTempDegCAt
uint8_t writeTempDegCAt(uint8_t pos, int16_t temp, int8_t boxSize=0)
Write integer temperature with degree symbol and 'C' symbol.
Definition: TemperatureWriter.h:92
ace_segment::NumberWriter
The NumberWriter supports converting decimal and hexadecimal numbers to segment patterns expected by ...
Definition: NumberWriter.h:39
ace_segment::PatternWriter
Write LED segment patterns to the underlying LedModule.
Definition: PatternWriter.h:43
ace_segment::NumberWriter::ledModule
LedModule & ledModule()
Get the underlying LedModule.
Definition: NumberWriter.h:73
ace_segment::TemperatureWriter::ledModule
LedModule & ledModule()
Get the underlying LedModule.
Definition: TemperatureWriter.h:59