MD_RobotEyes.h

Go to the documentation of this file.

// Implements a class to draw and animate a pair of 'emotive' eyes for a robot
//
#pragma once
 
#include "Led-Matrix-SOLDERED.h"
 
// Misc defines
#define ARRAY_SIZE(a) (sizeof(a) / sizeof(a[0])) 
#define EYE_COL_SIZE  8                          
 
// Module offsets from first module specified
#define LEFT_MODULE_OFFSET  1 
#define RIGHT_MODULE_OFFSET 0 
 
// Array references for eyeData array below
#define LEFT_EYE_INDEX  1 
#define RIGHT_EYE_INDEX 0 
 
// Basic unit of time a frame is displayed
#define FRAME_TIME 100 
 
class MD_RobotEyes
{
  public:
    //
    typedef enum
    {
        E_NONE,    
        E_NEUTRAL, 
        E_BLINK,   
        E_WINK,    
        E_LOOK_L,  
        E_LOOK_R,  
        E_LOOK_U,  
        E_LOOK_D,  
        E_ANGRY,   
        E_SAD,     
        E_EVIL,    
        E_EVIL2,   
        E_SQUINT,  
        E_DEAD,    
        E_SCAN_UD, 
        E_SCAN_LR, 
    } emotion_t;
 
    MD_RobotEyes(void);
 
    ~MD_RobotEyes(void){};
 
    void begin(Led_Matrix *M, uint8_t moduleStart = 0);
 
    inline void setAnimation(emotion_t e, bool r, bool b = false)
    {
        _nextEmotion = e;
        _autoReverse = r;
        _animReverse = b;
    };
 
    inline void setBlinkTime(uint16_t t)
    {
        _timeBlinkMinimum = t;
    };
 
    inline void setAutoBlink(bool b)
    {
        _autoBlink = b;
    };
 
    inline bool setText(const char *pText)
    {
        if (_pText != nullptr)
            return (false);
        else
            _pText = pText;
        return (true);
    };
 
    bool runAnimation(void);
 
  protected:
    // Animations FSM state
    typedef enum
    {
        S_IDLE,
        S_RESTART,
        S_ANIMATE,
        S_PAUSE,
        S_TEXT,
    } animState_t;
 
    // Define an animation frame
    struct animFrame_t
    {
        uint8_t eyeData[2]; // [LEFT_MODULE_OFFSET] and [RIGHT_MODULE_OFFSET] eye character from font data
        uint16_t timeFrame; // Time for this frame in milliseconds
    };
 
    // Define an entry in the animation sequence lookup table
    struct animTable_t
    {
        emotion_t e;
        const animFrame_t *seq;
        uint8_t size;
    };
 
    // Display parameters
    Led_Matrix *_M;
    uint16_t _sd; // Start module for the display
 
    // Animation parameters
    uint32_t _timeStartPause;
    uint32_t _timeLastAnimation;
    uint16_t _timeBlinkMinimum;
    animState_t _animState;
    bool _autoBlink;
    uint16_t _scrollDelay;
 
    // Animation control data
    animTable_t _animEntry; // Record with animation sequence parameters
    int8_t _animIndex;      // Current index in the animation sequence
    bool _animReverse;      // True = reverse sequence, false = normal sequence
    bool _autoReverse;      // True = always play the reverse, false = selected direction only
    emotion_t _nextEmotion; // The next emotion to display
    const char *_pText;     // Pointer to text data in user code. Not nullptr means there is text to print
 
    // Methods
    void loadEye(uint8_t module, uint8_t ch);
    void drawEyes(uint8_t L, uint8_t R);
    uint8_t loadSequence(emotion_t e); // Return the size of the sequence
    void loadFrame(animFrame_t *pBuf);
    void showText(bool bInit = false);
 
    void dumpSequence(const animFrame_t *pBuf, uint8_t numElements); // Debugging routine only
 
    // Static data tables
    static const animFrame_t seqBlink[], seqWink[];
    static const animFrame_t seqLeft[], seqRight[], seqUp[], seqDown[];
    static const animFrame_t seqAngry[], seqSad[], seqEvil[], seqEvil2[];
    static const animFrame_t seqSquint[], seqDead[];
    static const animFrame_t seqScanUpDown[], seqScanLeftRight[];
 
    // Lookup table to find animation
    static const animTable_t lookupTable[];
};