IUserInterface.h File Reference

#include <Mutex.h>
#include <cstdarg>
#include <cstdint>

Include dependency graph for IUserInterface.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	IUserInterface
	Manages the user interface The user interface can consist of buttons, LED, serial print ports, etc. It is not a graphical interface. The board will communicate its state via the UI and the user can send commands via the UI. More...

Typedefs
typedef void(*	buttonCallbackFunction_t) (void *instance)
	Prototype for a callback from a button press. More...

Enumerations
enum	RgbColor {   RgbColor::RED = 0, RgbColor::GREEN, RgbColor::BLUE, RgbColor::VIOLET,   RgbColor::TEAL, RgbColor::YELLOW, RgbColor::WHITE, RgbColor::OFF }
	Possible colors obtainable with an RGB LED. More...
enum	Button { Button::BUTTON_0 = 0, Button::BUTTON_1 }
	Buttons present on the board. More...
enum	LED { LED::LED_0 = 0, LED::LED_1, LED::LED_2 }
	LED present on the board. More...

Variables
constexpr uint16_t	g_brButton = static_cast<uint16_t>(Button::BUTTON_1) + 1
constexpr uint16_t	g_nbrLED = static_cast<uint16_t>(LED::LED_2) + 1

Typedef Documentation

buttonCallbackFunction_t

typedef void(* buttonCallbackFunction_t) (void *instance)

Prototype for a callback from a button press.

Enumeration Type Documentation

Button

enum Button

strong

Buttons present on the board.

Enumerator
BUTTON_0
BUTTON_1

LED

enum LED

strong

LED present on the board.

Enumerator
LED_0
LED_1
LED_2

RgbColor

enum RgbColor

strong

Possible colors obtainable with an RGB LED.

Enumerator
RED
GREEN
BLUE
VIOLET
TEAL
YELLOW
WHITE
OFF

Variable Documentation

g_brButton

constexpr uint16_t g_brButton = static_cast<uint16_t>(Button::BUTTON_1) + 1

constexpr

g_nbrLED

constexpr uint16_t g_nbrLED = static_cast<uint16_t>(LED::LED_2) + 1

constexpr