Diff: Music.h

Revision:

0:dcdfee042939

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/Music.h	Mon Sep 19 17:19:59 2016 +0000
@@ -0,0 +1,51 @@
+#include "mbed.h"
+/*! Music class.
+ *  Used for playing musical notes with the FRDM-KL46Z.
+ * \author  Matthew Shuman
+ *
+ * \date    June 9th, 2016
+ 
+ * \bug     No bugs yet
+ 
+ * @code
+ * #include "mbed.h"
+ * #include "Music.h"
+ *
+ * Music mu();
+ *
+ * int main() {
+ *     mu.playNote(2);
+ * }
+ * @endcode
+ */
+ 
+ 
+ 
+class Music
+{
+public:
+    /**
+     * @param mySpeaker selects a DigitalOut to toggle at the selected frequency (in Music.h).
+     */
+    Music(PinName mySpeaker);
+ 
+    /**
+     * @param There is no parameter for this deconstructor.
+     */
+    ~Music(void);
+ 
+    /**
+     * @param note plays a note from the standard piano.
+     * Input notes range from 1 to 88.
+     * Set to zero to turn off the note.
+     * Sourced from: https://en.wikipedia.org/wiki/Piano_key_frequencies
+     * @returns
+     *   1 on success.
+     *   0 on error, typically outside of the max range of 88.
+     */
+    int playNote(int note);
+ 
+private:
+    DigitalOut _mySpeaker;  //This is the private DigitalOut that toggles 
+    //the output connect to the speaker.
+}; //end of Music class
\ No newline at end of file