buzzer.h File Reference

Buzzer related functions. More...

Go to the source code of this file.

Macros
#define	WATCHDOG_TIMEOUT   1000000
	Watchdog timeout in microseconds. More...
#define	BUZZER_TIMER   TIM5
	Hardware Timer to use for the buzzer. More...
#define	BUZZER_TIM_CHANNEL   1
	Hardware Timer channel to use for the buzzer. More...

Functions
void	Buzzer_Init ()
	Initialization of HardwareTimer for buzzer. More...
void	Buzzer_Start (const uint32_t *Buzzer, uint32_t Size, bool RepeatBuzzer)
	Generic function to activate a buzzer. More...
void	Buzzer_Low_Prio_Start (void)
	Activate the buzzer pattern for low priority alarms. More...
void	Buzzer_Medium_Prio_Start (void)
	Activate the buzzer pattern for medium priority alarms. More...
void	Buzzer_High_Prio_Start (void)
	Activate the buzzer pattern for high priority alarms. More...
void	Buzzer_Boot_Start (void)
	Activate boot bip. More...
void	Buzzer_Mute (void)
	Mute the buzzer for 120s. More...
void	Buzzer_Resume (void)
	Resume the muted alarm. More...
void	Buzzer_Stop (void)
	Stop Buzzer. More...

Detailed Description

Buzzer related functions.

Author

Makers For Life

Copyright

Copyright (c) 2020 Makers For Life

Definition in file buzzer.h.

Macro Definition Documentation

BUZZER_TIM_CHANNEL

#define BUZZER_TIM_CHANNEL   1

Hardware Timer channel to use for the buzzer.

Definition at line 17 of file buzzer.h.

BUZZER_TIMER

#define BUZZER_TIMER   TIM5

Hardware Timer to use for the buzzer.

Definition at line 14 of file buzzer.h.

WATCHDOG_TIMEOUT

#define WATCHDOG_TIMEOUT   1000000

Watchdog timeout in microseconds.

Definition at line 11 of file buzzer.h.

Function Documentation

Buzzer_Boot_Start()

void Buzzer_Boot_Start

(

void

)

Activate boot bip.

Definition at line 194 of file buzzer.cpp.

{ Buzzer_Start(Buzzer_Boot, BUZZER_BOOT_SIZE, false); }

Buzzer_High_Prio_Start()

void Buzzer_High_Prio_Start

(

void

)

Activate the buzzer pattern for high priority alarms.

Definition at line 186 of file buzzer.cpp.

{ Buzzer_Start(Buzzer_High_Prio, BUZZER_HIGH_PRIO_SIZE, true); }

Buzzer_Init()

void Buzzer_Init

(

)

Initialization of HardwareTimer for buzzer.

Definition at line 128 of file buzzer.cpp.

                   {
    // Buzzer HardwareTimer object creation
    BuzzerTim = new HardwareTimer(BUZZER_TIMER);
 
    BuzzerControl_Off();
    // CPU Clock down to 10 kHz
    BuzzerTim->setPrescaleFactor((BuzzerTim->getTimerClkFreq() / (TIMER_TICK_PER_MS * 1000)));
    BuzzerTim->setOverflow(1);  // don't care right now, timer is not started in init
    BuzzerTim->setMode(BUZZER_TIM_CHANNEL, TIMER_OUTPUT_COMPARE, NC);
    BuzzerTim->attachInterrupt(Update_IT_callback);
}

Buzzer_Low_Prio_Start()

void Buzzer_Low_Prio_Start

(

void

)

Activate the buzzer pattern for low priority alarms.

Definition at line 192 of file buzzer.cpp.

{ Buzzer_Start(Buzzer_Low_Prio, BUZZER_LOW_PRIO_SIZE, false); }

Buzzer_Medium_Prio_Start()

void Buzzer_Medium_Prio_Start

(

void

)

Activate the buzzer pattern for medium priority alarms.

Definition at line 188 of file buzzer.cpp.

                                    {
    Buzzer_Start(Buzzer_Medium_Prio, BUZZER_MEDIUM_PRIO_SIZE, true);
}

Buzzer_Mute()

void Buzzer_Mute

(

void

)

Mute the buzzer for 120s.

Definition at line 156 of file buzzer.cpp.

                   {
    // If we are in Repeat and not muted, then an alarm is ringing
    if ((Active_Buzzer_Repeat == true) && (Buzzer_Muted == false)) {
        // Set the buzzer as muted
        Buzzer_Muted = true;
        // Reset the timer
        BuzzerTim->setCount(0);
        // Reset the index, so that we will restart after the mute period
        Active_Buzzer_Index = 0;
 
        // Configuration of mute pattern
        BuzzerControl_Off();
        BuzzerTim->setOverflow(PAUSE_120S, TICK_FORMAT);
 
        // Timer starts. Required to configure output on GPIO
        BuzzerTim->resume();
    }
}

Buzzer_Resume()

void Buzzer_Resume

(

void

)

Resume the muted alarm.

Definition at line 175 of file buzzer.cpp.

                     {
    BuzzerTim->setCount(0);
    Buzzer_Muted = false;
    Active_Buzzer_Index = 0;
 
    BuzzerTim->setOverflow(Active_Buzzer[Active_Buzzer_Index + 1u], TICK_FORMAT);
 
    // Timer starts. Required to configure output on GPIO
    BuzzerTim->resume();
}

Buzzer_Start()

void Buzzer_Start	(	const uint32_t *	Buzzer,
		uint32_t	Size,
		bool	RepeatBuzzer
	)

Generic function to activate a buzzer.

Parameters

Buzzer	Buzzer pattern array
Size	Size of the buzzer pattern array
RepeatBuzzer	Is pattern repeating after its end

Definition at line 140 of file buzzer.cpp.

                                                                            {
    BuzzerTim->setCount(0);
    Active_Buzzer = Buzzer;
    Active_Buzzer_Index = 0;
    Active_Buzzer_Size = Size;
    Active_Buzzer_Repeat = RepeatBuzzer;
    Active_Buzzer_Has_Begun = false;
    Buzzer_Muted = false;
 
    BuzzerTim->setPreloadEnable(false);
    BuzzerTim->setOverflow(100, TICK_FORMAT);
 
    // Timer starts
    BuzzerTim->resume();
}

Buzzer_Stop()

void Buzzer_Stop

(

void

)

Stop Buzzer.

Definition at line 196 of file buzzer.cpp.

                       {
    Active_Buzzer_Repeat = false;
 
    // Avoid unexpected infinite buzzing
    BuzzerControl_Off();
    BuzzerTim->pause();
}