Diff: EasyVR.h

Revision:

1:8b8bb6ac9d11

Parent:

0:8ec860bd579a

Child:

3:05cef12c147a

--- a/EasyVR.h	Thu Oct 22 19:35:17 2015 +0000
+++ b/EasyVR.h	Thu Oct 22 20:42:05 2015 +0000
@@ -4,19 +4,26 @@
 class EasyVR
 {
 public:
-    EasyVR(PinName tx,PinName rx);
-    ~EasyVR();
+    /** EasyVR use Serial communication*/
+    EasyVR(PinName tx,PinName rx);              
+    ~EasyVR();                                  
+    
+    /** Send a command to EasyVR to excute EasyVR build in routine*/
+    void sendCmd(uint8_t);             
     
-    void sendCmd(uint8_t);
-    void sendArg(int8_t);
+    /** Send a argument for the routine */
+    void sendArg(int8_t);                       
 
-    int8_t recv(int8_t timeOut = 1);
-    void decrypt(char*);
+    /** Receive return value from EasyVR routine */
+    int8_t recv(int8_t timeOut = 1);         
+       
+    /** Decrypt returned value from EasyVR */
+    void decrypt(char*);                        
     
-    bool awake(int timeOut = 100);
+    /** Used for awake EasyVR, default time out value to 100*/
+    bool awake(int timeOut = 100);              
     
     
 private:
     Serial _easyVR;
-    
 };
\ No newline at end of file