ECE 4180 - Final Project Team / Mbed 2 deprecated WalkieTalkie

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed 4DGL-uLCD-SE mbed-rtos nRF24L01P

Diff: Speaker.h

Revision:
49:8ae98a6d48c0
Parent:
33:5d86c111d9bc
--- a/Speaker.h	Mon Apr 30 00:40:51 2018 +0000
+++ b/Speaker.h	Mon Apr 30 01:14:25 2018 +0000
@@ -1,15 +1,26 @@
 #include "mbed.h"
 
+/** 
+* Speaker Class
+*/
+
 class Speaker {
 public:
+/** Assign a pin to Speaker.
+* @param Pin The pin the Speaker will be assigned to
+*/
     Speaker(PinName pin);
-    
+    /** Write a value a pin to Speaker.
+* @param value 
+*/
     void rawWrite(float value);
-    
-    // Writes a scaled uint8_t from RF transmission to the speaker
+    /**
+    *  @param value Writes a scaled uint8_t from RF transmission to the speaker
+    */
     void write(uint8_t value);
-    
-    // Writes 0 to the analogOut to completely turn off the speaker
+    /**
+    * Writes 0 to the analogOut to completely turn off the speaker
+    */
     void turnOff();
     
 private: