AceSegment  0.8.2
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 "NumberWriter.h"
30 
31 namespace ace_segment {
32 
40 template <typename T_LED_MODULE>
42  public:
44  static const uint8_t kPatternDegree = 0b01100011;
45 
47  static const uint8_t kPatternC = 0b00111001;
48 
50  static const uint8_t kPatternF = 0b01110001;
51 
57  explicit TemperatureWriter(T_LED_MODULE& ledModule) :
58  mNumberWriter(ledModule)
59  {}
60 
62  T_LED_MODULE& ledModule() { return mNumberWriter.ledModule(); }
63 
66  return mNumberWriter.patternWriter();
67  }
68 
72  uint8_t writeTempAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
73  return mNumberWriter.writeSignedDecimalAt(pos, temp, boxSize);
74  }
75 
86  uint8_t writeTempDegAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
87  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
88  boxSize >= 1 ? boxSize - 1 : 0);
89  pos += written;
90  patternWriter().writePatternAt(pos++, kPatternDegree);
91  return written + 1;
92  }
93 
97  uint8_t writeTempDegCAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
98  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
99  boxSize >= 2 ? boxSize - 2 : 0);
100  pos += written;
101  patternWriter().writePatternAt(pos++, kPatternDegree);
102  patternWriter().writePatternAt(pos++, kPatternC);
103  return written + 2;
104  }
105 
109  uint8_t writeTempDegFAt(uint8_t pos, int16_t temp, int8_t boxSize = 0) {
110  uint8_t written = mNumberWriter.writeSignedDecimalAt(pos, temp,
111  boxSize >= 2 ? boxSize - 2 : 0);
112  pos += written;
113  patternWriter().writePatternAt(pos++, kPatternDegree);
114  patternWriter().writePatternAt(pos++, kPatternF);
115  return written + 2;
116  }
117 
119  void clear() { mNumberWriter.clearToEnd(0); }
120 
122  void clearToEnd(uint8_t pos) { mNumberWriter.clearToEnd(pos); }
123 
124  private:
125  // disable copy-constructor and assignment operator
126  TemperatureWriter(const TemperatureWriter&) = delete;
127  TemperatureWriter& operator=(const TemperatureWriter&) = delete;
128 
129  NumberWriter<T_LED_MODULE> mNumberWriter;
130 };
131 
132 } // ace_segment
133 
134 #endif
ace_segment::TemperatureWriter::kPatternDegree
static const uint8_t kPatternDegree
The superscript degree symbol for temperature.
Definition: TemperatureWriter.h:44
ace_segment::TemperatureWriter::TemperatureWriter
TemperatureWriter(T_LED_MODULE &ledModule)
Constructor.
Definition: TemperatureWriter.h:57
ace_segment::TemperatureWriter::ledModule
T_LED_MODULE & ledModule()
Get the underlying LedModule.
Definition: TemperatureWriter.h:62
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:72
ace_segment::TemperatureWriter
The TemperatureWriter supports writing integer temperature values in Celcius or Farenheit.
Definition: TemperatureWriter.h:41
ace_segment::TemperatureWriter::patternWriter
PatternWriter< T_LED_MODULE > & patternWriter()
Get the underlying PatternWriter.
Definition: TemperatureWriter.h:65
ace_segment::TemperatureWriter::clear
void clear()
Clear the entire display.
Definition: TemperatureWriter.h:119
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:86
ace_segment::TemperatureWriter::kPatternC
static const uint8_t kPatternC
The "C" character for "Celcius".
Definition: TemperatureWriter.h:47
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:109
ace_segment::TemperatureWriter::kPatternF
static const uint8_t kPatternF
The "F" character for "Farenheit".
Definition: TemperatureWriter.h:50
ace_segment::NumberWriter
The NumberWriter supports converting decimal and hexadecimal numbers to segment patterns expected by ...
Definition: NumberWriter.h:72
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:97
ace_segment::TemperatureWriter::clearToEnd
void clearToEnd(uint8_t pos)
Clear the display from pos to the end.
Definition: TemperatureWriter.h:122
ace_segment::PatternWriter
Write LED segment patterns to the underlying LedModule.
Definition: PatternWriter.h:46