API for the Buzzer component. More...

Detailed Description

ID: buzzer
Name: Grove Buzzer
Category: sound
Manufacturer: seeed
Connection: pwm
Kit: gsk

This module defines the Buzzer interface for libbuzzer. This sensor can make different tones when connected to a pin capable of analog pulse-width modulation. It emits sound using a piezoelectric material that vibrates at different frequencies based on the input voltage.

Public Member Functions
	Buzzer (int pinNumber)

	~Buzzer ()

int	playSound (int note, int delay)

void	stopSound ()

void	setVolume (float vol)

float	getVolume ()

std::string	name ()

Protected Attributes
std::string	m_name

buzzer_context	m_buzzer

Constructor & Destructor Documentation

Buzzer ( int pinNumber )

Instantiates a Buzzer object.

Parameters

pinNumber Buzzer pin number

~Buzzer ( )

Buzzer object destructor.

Here is the call graph for this function:

Member Function Documentation

int playSound	(	int	note,
		int	delay
	)

Plays a tone for a certain amount of time or indefinitely. When delay is not used, the sound can be stopped by calling stopSound().

Parameters

note	Note to play (DO, RE, MI, etc.) or frequency
delay	Time in microseconds for which to play the sound; if the value is 0, the sound is played indefinitely