Diff: CMPS03.h

Revision:

0:c6bcc390612a

--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CMPS03.h	Sat Nov 27 12:09:27 2010 +0000
@@ -0,0 +1,90 @@
+/**
+ * @author Aaron Berk
+ *
+ * @section LICENSE
+ *
+ * Copyright (c) 2010 ARM Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @section DESCRIPTION
+ *
+ * CMPS03 digital compass module.
+ *
+ * Datasheet:
+ *
+ * http://www.robot-electronics.co.uk/htm/cmps3tech.htm
+ */
+
+#ifndef CMPS03_H
+#define CMPS03_H
+
+/**
+ * Includes
+ */
+#include "mbed.h"
+
+/**
+ * Defines
+ */
+#define CMPS03_DEFAULT_I2C_ADDRESS 0xC0
+
+//-----------
+// Registers
+//-----------
+#define SOFTWARE_REVISION_REG    0x0
+#define COMPASS_BEARING_WORD_REG 0x2
+
+/**
+ * CMPS03 digital compass module.
+ */
+class CMPS03 {
+
+    I2C* i2c;
+    int  i2cAddress;
+
+public:
+
+    /**
+     * Constructor.
+     *
+     * @param sda mbed pin to use for I2C SDA
+     * @param scl mbed pin to use for I2C SCL
+     * @param address I2C address of this device.
+     */
+    CMPS03(PinName sda, PinName scl, int address);
+
+    /**
+     * Reads the software revision register [register 0] on the device.
+     *
+     * @return The contents of the software revision register as a byte.
+     */
+    char readSoftwareRevision(void);
+
+    /**
+     * Reads the current bearing of the compass.
+     *
+     * @return The current bearing of the compass as a value between 0 and 3599,
+     *         representing 0 - 359.9 degrees.
+     */
+    int readBearing(void);
+
+};
+
+#endif /* CMPS03_H */