MAX7219plus.h

Go to the documentation of this file.

 
#ifndef MAX7219PLUS_COMMON_H
#define MAX7219PLUS_COMMON_H
 
// Libraries
#include "seven_segment_font_data.h"
#include <SPI.h>
 
// --- SPI settings section ---
#define MAX_P_SPI_FREQ 1000000              
#define MAX_P_SPI_CLOCK_DIV SPI_CLOCK_DIV8  
#define MAX_P_SPI_DIRECTION  MSBFIRST       
#define MAX_P_SPI_MODE SPI_MODE0            
//There is a pre-defined macro SPI_HAS_TRANSACTION in SPI library for checking 
 //whether the firmware of the Arduino board supports SPI.beginTransaction().
#ifdef SPI_HAS_TRANSACTION
    #define MAX_P_SPI_TRANSACTION_START SPI.beginTransaction(SPISettings(MAX_P_SPI_FREQ, MAX_P_SPI_DIRECTION, MAX_P_SPI_MODE)) 
    #define MAX_P_SPI_TRANSACTION_END SPI.endTransaction()
#else // SPI transactions likewise not present in MCU or lib
    #define MAX_P_SPI_TRANSACTION_START SPI.setClockDivider(MAX_P_SPI_CLOCK_DIV) // 72/8 = 9Mhz
    #define MAX_P_SPI_TRANSACTION_END  // Blank 
#endif
 
class MAX7219plus_Model6 : public SevenSegmentFont , public CommonData
{
public:
    MAX7219plus_Model6(uint8_t chipSelect, uint8_t clock, uint8_t data, uint16_t CommDelay, uint8_t totalDisplays);
    MAX7219plus_Model6(uint8_t chipSelect, uint8_t totalDisplays);
 
    enum TextAlignment_e : uint8_t
    {
        AlignLeft       = 0,  
        AlignRight      = 1,  
        AlignRightZeros = 2   
    };
    
    enum DecodeMode_e : uint8_t
    {
        DecodeModeNone     = 0x00, 
        DecodeModeBCDOne   = 0x01, 
        DecodeModeBCDTwo   = 0x0F, 
        DecodeModeBCDThree = 0xFF  
    };
    enum CodeBFont_e : uint8_t
    {
        CodeBFontZero    = 0x00, 
        CodeBFontOne     = 0x01, 
        CodeBFontTwo     = 0x02, 
        CodeBFontThree   = 0x03, 
        CodeBFontFour    = 0x04, 
        CodeBFontFive    = 0x05, 
        CodeBFontSix     = 0x06, 
        CodeBFontSeven   = 0x07, 
        CodeBFontEight   = 0x08, 
        CodeBFontNine    = 0x09, 
        CodeBFontDash    = 0x0A, 
        CodeBFontE       = 0x0B, 
        CodeBFontH       = 0x0C, 
        CodeBFontL       = 0x0D, 
        CodeBFontP       = 0x0E, 
        CodeBFontSpace   = 0x0F  
    };
    enum Intensity_e : uint8_t
    {
        IntensityMin     = 0x00, 
        IntensityDefault = 0x08, 
        IntensityMax     = 0x0F  
    };
    enum ScanLimit_e : uint8_t
    {
        ScanOneDigit      = 0x00,  
        ScanTwoDigit      = 0x01,  
        ScanThreeDigit    = 0x02,  
        ScanFourDigit     = 0x03,  
        ScanFiveDigit     = 0x04,  
        ScanSixDigit      = 0x05,  
        ScanSevenDigit    = 0x06,  
        ScanEightDigit    = 0x07   
    };
 
    enum RegisterModes_e : uint8_t
    {
        MAX7219_REG_NOP          = 0x00, 
        MAX7219_REG_DecodeMode   = 0x09, 
        MAX7219_REG_Intensity    = 0x0A, 
        MAX7219_REG_ScanLimit    = 0x0B, 
        MAX7219_REG_ShutDown     = 0x0C, 
        MAX7219_REG_DisplayTest  = 0x0F  
    };
 
    void InitDisplay(ScanLimit_e numDigits, DecodeMode_e decodeMode);
    void ClearDisplay(void);
    void SetBrightness(uint8_t brightness);
    void DisplayTestMode(bool OnOff);
    void ShutdownMode(bool OnOff);
 
    uint16_t GetCommDelay(void);
    void SetCommDelay(uint16_t commDelay);
    bool GetHardwareSPI(void);
    uint8_t GetCurrentDisplayNumber(void);
    void SetCurrentDisplayNumber(uint8_t);
 
    void DisplayChar(uint8_t digit, uint8_t value, DecimalPoint_e decimalPoint);
    int DisplayText(char *text, TextAlignment_e TextAlignment);
    int DisplayText(char *text);
    void DisplayIntNum(unsigned long number, TextAlignment_e TextAlignment);
    void DisplayDecNumNibble(uint16_t  numberUpper, uint16_t numberLower, TextAlignment_e TextAlignment);
    void DisplayBCDChar(uint8_t digit, CodeBFont_e value);
    int DisplayBCDText(char *text);
    void SetSegment(uint8_t digit, uint8_t segment);
 
protected:
 
 
private:
 
    uint8_t _Display_CS;     
    uint8_t _Display_SDATA;  
    uint8_t _Display_SCLK;   
    uint16_t _CommDelay = 0;    
    uint8_t _NoDigits   = 8;    
    bool _HardwareSPI = false;  
    DecodeMode_e CurrentDecodeMode; 
    uint8_t _CurrentDisplayNumber = 1; 
    uint8_t _NoDisplays = 1;           
    void HighFreqshiftOut(uint8_t value);
    void WriteDisplay(uint8_t RegisterCode, uint8_t data);
    uint8_t ASCIIFetch(uint8_t character,DecimalPoint_e decimalPoint);
    void SetDecodeMode(DecodeMode_e mode);
    void SetScanLimit(ScanLimit_e numDigits);
    uint8_t flipBitsPreserveMSB(uint8_t byte);
    void CommStart(void);
    void CommEnd(void);
};
 
#endif