Loom_OLED.h

#pragma once
 
#include "Loom_Manager.h"
#include "Module.h"
 
#include <Adafruit_SSD1306.h>
 
 
class Loom_OLED : public Module{
    protected:
 
        void power_up() override {};
        void power_down() override {}; 
        
        
        // Manager controlled functions
        void measure() override {};
        void initialize() override;
        void package() override {};
        void display_data() override;
 
    public:
 
        enum class Version {
            FEATHERWING,    // FeatherWing OLED
            BREAKOUT        // Breakout board
        };
 
        enum class Format {
            FOUR,           // 4 Key values
            EIGHT,          // 8 Key values
            SCROLL          // Scrolling
        };
 
        enum class FreezeType {
            DISABLE,        // Freeze disabled
            DATA,           // Screen freezes
            SCROLL          // Scroll freezes, data updates
        };
 
        Loom_OLED(
                Manager&            man,
                const bool          enable_rate_filter      = true,
                const uint16_t      min_filter_delay        = 300,
                const Version       type                    = Version::FEATHERWING,
                const byte          reset_pin               = A2,
                const Format        display_format          = Format::SCROLL,
                const uint16_t      scroll_duration         = 6000,
                const byte          freeze_pin              = 10,
                const FreezeType    freeze_behavior         = FreezeType::SCROLL
            );
 
        /* Destructor for the display pointer */
        ~Loom_OLED();
 
    private:
        bool canWrite();                        // Returns whether or not we can write to the display yet
        void flattenJSONObject(JsonObject json);// Flattens the given JSON object so we can display it
 
        Manager*            manInst;            // Pointer to the manager
 
        Adafruit_SSD1306*   display = nullptr;  // Underlying OLED controller
        uint16_t            min_filter_delay;   // Time to wait in between updates
        Version             version;            // What type the OLED is (FeatherWing or breakout)
        byte                reset_pin;          // The reset pin (only applies to breakout version)
 
        Format              display_format;     // How to display the data on OLED
        uint                scroll_duration;    // The duration to complete a full cycle through a bundle of data (milliseconds)(non-blocking)
        byte                freeze_pin;         // Which pin to check if display should freeze
        FreezeType          freeze_behavior;    // What 'freezing' behavior should be followed
 
        unsigned long       lastLogTime;        // Value of millis() at the last log
        unsigned long       previous_time;      // Used to handle scrolling
        DynamicJsonDocument flattenedDoc;  // Flattened object 
 
 
};