Diff: GridEye/GridEye.h

Revision:

28:0ed92c590607

Parent:

23:f74a50977593

Child:

38:c10d2a04a0c2

--- a/GridEye/GridEye.h	Fri Jul 20 21:29:53 2018 +0000
+++ b/GridEye/GridEye.h	Mon Jul 23 23:39:35 2018 +0000
@@ -220,8 +220,39 @@
     int8_t getRaw8x8FrameData(char * raw_frame_data);
     
     
+    /**
+    * @brief softwareReset
+    *
+    * @details Makes the Grid Eye device perform a software restart with Initial conditions
+    *
+    * @return int8_t - result of operation, 0 on success, -1 on failure
+    */   
+    int8_t softwareReset();
+    
+    
+    /**
+    * @brief setOperatingMode
+    *
+    * @details Sets the mode of operation for the Grid Eye device 
+    *
+    * On Entry:
+    * @param[in] mode - Choose power operating mode from struct
+    *
+    * @return int8_t - result of operation, 0 on success, -1 on failure
+    */   
     int8_t setOperatingMode(GridEye::OperatingMode mode);
     
+    
+    /**
+    * @brief setFrameRate
+    *
+    * @details Sets the frames per second that the grid eye device resolves
+    *
+    * On Entry:
+    * @param[in] mode - Choose option from either 10 fps or 1 fps
+    *
+    * @return int8_t - result of operation, 0 on success, -1 on failure
+    */   
     int8_t setFrameRate(GridEye::FrameRate rate);
 
 };