Diff: beep.cpp

Revision:

0:dbb0f89dc4cc

Child:

1:ed6c6a4e6101

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/beep.cpp	Mon Jan 27 09:09:33 2020 +0000
@@ -0,0 +1,56 @@
+#include "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
+ */
+
+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() {
+    _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 = 0.1;            // 50% duty cycle - beep on
+    toff.attach(callback(this,&Beep::nobeep), time);   // time to off
+}
+
+
+
+