Display Namespace Reference

The display module controls the visual signals to the user. More...

Enumerations
enum	Color : uint8_t { Red = Hardware::LED_Red, Green = Hardware::LED_Green }
	The color for the display. More...

Functions
void	flash (Color color, uint8_t flashCount)
	Display a number of flashes. More...
void	modulateLed (Color color, uint8_t pwmValue)
	One cycle of a modulated LED. More...
void	pulse (Color color)
	Smooth Pulse one time. More...
void	dimSignal (Color color)
	Very short dim signal. More...

Detailed Description

The display module controls the visual signals to the user.

Enumeration Type Documentation

Color

enum Display::Color : uint8_t

The color for the display.

Enumerator
Red	Display a red color.
Green	Display a green color.

Definition at line 34 of file Display.h.

           : uint8_t {
    Red = Hardware::LED_Red,     
    Green = Hardware::LED_Green, 
};

Function Documentation

dimSignal()

void Display::dimSignal

(

Color

color

)

Very short dim signal.

Parameters

color

The color for the signal.

Definition at line 73 of file Display.cpp.

{
    for (uint16_t i = 0; i < Configuration::cDisplayDimSignalCycles; ++i) {
        modulateLed(color, Configuration::cDisplayDimSignalPwm);
    }
}

flash()

void Display::flash	(	Color	color,
		uint8_t	flashCount
	)

Display a number of flashes.

Parameters

color	The color for the flash.
flashCount	The number of flashes to show.

Definition at line 31 of file Display.cpp.

{
    for (uint8_t i = 0; i < flashCount; ++i) {
        if (i > 0) {
            Tool::delayMs(Configuration::cDisplayFlashPauseMs);
        }
        Hardware::setLedState(static_cast<Hardware::LedState>(color));
        Tool::delayMs(Configuration::cDisplayFlashDurationMs);
        Hardware::setLedState(Hardware::LED_Off);
    }
}

modulateLed()

void Display::modulateLed	(	Color	color,
		uint8_t	pwmValue
	)

One cycle of a modulated LED.

Parameters

color	The color for the cycle.
pwmValue	The PWM value for the on state of the cycle.

Definition at line 49 of file Display.cpp.

{
    Hardware::setLedState(static_cast<Hardware::LedState>(color));
    Tool::delayCycles(pwmValue);
    Hardware::setLedState(Hardware::LED_Off);
    Tool::delayCycles(0xffu-pwmValue);
}

pulse()

void Display::pulse

(

Color

color

)

Smooth Pulse one time.

Parameters

color

The color for the pulse.

Definition at line 58 of file Display.cpp.

{
    for (uint8_t i = 1; i < Configuration::cDisplayPulseMaximumPwm; ++i) {
        for (uint8_t j = 0; j < Configuration::cDisplayPulseCyclesPerLevel; ++j) {
            modulateLed(color, i);
        }
    }
    for (uint8_t i = Configuration::cDisplayPulseMaximumPwm; i > 1; --i) {
        for (uint8_t j = 0; j < Configuration::cDisplayPulseCyclesPerLevel; ++j) {
            modulateLed(color, i);
        }
    }
}