Pileus Git - ~andy/csm213a-hw/blob - yue/MAG3110/MAG3110.h

   1 /*
   2  * MAG3110 Sensor Library for mbed
   3  * TODO: Add proper header
   4  */
   5
   6 #ifndef MAG3110_H
   7 #define MAG3110_H
   8
   9 #include "mbed.h"
  10
  11 #define PI 3.14159265359
  12
  13 #define MAG_ADDR 0x1D
  14
  15 // define registers
  16 #define MAG_DR_STATUS 0x00
  17 #define MAG_OUT_X_MSB 0x01
  18 #define MAG_OUT_X_LSB 0x02
  19 #define MAG_OUT_Y_MSB 0x03
  20 #define MAG_OUT_Y_LSB 0x04
  21 #define MAG_OUT_Z_MSB 0x05
  22 #define MAG_OUT_Z_LSB 0x06
  23 #define MAG_WHO_AM_I  0x07
  24 #define MAG_SYSMOD    0x08
  25 #define MAG_OFF_X_MSB 0x09
  26 #define MAG_OFF_X_LSB 0x0A
  27 #define MAG_OFF_Y_MSB 0x0B
  28 #define MAG_OFF_Y_LSB 0x0C
  29 #define MAG_OFF_Z_MSB 0x0D
  30 #define MAG_OFF_Z_LSB 0x0E
  31 #define MAG_DIE_TEMP  0x0F
  32 #define MAG_CTRL_REG1 0x10
  33 #define MAG_CTRL_REG2 0x11
  34
  35 // what should WHO_AM_I return?
  36 #define MAG_3110_WHO_AM_I_VALUE 0xC4
  37
  38
  39 // Fields in registers
  40 // CTRL_REG1: dr2,dr1,dr0  os1,os0  fr tm ac
  41
  42 // Sampling rate from 80Hz down to 0.625Hz
  43 #define MAG_3110_SAMPLE80 0
  44 #define MAG_3110_SAMPLE40 0x20
  45 #define MAG_3110_SAMPLE20 0x40
  46 #define MAG_3110_SAMPLE10 0x60
  47 #define MAG_3110_SAMPLE5 0x80
  48 #define MAG_3110_SAMPLE2_5 0xA0
  49 #define MAG_3110_SAMPLE1_25 0xC0
  50 #define MAG_3110_SAMPLE0_625 0xE0
  51
  52 // How many samples to average (lowers data rate)
  53 #define MAG_3110_OVERSAMPLE1 0
  54 #define MAG_3110_OVERSAMPLE2 0x08
  55 #define MAG_3110_OVERSAMPLE3 0x10
  56 #define MAG_3110_OVERSAMPLE4 0x18
  57
  58 // read only 1 byte per axis
  59 #define MAG_3110_FASTREAD 0x04
  60 // do one measurement (even if in standby mode)
  61 #define MAG_3110_TRIGGER 0x02
  62 // put in active mode
  63 #define MAG_3110_ACTIVE 0x01
  64
  65 // CTRL_REG2: AUTO_MRST_EN  _ RAW MAG_RST _ _ _ _ _
  66 // reset sensor after each reading
  67 #define MAG_3110_AUTO_MRST_EN 0x80
  68 // don't subtract user offsets
  69 #define MAG_3110_RAW 0x20
  70 // reset magnetic sensor after too-large field
  71 #define MAG_3110_MAG_RST 0x10
  72
  73 // DR_STATUS Register ZYXOW ZOW YOW XOW ZYXDR ZDR YDR XDR
  74 #define MAG_3110_ZYXDR  0x08
  75
  76 /**
  77  * MAG3110 Class to read X/Y/Z data from the magentometer
  78  *
  79  */
  80 class MAG3110
  81 {
  82 public:
  83     /**
  84      * Main constructor
  85      * @param sda SDA pin
  86      * @param sdl SCL pin
  87      * @param addr addr of the I2C peripheral
  88      */
  89     MAG3110(PinName sda, PinName scl);
  90     /**
  91      * Debug version of constructor
  92      * @param sda SDA pin
  93      * @param sdl SCL pin
  94      * @param addr Address of the I2C peripheral
  95      * @param pc Serial object to output debug messages
  96      */
  97     MAG3110(PinName sda, PinName scl, Serial *pc); //pass serial for debug
  98     /**
  99      * Setup the Magnetometer
 100      *
 101      */
 102     void begin();
 103     /**
 104      * Read a register, return its value as int
 105      * @param regAddr The address to read
 106      * @return value in register
 107      */
 108     int readReg(char regAddr);
 109     /**
 110      * Read a value from a pair of registers, return as int
 111      * @param regAddr The address to read
 112      * @return Value from 2 consecutive registers
 113      */
 114     int readVal(char regAddr);
 115     /**
 116      * Calculate the heading
 117      * @return heading in degrees
 118      */
 119     float getHeading();
 120     /**
 121      * Perform a read on the X, Y and Z values.
 122      * @param xVal Pointer to X value
 123      * @param yVal Pointer to Y value
 124      * @param zVal Pointer to Z value
 125      */
 126     void getValues(int *xVal, int *yVal, int *zVal);
 127     /**
 128      * Set the calibration parameters if required.
 129      * @param minX Minimum value for X range
 130      * @param maxX Maximum value for X range
 131      * @param minY Minimum value for Y range
 132      * @param maxY maximum value for Y range
 133      */
 134     void setCalibration(int minX, int maxX, int minY, int maxY);
 135
 136 private:
 137     I2C _i2c;
 138     int _i2c_address;
 139     Serial *_pc;
 140     bool _debug;
 141     int _avgX, _avgY;
 142
 143 };
 144 #endif