embedded-software
reusable software modules for embedded systems
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Buzzer Module

Functions

void Buzzer_Init (void)
 initializes the buzzer module for use More...
 
void Buzzer_Sound (uint16_t frequency, uint16_t timeout)
 
void hal_Buzzer_Init (void)
 hardware abstaction layer buzzer initialization More...
 
void hal_Start_Buzzer (uint16_t frequency)
 hardware abstraction layer to start buzzer and set the frequency More...
 
void hal_Stop_Buzzer (void)
 hardware abstraction layer to stop buzzer More...
 

Detailed Description

Created on: Mar 26, 2019 Authors: Nikola Kosaric, Nate Hoffman, Brian Harlow, DJ Stahlberger

The following module utilizes the task manager and timing module in order to inact a buzzer to produce a sound at a determined frequency. The timing module is used to control the frequency of the sound produced and the task module is used to control the length of time the buzzer will sound.

In oder to utilize this module, first, the Buzzer_Init must be called. Then, the Buzzer_Sound function must be called in order to determine the frequency at which the buzzer will sound and the length of time the buzzer will sound. The channel used for the buzzer will be determined in the hardware abstraction layer.

Function Documentation

void Buzzer_Init ( void  )

initializes the buzzer module for use

Initializes the task manager and timing modules to allow the modules to be used within the Buzzer_Sound function

Here is the call graph for this function:

void Buzzer_Sound ( uint16_t  frequency,
uint16_t  timeout 
)
Parameters
frequencyFrequency of the buzzer. The maximum value can be 65535, or 65.535 kHz
timeoutLength at which the buzzer is active

Here is the call graph for this function:

void hal_Buzzer_Init ( void  )

hardware abstaction layer buzzer initialization

Must be implemented for each MCU in hal_buzzer.c and configure the pin which will utilize the buzzer

Here is the caller graph for this function:

void hal_Start_Buzzer ( uint16_t  frequency)

hardware abstraction layer to start buzzer and set the frequency

Here is the caller graph for this function:

void hal_Stop_Buzzer ( void  )

hardware abstraction layer to stop buzzer

Here is the caller graph for this function: