SevenSegDispHw.h

Go to the documentation of this file.

#ifndef sevenSegDispHw_ESP32_H
#define sevenSegDispHw_ESP32_H
 
#include "Arduino.h"
#include <stdint.h>
#include <ShiftRegGPIOXpander_ESP32.h>
 
//============================================================> Class declarations separator

class SevenSegDispHw{
    static uint8_t _dspHwSerialNum;
private:
   virtual void _unAbstract() = 0; // Makes this an Abstract class. For the subclasses to be instantiable they'll have to implement the _unAbstract() method.  
 
protected:
   uint8_t* _ioPins{};
   uint8_t* _digitPosPtr{nullptr};
   uint8_t _dspDigitsQty{}; // Display size in digits    
   bool _commAnode {true}; // SevenSegDisplays objects need this info to build the right segments to represent each character
   const uint8_t _dspDigitsQtyMax{0};
 
   uint8_t _allLedsOff{};  
   uint8_t _brghtnssLvl{0};  
   uint8_t _brghtnssLvlMax{0};   
   uint8_t _brghtnssLvlMin{0};   
   uint8_t* _dspBlankBuffPtr{nullptr}; 
   uint8_t* _dspBuffPtr{nullptr};   
   uint8_t* _dspBuffPtrBkp{nullptr};  
   SevenSegDispHw* _dspHwInstance{nullptr};
   uint8_t _dspHwInstNbr{0};
   bool _isOn{false};   
   uint8_t* _xcdDspBuffPtr{nullptr};    
   uint8_t _xcdDspDigitsQty{};  
 
public:
   SevenSegDispHw();
   SevenSegDispHw(uint8_t* ioPins, uint8_t dspDigits = 4, bool commAnode = true, uint8_t dspDigitsQtyMax = 0);
   virtual ~SevenSegDispHw();    
   virtual bool begin(uint32_t updtLps = 0);
   virtual bool end();
   virtual uint8_t getBrghtnssLvl();
   virtual uint8_t getBrghtnssMaxLvl();
   virtual uint8_t getBrghtnssMinLvl();
   bool getCommAnode();
   uint8_t* getDspBuffPtr();
   uint8_t getHwDspDigitsQty();
   virtual bool getIsOn();
   uint8_t* getxcdDspBuffPtr();
   virtual void ntfyUpdDsply();
   virtual bool setBrghtnssLvl(const uint8_t &newBrghtnssLvl); 
   virtual bool setDigitsOrder(uint8_t* newOrderPtr);
   void setDspBuffPtr(uint8_t* newDspBuffPtr);
    virtual void turnOff();
   virtual void turnOn();
   virtual void turnOn(const uint8_t &newBrghtnssLvl);
};
 
//============================================================> Class declarations separator

class SevenSegDynamic: public SevenSegDispHw{    
   static void tmrCbRfrshDyn(TimerHandle_t rfrshTmrCbArg);
    
private:
   virtual void _unAbstract() = 0; // Makes this an Abstract class.
 
protected:
   TimerHandle_t _dynDspRfrshTmrHndl{NULL};
   uint8_t _firstRefreshed{0};
   String _rfrshTmrName{""};
 
   void _refresh();
 
public:
   SevenSegDynamic();
   SevenSegDynamic(uint8_t* ioPins, uint8_t dspDigits, bool commAnode, uint8_t dspDigitsQtyMax = 0);
   virtual ~SevenSegDynamic();
   virtual bool begin(uint32_t updtLps=0);
   virtual bool end();
};
 
//============================================================> Class declarations separator

class SevenSegDynHC595: public SevenSegDynamic{
   static void tmrCbRfrshDynHC595(TimerHandle_t rfrshTmrCbArg);
 
private:
   const uint8_t _sclkIndx {0};
   const uint8_t _rclkIndx {1};
   const uint8_t _dioIndx {2};
 
   ShiftRegGPIOXpander* _drvrShftRegPtr{nullptr};
   uint8_t* _drvrShftRegSndPtr{nullptr};
   uint8_t _sclk {};
   uint8_t _rclk {};
   uint8_t _dio {};
   
   virtual void _unAbstract();
 
protected:
   const uint8_t _dspDigitsQtyMax{8};
   TimerHandle_t _dynHC595DspRfrshTmrHndl{NULL};  
 
   void _refresh();
 
public:
    SevenSegDynHC595(uint8_t* ioPins, uint8_t dspDigits, bool commAnode);
    virtual ~SevenSegDynHC595();
    virtual bool begin(uint32_t updtLps = 0);
   bool end();
};
 
//============================================================> Class declarations separator

class SevenSegDynDummy: public SevenSegDynamic{
   static void tmrCbRfrshDynDummy(TimerHandle_t rfrshTmrCbArg);
    
private:    
   virtual void _unAbstract();
 
protected:
   // static TimerHandle_t _dynDummyDspRfrshTmrHndl;
   TimerHandle_t _dynDummyDspRfrshTmrHndl{NULL};
 
   void _refresh();
   virtual void send(const uint8_t &segments, const uint8_t &port);
 
public:
    SevenSegDynDummy(uint8_t dspDigits = 4, bool commAnode = true);
    virtual ~SevenSegDynDummy();
    bool begin(uint32_t updtLps = 0);
    bool end();
 
    virtual void turnOff();
 
    virtual void turnOn();
 
};
 
//============================================================> Class declarations separator

class SevenSegStatic: public SevenSegDispHw{
private:
   virtual void _unAbstract() = 0; // Makes this an Abstract class.  
 
public:
   SevenSegStatic();
   SevenSegStatic(uint8_t* ioPins, uint8_t dspDigits = 4, bool commAnode = true, uint8_t dspDigitsQtyMax = 0);
   virtual ~SevenSegStatic();
};
 
//============================================================> Class declarations separator

class SevenSegStatHC595: public SevenSegStatic{
private:
    const uint8_t _sclkIndx {0};
    const uint8_t _rclkIndx {1};
    const uint8_t _dioIndx {2};
 
    ShiftRegGPIOXpander* _dsplyHwShftRegPtr{nullptr};
    uint8_t* _lclDspBuffPtr{nullptr};
    uint8_t _sclk {};
    uint8_t _rclk {};
    uint8_t _dio {};
 
    virtual void _unAbstract();
    void _updDsplyCntnt();
 
   public:
    SevenSegStatHC595();
    SevenSegStatHC595(uint8_t* ioPins, uint8_t dspDigits = 4, bool commAnode = true);
    virtual ~SevenSegStatHC595();
 
    virtual bool begin(uint32_t updtLps = 0);
    virtual void ntfyUpdDsply();
};
 
//============================================================> Class declarations separator

class SevenSegTM163X: public SevenSegStatic{
private:
   const uint8_t _clkIndx {0};
   const uint8_t _dioIndx {1};
   const uint8_t _hwBrghtnssLvlMax{0x07};
   const uint8_t _hwBrghtnssLvlMin{0x00};
   uint32_t _txClkTckTm{2};
   uint8_t _clk {};
   uint8_t _dio {}; 
 
   virtual void _unAbstract() = 0; // Makes this an Abstract class explicitly for documentation generation.   
   void _updLclBffrCntnt();
 
protected:
   uint8_t* _lclDspBuffPtr{nullptr};    
   uint8_t _dspDigitsQtyMax{}; // Maximum display size in digits
 
   void _txStart();
   void _txAsk();
   void _txStop();
   void _txWrByte(uint8_t data);
   virtual void _sendBffr();
   virtual bool _sendByte(uint8_t data);   
   
 public:
   SevenSegTM163X();
   SevenSegTM163X(uint8_t* ioPins, uint8_t dspDigits, bool commAnode, uint8_t dspDigitsQtyMax = 0);
   ~SevenSegTM163X();
   bool begin(uint32_t updtLps = 0);
   bool end();
   virtual uint8_t getBrghtnssLvl();
   virtual void ntfyUpdDsply();
   virtual bool setBrghtnssLvl(const uint8_t &newBrghtnssLvl); 
   virtual void turnOff();
   virtual void turnOn();
   virtual void turnOn(const uint8_t &newBrghtnssLvl);
};
 
//============================================================> Class declarations separator

class SevenSegTM1636: public SevenSegTM163X{
private:
   virtual void _unAbstract();
 
protected:
   const uint8_t _dspDigitsQtyMax{4}; // Maximum display controller managing digits capabilities
 
public:
   SevenSegTM1636();
   SevenSegTM1636(uint8_t* ioPins, uint8_t dspDigits, bool commAnode);
   virtual ~SevenSegTM1636();
};
       
//============================================================> Class declarations separator

class SevenSegTM1637: public SevenSegTM163X{
private:
   const uint8_t _dspDigitsQtyMax{6}; // Maximum display size in digits
   virtual void _unAbstract();
 
public:
   SevenSegTM1637();
   SevenSegTM1637(uint8_t* ioPins, uint8_t dspDigits, bool commAnode);
   ~SevenSegTM1637();
};
 
//============================================================> Class declarations separator

class SevenSegTM1639: public SevenSegTM163X{
private:
   const uint8_t _dspDigitsQtyMax{8}; // Maximum display size in digits
   virtual void _unAbstract();
 
public:
   SevenSegTM1639();
   SevenSegTM1639(uint8_t* ioPins, uint8_t dspDigits, bool commAnode);
   ~SevenSegTM1639();
};
 
//============================================================> Class declarations separator

class SevenSegMax7219: public SevenSegStatic{
   // Address Map Constants
   const uint8_t _NoOpAddr{0x00};
   const uint8_t _DspPortsBaseAddr{0x01};
   const uint8_t _DecodeModeAddr{0x09};
   const uint8_t _BrghtnsSettAddr{0x0A};
   const uint8_t _ScanLimitAddr{0x0B};
   const uint8_t _ShutDownAddr{0x0C};
   const uint8_t _DspTestAddr{0x0F};
 
   // Valid parameters constants
   const uint8_t _DisplayTestMode{0x01};
   const uint8_t _NoDecode{0x00};
   const uint8_t _NormalOp{0x00};
   const uint8_t _TurnOff{0x00};
   const uint8_t _TurnOn{0x01};
 
private:
   const uint8_t _clkIndx {0};
   const uint8_t _dinIndx {1};
   const uint8_t _csIndx {2};
 
   const uint8_t _dspDigitsQtyMax{8};
   const uint8_t _hwBrghtnssLvlMax{0x0F};
   const uint8_t _hwBrghtnssLvlMin{0x00};
 
   uint8_t _clk {};  // Serial clock max. rate 10 MHz. Data is shifted into the chip on **clk rising edge**
   uint8_t _din {};  // Data value to get into the chip reg, must be set before the clk rising edge to be accepted.
   uint8_t _cs {}; // The data in the internal 16 bits are accepted to be loaded while _cs is low, and will be latched and exposed to pins at _cs rising edge.
 
   uint8_t _cnvrtStdDgtTo72xxDgt(const uint8_t &StdDgt);
   virtual void _unAbstract();
   void _updLclBffrCntnt();
 
protected:
   uint8_t* _lclDspBuffPtr{nullptr};    
    
   virtual void _sendByte(const uint8_t &val, const bool &MSbFrst = true);
   virtual void _sendAddrData(const uint8_t &address, const uint8_t &data, const bool &MSbFrst = true);
   virtual void _sendBffr();
    
public:
   SevenSegMax7219();    
   SevenSegMax7219(uint8_t* ioPins, uint8_t dspDigits);
   ~SevenSegMax7219();
   bool begin(uint32_t updtLps = 0);
   bool end();
   virtual bool getIsOn();
   virtual void ntfyUpdDsply();
   virtual bool setBrghtnssLvl(const uint8_t &newBrghtnssLvl); 
   virtual void turnOff();
   virtual void turnOn();
   virtual void turnOn(const uint8_t &newBrghtnssLvl);
};
 
//============================================================> Class declarations separator
 
#endif