buzzer library

Files at this revision

API Documentation at this revision

Comitter:
msmetko1
Date:
Thu Dec 02 20:56:45 2021 +0000
Parent:
1:622b1d533a1c
Commit message:
/;

Changed in this revision

buzzer.cpp Show annotated file Show diff for this revision Revisions of this file
buzzer.h Show annotated file Show diff for this revision Revisions of this file
diff -r 622b1d533a1c -r 27fe105d4033 buzzer.cpp
--- a/buzzer.cpp	Thu May 05 14:17:20 2016 +0000
+++ b/buzzer.cpp	Thu Dec 02 20:56:45 2021 +0000
@@ -1,52 +1,21 @@
 #include "buzzer.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(PTC2);
- * 
- * int main() {
- *       ...
- *   buzzer.beep(1000,0.5);    
- *       ...
- * }
- * @endcode
- */
- 
+
 using namespace mbed;
- // constructor
- /** Create a Beep object connected to the specified PwmOut pin
-  *
-  * @param pin PwmOut pin to connect to 
-  */
-    
-Beep::Beep(PinName pin) : _pwm(pin) {
-    _pwm.write(0.0);     // after creating it have to be off
-}
- 
- /** stop the beep instantaneous 
-  * usually not used 
-  */
-void Beep::nobeep() {
+Beep::Beep(PinName pin) : _pwm(pin)
+{
     _pwm.write(0.0);
 }
- 
-/** 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::beep(float freq, float time) {
- 
-    _pwm.period(1.0/freq);
-    _pwm.write(0.5);            // 50% duty cycle - beep on
-    toff.attach(this,&Beep::nobeep, time);   // time to off
+
+void Beep::nobeep()
+{
+    _pwm.write(0.0);
+}
+
+void Beep::beep(float frekvencija, float vrijeme)
+{
+
+    _pwm.period(1.0/frekvencija);
+    _pwm.write(0.5);            // 50% radnog ciklusa
+    toff.attach(this,&Beep::nobeep, vrijeme);   // vrijeme za isključenje
 }
\ No newline at end of file
diff -r 622b1d533a1c -r 27fe105d4033 buzzer.h
--- a/buzzer.h	Thu May 05 14:17:20 2016 +0000
+++ b/buzzer.h	Thu Dec 02 20:56:45 2021 +0000
@@ -1,70 +1,16 @@
 #ifndef MBED_BEEP_H
 #define MBED_BEEP_H
- 
 #include "mbed.h"
-/**
-@namespace Beep Library 
-@brief Contains member functions for the speaker funtion that allow for sending of frequency of sounds and duration through pwm
-@Author Peter Drescher (I do not own the rights to this library and it has been rightly attributed to its owner
-@Revision 2012 
-
-**/
-
 
- 
-/** class to make sound with a buzzer, roughly based on a library created by Peter Drescher 
- *   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 "buzzer.h"
- * 
- * Beep buzzer(PTC2);
- * 
- * 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 beep (float frekvencija, float vrijeme);
     void nobeep();
- 
 private :
     PwmOut _pwm;
     Timeout toff;
 };
- 
 }
 #endif
- 
-