Fred Barnes / FXOS8700CQ

Fork of trm's FXOS8700CQ library

Dependents:   co657_lcdplay

Fork of FXOS8700CQ by Thomas Murphy

Diff: FXOS8700CQ.h

Revision:
1:3ec7e2676e48
Parent:
0:cf6299acfe98
Child:
2:4c2f8a3549a9
--- a/FXOS8700CQ.h	Wed May 28 13:28:18 2014 +0000
+++ b/FXOS8700CQ.h	Wed May 28 13:40:59 2014 +0000
@@ -48,6 +48,13 @@
     int16_t z;
 } SRAWDATA;
 
+
+/**
+* A driver on top of mbed-I2C to operate the FXOS8700CQ accelerometer/magnetometer
+* on the FRDM-K64F.
+*
+* Warning: incomplete code!
+*/
 class FXOS8700CQ
 {
 public:
@@ -70,6 +77,13 @@
     void disable(void);
     uint8_t get_whoami(void);
     uint8_t status(void);
+    
+    /**
+    * Data retrieval from the FXOS8700CQ
+    *
+    * @param accel_data destination XYZ accelerometer data struct
+    * @param magn_data destination XYZ magnetometer data struct
+    */
     void get_data(SRAWDATA *accel_data, SRAWDATA *magn_data);