Thomas Murphy / FXOS8700CQ Featured

An in-development library to provide effective access to all features of the FXOS8700CQ on the FRDM-K64F mbed-enabled development board. As of 28 May 2014 1325EDT, the code should be generally usable and modifiable.

Dependents:   fxos8700cq_example frdm_fxos8700_logger AVC_test1 frdm_accel ... more

A basic implementation of accessing the FXOS8700CQ. This should be useable, but as the Apache License says, don't expect it to be good at doing anything, even what it's supposed to do.

Files at this revision

API Documentation at this revision

Revision 1:3ec7e2676e48, committed 2014-05-28

Comitter:
trm
Date:
Wed May 28 13:40:59 2014 +0000
Parent:
0:cf6299acfe98
Child:
2:4c2f8a3549a9
Commit message:
Added comments for API documentation.

Changed in this revision

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