IUserInterface.h

Go to the documentation of this file.

#ifndef __IUSERINTERFACE_H_
#define __IUSERINTERFACE_H_
 
#include <Mutex.h>
#include <cstdarg>
#include <cstdint>
 
enum class RgbColor { RED = 0, GREEN, BLUE, VIOLET, TEAL, YELLOW, WHITE, OFF };
 
enum class Button { BUTTON_0 = 0, BUTTON_1 };
constexpr uint16_t g_brButton = static_cast<uint16_t>(Button::BUTTON_1) + 1;
 
enum class LED { LED_0 = 0, LED_1, LED_2 };
constexpr uint16_t g_nbrLED = static_cast<uint16_t>(LED::LED_2) + 1;
 
typedef void (*buttonCallbackFunction_t)(void* instance);
 
class IUserInterface {
  public:
    virtual ~IUserInterface() = default;
 
    virtual Mutex& getPrintMutex() = 0;
 
    virtual void flush() = 0;
 
    virtual int print(const char* format, ...) = 0;
 
    virtual int print(const char* format, va_list args) = 0;
 
    virtual int printLine(const char* format, ...) = 0;
 
    virtual int printLine(const char* format, va_list args) = 0;
 
    virtual void setRGBLed(RgbColor color) = 0;
 
    virtual void setLed(LED led, bool state) = 0;
 
    virtual void setHexDisplay(uint8_t value) = 0;
 
    virtual void setButtonCallback(Button button,
                                   buttonCallbackFunction_t callback,
                                   void* context) = 0;
};
 
#endif // __IUSERINTERFACE_H_