Fork of beep lib. Enables play of continous tones and changing of frequency on the fly

Fork of beep by Peter Drescher

beep.h

Committer:
dreschpe
Date:
2011-02-01
Revision:
1:ddccf0a4a414
Parent:
0:18e4a9c978ec
Child:
3:5a8242af60ba

File content as of revision 1:ddccf0a4a414:

#ifndef MBED_BEEP_H
#define MBED_BEEP_H

#include "mbed.h"

/** class to make sound with a buzzer, based on a PwmOut
*   The class use a timeout to switch off the sound  - it is not blocking while making noise
*
* Example:
* @code
* // Beep with 1Khz for 0.5 seconds
* #include "mbed.h"
* #include "beep.h"
* 
* Beep buzzer(p21);
* 
* int main() {
*       ...
*   buzzer.beep(1000,0.5);    
*       ...
* }
* @endcode
*/


namespace mbed {

/* Class: Beep
 *  A class witch uses pwm to controle a beeper to generate sounds.
 */
class Beep {

public:

    /** Create a Beep object connected to the specified PwmOut pin
    *
    * @param pin PwmOut pin to connect to 
    */
    Beep (PinName pin);

    /** Beep with given frequency and duration.
     *
     * @param frequency - the frequency of the tone in Hz
     * @param time - the duration of the tone in seconds
     */
    void beep (float frequency, float time);

    /** stop the beep instantaneous 
    * usually not used 
    */
    void nobeep();

private :
    PwmOut _pwm;
    Timeout toff;
};

}
#endif