RoverBuzzer class provides the member functions related to embedded buzzer on the rover. More...

#include <rover_buzzer.hpp>

Inheritance diagram for rover::RoverBuzzer:

Public Member Functions
	RoverBuzzer ()
	RoverBuzzer classs constructor. More...

void	initialize (void)
	Initializes the RoverBuzzer that is instantiated. More...

void	setBuzzerFrequency (const int buzzer_freq)
	Sets the default buzzer frequency in Hz. Values between 0-1000 Hz are conventionally used for the buzzer frequency. More...

int	getBuzzerFrequency (void)
	Retrieves the default buzzer frequency in Hz. More...

void	setBuzzerOn (void)
	Plays the buzzer with the default frequency. More...

void	setBuzzerOff (void)
	Turns off the buzzer. More...

void	setBuzzerPin (const int pin)
	Overrides the default buzzer pin in wiringPi format. More...

void	setBuzzerTone (const int buzzer_freq)
	Plays the buzzer with custom buzzer frequency. More...

void	shutdownTone (void)
	Plays the shutdown tone. More...

Public Member Functions inherited from rover::RoverGpio
	RoverGpio ()
	Constructor function for the RoverGpio class. More...

void	wPiDigitalWrite (const int pin, const int value)
	Wrapper function to wiringPi's digitalWrite function. More...

int	wPiDigitalRead (const int pin)
	Wrapper function to wiringPi's digitalRead function. More...

void	wPiPinMode (const int pin, const int set_val)
	Wrapper function to wiringPi's pinMode function. More...

void	wPiSoftToneCreate (const int pin)
	Wrapper function to wiringPi's softToneCreate function. Sets up a pin to have PWM soft tone output. More...

void	wPiSoftToneWrite (const int pin, const int tone)
	Wrapper function to wiringPi's softToneWrite function. Sets up a pin to have PWM soft tone output. More...

void	wPiDelay (const unsigned int period_ms)
	Delay function. Blocks some time in milliseconds. More...

Private Attributes
int	BUZZER_PIN
	Buzzer pin in wiringPi format. More...

int	BUZZER_FREQUENCY
	Default buzzer frequency used by setBuzzerOn function. More...

int	ROVERBUZZER_INIT_
	Flag to hold if RoverBuzzer is initialized. More...

Static Private Attributes
static const int	DEFAULT_BUZZER_PIN = 28
	Embedded buzzer pin on rover in wiringPi format. More...

Additional Inherited Members
Static Public Attributes inherited from rover::RoverGpio
static const int	INPUT_ = 0
	Static definition for INPUT pin mode for wPiPinMode function. More...

static const int	OUTPUT_ = 1
	Static definition for OUTPUT pin mode for wPiPinMode function. More...

static const int	PWM_OUTPUT_ = 2
	Static definition for PWM_OUTPUT pin mode for wPiPinMode function. More...

static const int	GPIO_CLOCK_ = 3
	Static definition for GPIO_CLOCK pin mode for wPiPinMode function. More...

static const int	SOFT_PWM_OUTPUT_ = 4
	Static definition for SOFT_PWM_OUTPUT pin mode for wPiPinMode function. More...

static const int	SOFT_TONE_OUTPUT_ = 5
	Static definition for SOFT_TONE_OUTPUT pin mode for wPiPinMode function. More...

static const int	PWM_TONE_OUTPUT_ = 6
	Static definition for PWM_TONE_OUTPUT pin mode for wPiPinMode function. More...

static const int	LO = 0
	Static definition for digital voltage level : LOW. More...

static const int	HI = 1
	Static definition for digital voltage level : HIGH. More...

Detailed Description

RoverBuzzer class provides the member functions related to embedded buzzer on the rover.

Constructor & Destructor Documentation

rover::RoverBuzzer::RoverBuzzer ( )

RoverBuzzer classs constructor.

Member Function Documentation

int rover::RoverBuzzer::getBuzzerFrequency ( void )

Retrieves the default buzzer frequency in Hz.

Returns: buzzer_freq Default buzzer frequency in Hz.

void rover::RoverBuzzer::initialize ( void )

Initializes the RoverBuzzer that is instantiated.

Returns: void

void rover::RoverBuzzer::setBuzzerFrequency ( const int buzzer_freq )

Sets the default buzzer frequency in Hz. Values between 0-1000 Hz are conventionally used for the buzzer frequency.

Parameters

buzzer_freq Buzzer frequency to be set in Hz

Returns: void

void rover::RoverBuzzer::setBuzzerOff ( void )

Turns off the buzzer.

Returns: void

void rover::RoverBuzzer::setBuzzerOn ( void )

Plays the buzzer with the default frequency.

Returns: void

void rover::RoverBuzzer::setBuzzerPin ( const int pin )

Overrides the default buzzer pin in wiringPi format.

Parameters

pin	in wiringPi format

Returns: void

void rover::RoverBuzzer::setBuzzerTone ( const int buzzer_freq )

Plays the buzzer with custom buzzer frequency.

Parameters

buzzer_freq Buzzer frequency to be set in Hz

Returns: void

void rover::RoverBuzzer::shutdownTone ( void )

Plays the shutdown tone.

Returns: void

Member Data Documentation

int rover::RoverBuzzer::BUZZER_FREQUENCY

private

Default buzzer frequency used by setBuzzerOn function.

int rover::RoverBuzzer::BUZZER_PIN

private

Buzzer pin in wiringPi format.

const int rover::RoverBuzzer::DEFAULT_BUZZER_PIN = 28

staticprivate

Embedded buzzer pin on rover in wiringPi format.

int rover::RoverBuzzer::ROVERBUZZER_INIT_

private

Flag to hold if RoverBuzzer is initialized.

The documentation for this class was generated from the following files:

/home/travis/build/app4mc-rover/rover-app/include/roverapi/rover_buzzer.hpp
/home/travis/build/app4mc-rover/rover-app/src/roverapi/rover_buzzer.cpp

Public Member Functions

Private Attributes

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation