buzzer_control.cpp File Reference

Abstraction to switch buzzer ON or OFF. More...

#include "../includes/buzzer_control.h"
#include "../includes/config.h"
#include "../includes/parameters.h"
#include "Arduino.h"

Go to the source code of this file.

Macros
#define	BUZZER_FREQ   4000
	Buzzer frequency in Hz. More...
#define	PERIOD_BUZZER_US   (1000000 / BUZZER_FREQ)

Functions
void	BuzzerControl_Init (void)
	Initialization of HardwareTimer for buzzer. More...
void	BuzzerControl_On (void)
	Switch buzzer ON. More...
void	BuzzerControl_Off (void)
	Switch buzzer OFF. More...

Variables
HardwareTimer *	Buzzer_Hw_Timer
uint32_t	Buzzer_Timer_Channel

Detailed Description

Abstraction to switch buzzer ON or OFF.

Author

Makers For Life

Copyright

Copyright (c) 2020 Makers For Life

Definition in file buzzer_control.cpp.

Macro Definition Documentation

BUZZER_FREQ

#define BUZZER_FREQ   4000

Buzzer frequency in Hz.

Definition at line 18 of file buzzer_control.cpp.

PERIOD_BUZZER_US

#define PERIOD_BUZZER_US   (1000000 / BUZZER_FREQ)

Definition at line 20 of file buzzer_control.cpp.

Function Documentation

BuzzerControl_Init()

void BuzzerControl_Init

(

void

)

Initialization of HardwareTimer for buzzer.

Definition at line 27 of file buzzer_control.cpp.

                              {
    TIM_TypeDef* Buzzer_Timer_Number = reinterpret_cast<TIM_TypeDef*>(
        pinmap_peripheral(digitalPinToPinName(PIN_BUZZER), PinMap_PWM));
    Buzzer_Timer_Channel =
        STM_PIN_CHANNEL(pinmap_function(digitalPinToPinName(PIN_BUZZER), PinMap_PWM));
 
    // Hardware 2: the buzzer has no internal oscillator. uC must generate a 4khz square on
    // PIN_BUZZER (timer 2, channel 1)
    Buzzer_Hw_Timer = new HardwareTimer(Buzzer_Timer_Number);
    Buzzer_Hw_Timer->setMode(Buzzer_Timer_Channel, TIMER_OUTPUT_COMPARE_PWM1, PIN_BUZZER);
    Buzzer_Hw_Timer->setOverflow(PERIOD_BUZZER_US, MICROSEC_FORMAT);
    Buzzer_Hw_Timer->setCaptureCompare(Buzzer_Timer_Channel, PERIOD_BUZZER_US / 2,
                                       MICROSEC_COMPARE_FORMAT);
    digitalWrite(PIN_BUZZER, LOW);
}

BuzzerControl_Off()

void BuzzerControl_Off

(

void

)

Switch buzzer OFF.

Definition at line 45 of file buzzer_control.cpp.

                             {
    Buzzer_Hw_Timer->pause();
    digitalWrite(PIN_BUZZER, LOW);  // Stops current consumption in the buzzer
}

BuzzerControl_On()

void BuzzerControl_On

(

void

)

Switch buzzer ON.

Definition at line 43 of file buzzer_control.cpp.

{ Buzzer_Hw_Timer->resume(); }

Variable Documentation

Buzzer_Hw_Timer

HardwareTimer* Buzzer_Hw_Timer

Definition at line 22 of file buzzer_control.cpp.

Buzzer_Timer_Channel

uint32_t Buzzer_Timer_Channel

Definition at line 23 of file buzzer_control.cpp.