com.raspoid.additionalcomponents

Class PassiveBuzzer

java.lang.Object

com.raspoid.PWMComponent

com.raspoid.additionalcomponents.PassiveBuzzer

All Implemented Interfaces:

Component

public class PassiveBuzzer
extends PWMComponent

A passive buzzer will not beep if DC signals are used. Instead, you need to use square waves to drive it.

This component then uses a PWM signal to control the output frequency from the buzzer.

Example Datasheet: Passive Buzzer

Example of use: PassiveBuzzerExample

Field Summary

Fields

Modifier and Type	Field and Description
static int	PWM_RANGE_GENERATOR Range register in the PWM generator.

Fields inherited from class com.raspoid.PWMComponent

DEFAULT_RPI_PWM_CLOCK_FREQUENCY, PCA9685_PULSE_TICKS, pinNumber

Constructor Summary

Constructors

Constructor and Description
PassiveBuzzer(PCA9685 pca9685, PCA9685.PCA9685Channel channel) Constructor for a passive buzzer using a specific PCA9685 to create PWM signals.
PassiveBuzzer(PWMPin pin) Constructor for a passive buzzer using a specific PWM pin from the Raspberry Pi to create PWM signals.

Method Summary

Modifier and Type	Method and Description
void	playNote(BaseNote baseNote, int octave, int millis) Plays a note, specified from a BaseNote and an octave, for a duration of millis milliseconds.
void	playTone(double frequency, int millis) Plays a tone for a duration of millis milliseconds.
void	pulse(int millis) Enables the buzzer to play the tone at the currently setted frequency.
void	setFrequency(double frequency) Sets the frequency played by the buzzer.
void	stop() Stops the tone played by the buzzer.

Methods inherited from class com.raspoid.PWMComponent

getType, setPWM, setPWM, setPWMFreq

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

PWM_RANGE_GENERATOR

public static final int PWM_RANGE_GENERATOR

Range register in the PWM generator. The values sent to the generator must be in the [0; PWM_RANGE_GENERATOR] range.

See Also:

Constant Field Values

Constructor Detail

PassiveBuzzer

public PassiveBuzzer(PWMPin pin)

Constructor for a passive buzzer using a specific PWM pin from the Raspberry Pi to create PWM signals.

Parameters:

pin - the PWM pin to use to generate the PWM signals.

PassiveBuzzer

public PassiveBuzzer(PCA9685 pca9685,
                     PCA9685.PCA9685Channel channel)

Constructor for a passive buzzer using a specific PCA9685 to create PWM signals.

Parameters:

pca9685 - the PCA9685 to use to generate PWM signals.

channel - the channel on the PCA9685 used to generate the PWM signals.

Method Detail

playTone

public void playTone(double frequency,
                     int millis)

Plays a tone for a duration of millis milliseconds.

Parameters:

frequency - the frequency of the tone.

millis - the duration of the tone.

playNote

public void playNote(BaseNote baseNote,
                     int octave,
                     int millis)

Plays a note, specified from a BaseNote and an octave, for a duration of millis milliseconds.

Parameters:

baseNote - the base note to play.

octave - the octave from the base note to play.

millis - the duration of the note to play.

setFrequency

public void setFrequency(double frequency)

Sets the frequency played by the buzzer.

Parameters:

frequency - the new frequency played by the buzzer.

See Also:

pulse(int)

pulse

public void pulse(int millis)

Enables the buzzer to play the tone at the currently setted frequency.

Parameters:

millis - the duration of the tone.

stop

public void stop()

Stops the tone played by the buzzer.