SevenSegDisplays.h

Go to the documentation of this file.

//FFDR For Future Development Reminder!!
//FTPO For Testing Purposes Only code!!
 
#ifndef _SevenSegDisplays_ESP32_H_
#define _SevenSegDisplays_ESP32_H_
 
#include <Arduino.h>
#include <stdint.h>
#include <./SevenSegDispHw/SevenSegDispHw.h>
 
class SevenSegDisplays {
   static uint8_t _displaysCount;
   static uint16_t _dspLastSerialNum;
   static SevenSegDisplays** _ssdInstancesLstPtr;
 
   static TimerHandle_t _blinkTmrHndl;
   static TimerHandle_t _waitTmrHndl;
 
   static void tmrCbBlink(TimerHandle_t blinkTmrCbArg);
   static void tmrCbWait(TimerHandle_t waitTmrCbArg);
 
   static const uint32_t _minBlinkRate{100};  //unsigned long for ESP32 in Arduino enviornment
   static const uint32_t _maxBlinkRate{2000};   //unsigned long for ESP32 in Arduino enviornment
 
private:
   bool _begun{false};
   bool _isWaiting {false};
   uint8_t _waitChar {0xBF};
   uint8_t _waitCount {0};
   uint32_t _waitRate {250};
   uint32_t _waitTimer {0};
 
protected:
   bool* _blinkMaskPtr{nullptr};
   uint8_t* _dspAuxBuffPtr{nullptr};
   uint8_t* _dspBuffPtr{nullptr};
   uint8_t _dspDigitsQty{};
   SevenSegDispHw* _dspUndrlHwPtr{};
   SevenSegDisplays* _dspInstance{nullptr};
   uint16_t _dspSerialNbr{0};
   int32_t _dspValMax{};
   int32_t _dspValMin{};
   bool _dspUndrlHwCommAnode{};
    
   bool _isBlinking{false};
   bool _blinkShowOn{false};
   uint32_t _blinkTimer{0};
   uint32_t _blinkOffRate{500};
   uint32_t _blinkOnRate{500};
   uint32_t _blinkRatesGCD{500};  //Holds the value for the minimum timer checking the change ON/OFF of the blinking, saving unneeded timer interruptions, and without the need of the std::gcd function
   String _charSet{"0123456789AabCcdEeFGHhIiJLlnOoPqrStUuY-_=~* ."}; // for using indexOf() method
   uint8_t _charLeds[45] = {   //Values valid for a Common Anode display. For a Common Cathode display values must be logically bit negated
      0xC0, // 0
      0xF9, // 1
      0xA4, // 2
      0xB0, // 3
      0x99, // 4
      0x92, // 5
      0x82, // 6
      0xF8, // 7
      0x80, // 8
      0x90, // 9
      0x88, // A
      0xA0, // a
      0x83, // b
      0xC6, // C
      0xA7, // c
      0xA1, // d
      0x86, // E
      0x84, // e
      0x8E, // F
      0xC2, // G
      0x89, // H
      0x8B, // h
      0xF9, // I
      0xFB, // i
      0xF1, // J
      0xC7, // L
      0xCF, // l
      0xAB, // n
      0xC0, // O
      0xA3, // o
      0x8C, // P
      0x98, // q
      0xAF, // r
      0x92, // S
      0x87, // t
      0xC1, // U
      0xE3, // u
      0x91, // Y
      0xBF, // Minus -
      0xF7, // Underscore _
      0xB7, // Low =
      0xB6, //~ for Equivalent symbol
      0x9C, // °
      0xFF, // Space
      0x7F  //.
   };    
    
   uint8_t _space {0xFF};
   uint8_t _dot {0x7F};
   String _zeroPadding{""};
   String _spacePadding{""};
 
   uint32_t _blinkTmrGCD(uint32_t blnkOnTm, uint32_t blnkOffTm);
   void _ntfyToHwBuffChng();
   void _popSsd(SevenSegDisplays** &ssdInstncObjLst, SevenSegDisplays* ssdToPop);
   void _pushSsd(SevenSegDisplays** &ssdInstncObjLst, SevenSegDisplays* ssdToPush);
   void _restoreDspBuff();
   void _setAttrbts();
   void _setDspBuffChng();
   void _saveDspBuff();
   void _updBlinkState();
   void _updWaitState();
 
public:
   SevenSegDisplays();
   SevenSegDisplays(SevenSegDispHw* dspUndrlHwPtr);
   ~SevenSegDisplays();
   virtual bool begin(uint32_t updtLps = 0);
   bool blink();
   bool blink(const uint32_t &onRate, const uint32_t &offRate = 0);
   void clear();
   bool doubleGauge(const int &levelLeft, const int &levelRight, char labelLeft = ' ', char labelRight = ' ');
   bool end();
   bool gauge(const int &level, char label = ' ');
   bool gauge(const double &level, char label = ' ');
   uint8_t getCurBrghtnssLvl();   
   uint8_t getDigitsQty();
   uint8_t getDspCount();
   bool getDspIsDmmbl();
   SevenSegDispHw* getDspUndrlHwPtr();
   int32_t getDspValMax();
   int32_t getDspValMin();
   bool getIsOn();
   uint32_t getMaxBlinkRate();
   uint8_t getMaxBrghtnssLvl();
   uint32_t getMinBlinkRate();
   uint8_t getMinBrghtnssLvl();
   uint16_t getSerialNbr();
   bool isBlank();
   bool isBlinking();
   bool isWaiting();
   bool noBlink();
   bool noWait();
   bool print(String text);
   bool print(const int32_t &value, bool rgtAlgn = false, bool zeroPad = false);
   bool print(const double &value, const unsigned int &decPlaces, bool rgtAlgn = false, bool zeroPad = false);
   void resetBlinkMask();
   void setBlinkMask(const bool* newBlnkMsk);
   bool setBlinkRate(const uint32_t &newOnRate, const uint32_t &newOffRate = 0);
   bool setBrghtnssLvl(const uint8_t &newBrghtnssLvl);    
   bool setWaitChar (const char &newChar);
   bool setWaitRate(const uint32_t &newWaitRate); 
   void turnOff();
   void turnOn();
   void turnOn(const uint8_t &newBrghtnssLvl);
   bool wait();
   bool wait(const uint32_t &newWaitRate);
   bool write(const uint8_t &segments, const uint8_t &port);
   bool write(const String &character, const uint8_t &port);
};
 
#endif  //_SevenSegDisplays_H_