AceSegment  0.8.2
A framework for rendering seven segment LED displays using the TM1637, MAX7219, HT16K33, or 74HC595 controller chips
Public Member Functions | Static Public Attributes | List of all members
ace_segment::TemperatureWriter< T_LED_MODULE > Class Template Reference

The TemperatureWriter supports writing integer temperature values in Celcius or Farenheit. More...

#include <TemperatureWriter.h>

Public Member Functions

 TemperatureWriter (T_LED_MODULE &ledModule)
 Constructor. More...
 
T_LED_MODULE & ledModule ()
 Get the underlying LedModule.
 
PatternWriter< T_LED_MODULE > & patternWriter ()
 Get the underlying PatternWriter.
 
uint8_t writeTempAt (uint8_t pos, int16_t temp, int8_t boxSize=0)
 Write signed integer temperature without deg or unit within the boxSize.
 
uint8_t writeTempDegAt (uint8_t pos, int16_t temp, int8_t boxSize=0)
 Write integer temperature with degree symbol. More...
 
uint8_t writeTempDegCAt (uint8_t pos, int16_t temp, int8_t boxSize=0)
 Write integer temperature with degree symbol and 'C' symbol.
 
uint8_t writeTempDegFAt (uint8_t pos, int16_t temp, int8_t boxSize=0)
 Write integer temperature with degree symbol and 'F' symbol.
 
void clear ()
 Clear the entire display.
 
void clearToEnd (uint8_t pos)
 Clear the display from pos to the end.
 

Static Public Attributes

static const uint8_t kPatternDegree = 0b01100011
 The superscript degree symbol for temperature.
 
static const uint8_t kPatternC = 0b00111001
 The "C" character for "Celcius".
 
static const uint8_t kPatternF = 0b01110001
 The "F" character for "Farenheit".
 

Detailed Description

template<typename T_LED_MODULE>
class ace_segment::TemperatureWriter< T_LED_MODULE >

The TemperatureWriter supports writing integer temperature values in Celcius or Farenheit.

Negative values are supported.

Template Parameters
T_LED_MODULEthe class of the underlying LED Module, often LedModule but other classes with the same generic public methods can be substituted

Definition at line 41 of file TemperatureWriter.h.

Constructor & Destructor Documentation

◆ TemperatureWriter()

template<typename T_LED_MODULE >
ace_segment::TemperatureWriter< T_LED_MODULE >::TemperatureWriter ( T_LED_MODULE &  ledModule)
inlineexplicit

Constructor.

Parameters
ledModuleinstance of LedModule

Definition at line 57 of file TemperatureWriter.h.

Member Function Documentation

◆ writeTempDegAt()

template<typename T_LED_MODULE >
uint8_t ace_segment::TemperatureWriter< T_LED_MODULE >::writeTempDegAt ( uint8_t  pos,
int16_t  temp,
int8_t  boxSize = 0 
)
inline

Write integer temperature with degree symbol.

The caller is responsible for verifying that the temp value fits inside the boxSize. For example, if boxSize is 2, then the range of temp value is [-9, 99]. If the boxSize is too small, the digits will bleed to the right of the box.

Returns
number of digits written, including any '-' or space characters

Definition at line 86 of file TemperatureWriter.h.


The documentation for this class was generated from the following file: