jbwopr.h

Go to the documentation of this file.

 
#ifndef ARDUINO_JBWOPR_JBWOPR_H
#define ARDUINO_JBWOPR_WOPR_H
 
#include <Arduino.h>
#include <map>
#include <list>
//#include <driver/i2s.h>
#include <jblogger.h>
#include <Adafruit_GFX.h>                   // https://github.com/adafruit/Adafruit-GFX-Library
#include <Adafruit_LEDBackpack.h>           // https://github.com/adafruit/Adafruit_LED_Backpack
#include <Adafruit_NeoPixel.h>              // https://github.com/adafruit/Adafruit_NeoPixel
#include <OneButton.h>                      // https://github.com/mathertel/OneButton
#include <ArduinoJson.h>                    // https://github.com/bblanchon/ArduinoJson
#include "effects/jbwopreffects.h"
#include "jbwoprhelpers.h"
 
#define LIBRARY_VERSION "1.0.2";
 
enum JBWoprBoardVariant {
    ORIGINAL = 0,                           
    HAXORZ                                  
};
 
enum JBDefconLevel {
    DEFCON_1 = 0,                           
    DEFCON_2,                               
    DEFCON_3,                               
    DEFCON_4,                               
    DEFCON_5,                               
    DEFCON_NONE                             
};
 
struct JBWoprBoardPins {
    uint8_t buttonFrontLeftPin;             
    uint8_t buttonFrontRightPin;            
    uint8_t buttonBackTopPin;               
    uint8_t buttonBackBottomPin;            
    uint8_t defconLedsPin;                  
    uint8_t dacPin;                         
};
 
struct JBWoprConfiguration {
    std::string timeFormat;                 
    std::string dateFormat;                 
    uint8_t displayBrightness;              
    uint32_t defconLedsBrightness;          
    uint32_t effectsTimeout;                
};
 
 
// ====================================================================
//
// W.O.P.R. base device class
//
// ====================================================================
class JBWoprDevice {
public:
    // ====================================================================
    // General
    //
    JBWoprDevice();
 
    virtual bool begin(JBWoprBoardVariant variant = JBWoprBoardVariant::ORIGINAL);
 
    virtual bool begin(JBWoprBoardVariant variant, JBWoprBoardPins pins);
 
    virtual void loop();
 
    JBWoprBoardVariant getBoardVariant();
 
    // ====================================================================
    // Configuration
    //
    JBWoprConfiguration* getConfiguration();
 
    // ====================================================================
    // Logger
    //
    virtual void setLogLevel(LogLevel level);
 
    virtual LogLevel getLogLevel();
 
    // ====================================================================
    // Effects
    //
    void effectsRegisterDefaultEffect(JBWoprEffectBase* effect);
 
    bool effectsDefaultEffectIsRunning();
 
    void effectsRegisterEffect(JBWoprEffectBase* effect);
 
    std::vector<JBWoprEffectBase*> effectsGetRegisteredEffects();
 
    JBWoprEffectBase* effectsGetCurrentEffect();
 
    virtual void effectsStartCurrentEffect();
 
    virtual void effectsStopCurrentEffect();
 
    bool effectsCurrentEffectIsRunning();
 
    virtual void effectsStartEffect(JBWoprEffectBase* effect);
 
    virtual void effectsStartEffect(const std::string& name);
 
    virtual void effectsStartEffect(const char* name);
 
    // ====================================================================
    // Display
    //
    std::array<Adafruit_AlphaNum4, 3> getDisplay();
 
    virtual void displaySetState(bool state);
 
    virtual void displayClear();
 
    virtual void displayShow();
 
    virtual void displaySetBrightness(uint8_t val);
 
    virtual void displaySetChar(uint8_t index, char chr);
 
    virtual void displayShowText(const char* text, JBTextAlignment alignment);
 
    virtual void displayShowText(const std::string& text, JBTextAlignment alignment);
 
    virtual void displayShowText(const String& text, JBTextAlignment alignment);
 
    virtual void displayShowText(const char* text);
 
    virtual void displayShowText(const std::string& text);
 
    virtual void displayShowText(const String& text);
 
    virtual void displayScrollText(const char* text, uint16_t delay_ms);
 
    virtual void displayScrollText(const String& text, uint16_t delay_ms);
 
    virtual void displayScrollText(const std::string& text, uint16_t delay_ms);
 
    virtual void displayScrollText(const char* text);
 
    virtual void displayScrollText(const std::string& text);
 
    virtual void displayScrollText(const String& text);
 
    // ====================================================================
    // DEFCON LEDs
    //
    const char* DEFCON_STRINGS[6] { "DEFCON 1", "DEFCON 2", "DEFCON 3", "DEFCON 4", "DEFCON 5", "None" };
 
    Adafruit_NeoPixel* getDefconLeds();
 
    virtual void defconLedsSetState(bool state);
 
    virtual void defconLedsSetBrightness(uint8_t brightness);
 
    virtual void defconLedsSetDefconLevel(JBDefconLevel level);
 
    virtual void defconLedsSetColor(uint32_t color);
 
    virtual void defconLedsClear();
 
    // Individual DEFCON LEDs
    virtual void defconLedSetColor(JBDefconLevel level, uint32_t color);
 
    virtual void defconLedSetDefconStateColor(JBDefconLevel level, uint32_t color);
 
    // ====================================================================
    // Audio
    //
    void audioPlayTone(const uint16_t freq);
 
    void audioPlayNote(note_t note, uint8_t octave);
 
    void audioClear();
 
    // ====================================================================
    // Buttons
    //
    OneButton* getButtonFrontLeft();
 
    OneButton* getButtonFrontRight();
 
    OneButton* getButtonBackTop();
 
    OneButton* getButtonBackBottom();
 
    virtual void buttonFrontLeftSetClickCallback( std::function<void()> func );
 
    virtual void buttonFrontLeftSetDoubleClickCallback( std::function<void()> func );
 
    virtual void buttonFrontRightSetClickCallback( std::function<void()> func );
 
    virtual void buttonFrontRightSetDoubleClickCallback( std::function<void()> func );
 
    virtual void buttonBackTopSetClickCallback( std::function<void()> func );
 
    virtual void buttonBackTopSetDoubleClickCallback( std::function<void()> func );
 
    virtual void buttonBackBottomSetClickCallback( std::function<void()> func );
 
    virtual void buttonBackBottomSetDoubleClickCallback( std::function<void()> func );
 
protected:
    // ====================================================================
    // Configuration
    //
    JBWoprBoardVariant _woprVariant;                
    JBWoprConfiguration _config;                    
    JBWoprBoardPins _pins;                          
 
    // ====================================================================
    // Effects
    //
    JBWoprEffectBase* _defaultEffect = nullptr;     
    std::vector<JBWoprEffectBase*> _effects;        
    JBWoprEffectBase* _currentEffect = nullptr;     
    uint32_t _effectsCounter = 0;                   
 
    // ====================================================================
    // Display
    //
    std::array<Adafruit_AlphaNum4, 3> _display;     
    bool _displayState = true;                      
    uint32_t _displayBrightness = 100;              
 
    // ====================================================================
    // Defcon LEDs
    //
    Adafruit_NeoPixel _defconLeds = Adafruit_NeoPixel(5, 1, NEO_GRB + NEO_KHZ800);  
    bool _defconState = true;                                       
    JBDefconLevel _defconLevel = JBDefconLevel::DEFCON_NONE;        
    uint32_t _defconColors[5];                                      
    uint32_t _defconBrightness = 100;                               
    uint32_t _defconLedsColor = 0;                                  
 
    // Note - due to how Adafruit_Neopixel handles brigthness, we buffer the LED colors into the
    // _defconPixels variable together with the current brightness value.
    // We then apply them both before calling show().
    uint32_t _defconPixels[5] { 0,0,0,0,0}; 
    uint32_t _defconBrigthtness = 100;                              
 
    JBDefconLevel _getDefconLevel(std::string value);
 
    std::string _getDefconLevelString(JBDefconLevel level);
 
    uint32_t _getDefconLedsPixel(JBDefconLevel level);
 
    // ====================================================================
    // Buttons
    //
    OneButton* _buttonFrontLeft;                                        
    OneButton* _buttonFrontRight;                                       
    OneButton* _buttonBackTop;                                          
    OneButton* _buttonBackBottom;                                       
 
    std::function<void()> _buttonFrontLeftClickCallback;                
    std::function<void()> _buttonFrontLeftDoubleClickCallback;          
    std::function<void()> _buttonFrontRightClickCallback;               
    std::function<void()> _buttonFrontRightDoubleClickCallback;         
    std::function<void()> _buttonBackTopClickCallback;                  
    std::function<void()> _buttonBackTopDoubleClickCallback;            
    std::function<void()> _buttonBackBottomClickCallback;               
    std::function<void()> _buttonBackBottomDoubleClickCallback;         
 
    static void _staticButtonFrontLeftClickCallback(void* data);        
    static void _staticButtonFrontLeftDoubleClickCallback(void* data);  
    static void _staticButtonFrontRightClickCallback(void* data);       
    static void _staticButtonFrontRightDoubleClickCallback(void* data); 
    static void _staticButtonBackTopClickCallback(void* data);          
    static void _staticButtonBackTopDoubleClickCallback(void* data);    
    static void _staticButtonBackBottomClickCallback(void* data);       
    static void _staticButtonBackBottomDoubleClickCallback(void* data); 
 
    virtual void _buttonFrontLeftClick();                               
    virtual void _buttonFrontLeftDoubleClick();                         
    virtual void _buttonFrontRightClick();                              
    virtual void _buttonFrontRightDoubleClick();                        
    virtual void _buttonBackTopClick();                                 
    virtual void _buttonBackTopDoubleClick();                           
    virtual void _buttonBackBottomClick();                              
    virtual void _buttonBackBottomDoubleClick();                        
 
    // ====================================================================
    // Audio
    bool _useDAC = false;                   
    int _audioFreq = 2000;                  
    int _audioChannel = 0;                  
    int _audioResolution = 8;               
 
private:
    // ====================================================================
    // Logger
    JBLogger* _log;                                 
};
 
#endif //ARDUINO_WOPR_WOPR_H