AKM Development Platform / AK9752_tkstreet

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.

Fork of AK9752 by AKM Development Platform

Diff: AK9752.h

Revision:
3:5b437caef51f
Parent:
0:51fa46d39a3e
--- a/AK9752.h	Fri Oct 28 21:30:24 2016 +0000
+++ b/AK9752.h	Tue Nov 01 17:49:01 2016 +0000
@@ -3,6 +3,32 @@
 
 #include "mbed.h"
 
+/**
+ * This is a device driver of AK9752.
+ *
+ * @note AK9752 IR sensor device manufactured by AKM.
+ * Example:
+ * @code
+ * #include "mbed.h"
+ * #include "ak9750.h"
+ * 
+ * #define I2C_SPEED_100KHZ    100000
+ * #define I2C_SPEED_400KHZ    400000
+ * 
+ * int main() {
+ *     // Creates an instance of I2C
+ *     I2C connection(I2C_SDA0, I2C_SCL0);
+ *     connection.frequency(I2C_SPEED_100KHZ);
+ *
+ *     // TBD
+ *
+ *     while(true) {
+ *              // TBD    
+ *         }
+ *     }
+ * }
+ * @endcode
+*/
 class AK9752
 {
 public: