SegLCDLib.h

Go to the documentation of this file.

#ifndef SEGLCDLIB_H
#define SEGLCDLIB_H
 
#include <stddef.h>
 
#include "SegBacklight.h"
 
#ifdef ARDUINO
#include <Arduino.h>
#include "Print.h"
#endif
 
typedef enum {
    MODE_DRIVE_STATIC = 1, 
    MODE_DRIVE_12 = 2,     
    MODE_DRIVE_13 = 3,     
    MODE_DRIVE_14 = 0      
} ModeDrive;
 
typedef enum {
    MODE_BIAS_13 = 0, 
    MODE_BIAS_12 = 1  
} ModeBias;
 
#ifdef ARDUINO
class SegLCDLib : public Print {
#else
class SegLCDLib {
#endif
    public:
        enum BacklightMode {
            BACKLIGHT_DIGITAL,  
            BACKLIGHT_PWM       
        };
 
        SegLCDLib() = default;
 
        virtual ~SegLCDLib();
 
        SegLCDLib(const SegLCDLib&) = delete;
        SegLCDLib& operator=(const SegLCDLib&) = delete;
 
        // ---------------------------
        // LCD API 1.0 Mandatory part
        // ---------------------------
        // Spec: https://playground.arduino.cc/Code/LCDAPI/
 
        virtual void init();
 
        virtual void clear();
 
        void home();
 
        virtual void setCursor(uint8_t row, uint8_t col);
 
        virtual size_t write(uint8_t) { return 0; };
 
        size_t write(const char *str);
 
        size_t write(const char *buffer, size_t size);
 
        virtual void command(uint8_t command) = 0;
        #ifdef ARDUINO
        using Print::write;
        #endif
 
        // --------------------------
        // LCD API 1.0 Optional part
        // --------------------------
        virtual void on() = 0;
 
        virtual void off() = 0;
 
        void initBacklight(SegBacklight *backlight, BacklightMode backlightMode = BACKLIGHT_DIGITAL);
 
        virtual void setBacklight(bool state);
 
        virtual void setBacklight(int brightness);
 
        // ----------------------
        // Flush/Autoflush API
        // ----------------------
 
        void setAutoFlush(bool enable);
 
        bool getAutoFlush() const;
 
        virtual void flush();
 
        virtual void flush(uint8_t startAddr, uint8_t length);
 
        const uint8_t* getRamBuffer() const;
 
        size_t getRamBufferSize() const;
 
        // ----------------------
        // SegLCDLib specific part
        // ----------------------
 
    protected:
        bool _autoFlush = true;
 
        SegBacklight *_backlight = nullptr;
 
        BacklightMode _backlightMode = BACKLIGHT_DIGITAL;
 
        uint8_t _backlightBrightness = 0;
 
        uint8_t _displayFlags = 0;
 
        static constexpr uint8_t FLAG_PENDING_DOT = 0x80;
 
        void _setFlag(uint8_t mask);
 
        void _clearFlag(uint8_t mask);
 
        bool _isFlagSet(uint8_t mask) const;
 
        void _clearAllFlags();
 
        bool _dotWrite(uint8_t ch, int8_t minCol, int8_t maxCol, int8_t ramOffset);
 
        void _dotClearCur(int8_t minCol, int8_t maxCol);
 
        void _colonClearIfNotFlagged(uint8_t ch, uint8_t colonCol, uint8_t colonFlag);
 
        virtual void _setDecimal(uint8_t, uint8_t, bool) { }
 
        virtual void _setColon(uint8_t, uint8_t, bool) { }
 
        uint8_t* _ramBuffer = nullptr;
 
        size_t _ramBufferSize = 0;
 
        void _allocateBuffer(size_t size);
 
        void _writeRamMasked(uint8_t data, uint8_t address, uint8_t mask = 0xFF);
 
        void _writeRam(uint8_t data, uint8_t address = 0);
 
        virtual void _writeRam(uint8_t *data, size_t length, uint8_t address) = 0;
 
        uint8_t _get_char_value(char ch);
 
        uint16_t _get_16char_value(char ch);
 
 
        uint8_t _cursorRow = 0;
 
        uint8_t _cursorCol = 0;
};
 
#endif