Arduino - Buzzer Library

When using a piezo buzzer, beginners usually run into the trouble that buzzer code blocks other Arduino code because of delau() function.

The ezBuzzer (easy buzzer) library is designed to solve that problems and make it easy to use for not only beginners but also experienced users. It is created by ArduioGetStarted.com.

Library Features

  • Supports generating a beep
  • Supports playing a melody
  • Supports stopping playing a melody
  • All functions are non-blocking (no delay() function)

※ NOTE THAT:

If this library is useful for your work, you can say thanks to us by buying us a coffee: PayPal.Me/arduinogetstarted

How To Install Library

On Arduino IDE, Go to Tools Manage Libraries

Arduino add library
  • Search “ezBuzzer”, then find the buzzer library by ArduinoGetStarted
  • Click Install button to install ezBuzzer library.
  • Arduino buzzer library

Or you can download it on Github

Functions

  • ezBuzzer()
  • stop()
  • beep()
  • playMelody()
  • getState()
  • loop()

References

ezBuzzer()

Description

This function creates a new instance of the ezBuzzer class that represents a particular buzzer attached to your Arduino board.

Syntax

ezBuzzer(pin)

Parameters

pin: int - Arduino's pin that connects to the buzzer.

Return

A new instance of the ezBuzzer class.

Example

ezBuzzer buzzer(7);

stop()

Description

This function stop playing beep or melody. It will set the state of buzzer to BUZZER_IDLE.

Syntax

buzzer.stop();

Parameters

None

Return

None

beep()

Description

This function generates a beep. The beep is run on background without blocking other Arduino code. When a beep is ended, The function will set the state of buzzer to BUZZER_IDLE.

Syntax

buzzer.beep(beepTime);
buzzer.beep(beepTime, delay);

Parameters

  • beepTime: unsigned long - the time buzzer beeps (in milliseconds).
  • delay: unsigned long - the time delay befor beeping (in milliseconds).

Return

None

playMelody()

Description

This function play a melody. The melody is run on background without blocking other Arduino code. When a melody is ended, The function will set the state of buzzer to BUZZER_IDLE.

Syntax

buzzer.playMelody(melody, noteDurations, length);

Parameters

  • melody: int melody[] - An int array stores note's information.
  • noteDurations: int noteDurations[] - An int array stores note's duration.
  • length: int - The number of notes stores in melody[] array.

Return

None

getState()

Description

This function returns the state of the buzzer.

Syntax

buzzer.getState();

Parameters

None

Return

One of the following states of buzzer:

  • BUZZER_IDLE
  • BUZZER_BEEP_DELAY
  • BUZZER_BEEPING
  • BUZZER_MELODY

loop()

Description

This function does play beep, melody on background. It MUST be called in the main loop() function.

Syntax

buzzer.loop();

Parameters

None

Return

None

※ OUR MESSAGES