Xiaofei Qiu / EasyVR3_LED_Library

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.

Files at this revision

API Documentation at this revision

Revision 1:8b8bb6ac9d11, committed 2015-10-22

Comitter:
Xiaofei
Date:
Thu Oct 22 20:42:05 2015 +0000
Parent:
0:8ec860bd579a
Child:
2:d772f65f65ab
Commit message:
Add comment

Changed in this revision

EasyVR.h Show annotated file Show diff for this revision Revisions of this file 
--- 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