BuzzerController Class Reference

#include <Buzzer.h>

Collaboration diagram for BuzzerController:

Public Member Functions
	BuzzerController (int duration_of_activation_ms)
void	deactivate ()
void	activate_buzzer (unsigned long act_time)
bool	done (unsigned long curr_time, bool buzzer_on)
bool	buzzer_is_on ()

Private Attributes
unsigned long	buzzer_period_
unsigned long	last_activation_time_
bool	buzzer_on_
bool	dash_buzzer_was_on = false

Detailed Description

Definition at line 5 of file Buzzer.h.

Constructor & Destructor Documentation

BuzzerController()

BuzzerController::BuzzerController ( int  duration_of_activation_ms )

inline

Definition at line 9 of file Buzzer.h.

                                                    {
        buzzer_period_ = duration_of_activation_ms;
    }

Member Function Documentation

activate_buzzer()

void BuzzerController::activate_buzzer

(

unsigned long

act_time

)

Definition at line 8 of file Buzzer.cpp.

{
    last_activation_time_ = act_time;
    buzzer_on_ = true;
}

buzzer_is_on()

bool BuzzerController::buzzer_is_on ( )

inline

Definition at line 16 of file Buzzer.h.

                        { 
        if(buzzer_on_){
            // Serial.println("buzzer should be on now");
        }    
        return buzzer_on_; 
    }

deactivate()

void BuzzerController::deactivate

(

)

Definition at line 3 of file Buzzer.cpp.

{
    buzzer_on_ = false;
    dash_buzzer_was_on = false;
}

done()

bool BuzzerController::done	(	unsigned long	curr_time,
		bool	buzzer_on
	)

Definition at line 16 of file Buzzer.cpp.

                                                                       {
 
    if (dash_buzzer_on) {
        dash_buzzer_was_on = true;
    }
 
    bool buzzer_time_up = (curr_time - last_activation_time_) >= buzzer_period_;
 
    //buzzer only turns off if the buzzer time is up and dash buzzer did turn on
    buzzer_on_ = !(buzzer_time_up && dash_buzzer_was_on);
 
    // only returns true (done) when the buzzer is finished buzzing
    return (!buzzer_on_ && !dash_buzzer_on);
    
}

Member Data Documentation

buzzer_on_

bool BuzzerController::buzzer_on_

private

Definition at line 26 of file Buzzer.h.

buzzer_period_

unsigned long BuzzerController::buzzer_period_

private

Definition at line 24 of file Buzzer.h.

dash_buzzer_was_on

bool BuzzerController::dash_buzzer_was_on = false

private

Definition at line 28 of file Buzzer.h.

last_activation_time_

unsigned long BuzzerController::last_activation_time_

private

Definition at line 25 of file Buzzer.h.

---

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

• lib/systems/include/Buzzer.h
• lib/systems/src/Buzzer.cpp