Mike Maas / MAG3110

MAG3110 library with calibrate operation included

Dependents:   FRDM-KL46-Template AxedaGo-Freescal_FRDM-KL46Z revert AxedaGo-Freescal_FRDM-KL46Z HC-05_S2B_HelloWorld_WIZwiki-W7500_sensores

Fork of MAG3110 by Andrew Lindsay

MAG3110.h@0:63a8594a3866, 2013-05-19 (annotated)

Committer:
SomeRandomBloke
Date:
Sun May 19 20:34:27 2013 +0000
Revision:
0:63a8594a3866
Child:
1:5a0e7a58d980
Initial library commit

Who changed what in which revision?

UserRevisionLine numberNew contents of line
SomeRandomBloke 0:63a8594a3866 1 /*
SomeRandomBloke 0:63a8594a3866 2 * MAG3110 Sensor Library for mbed
SomeRandomBloke 0:63a8594a3866 3 * TODO: Add proper header
SomeRandomBloke 0:63a8594a3866 4 */
SomeRandomBloke 0:63a8594a3866 5
SomeRandomBloke 0:63a8594a3866 6 #ifndef MAG3110_H
SomeRandomBloke 0:63a8594a3866 7 #define MAG3110_H
SomeRandomBloke 0:63a8594a3866 8
SomeRandomBloke 0:63a8594a3866 9 #include "mbed.h"
SomeRandomBloke 0:63a8594a3866 10
SomeRandomBloke 0:63a8594a3866 11 #define PI 3.14159265359
SomeRandomBloke 0:63a8594a3866 12
SomeRandomBloke 0:63a8594a3866 13 #define MAG_ADDR 0x1D
SomeRandomBloke 0:63a8594a3866 14
SomeRandomBloke 0:63a8594a3866 15 // define registers
SomeRandomBloke 0:63a8594a3866 16 #define MAG_DR_STATUS 0x00
SomeRandomBloke 0:63a8594a3866 17 #define MAG_OUT_X_MSB 0x01
SomeRandomBloke 0:63a8594a3866 18 #define MAG_OUT_X_LSB 0x02
SomeRandomBloke 0:63a8594a3866 19 #define MAG_OUT_Y_MSB 0x03
SomeRandomBloke 0:63a8594a3866 20 #define MAG_OUT_Y_LSB 0x04
SomeRandomBloke 0:63a8594a3866 21 #define MAG_OUT_Z_MSB 0x05
SomeRandomBloke 0:63a8594a3866 22 #define MAG_OUT_Z_LSB 0x06
SomeRandomBloke 0:63a8594a3866 23 #define MAG_WHO_AM_I 0x07
SomeRandomBloke 0:63a8594a3866 24 #define MAG_SYSMOD 0x08
SomeRandomBloke 0:63a8594a3866 25 #define MAG_OFF_X_MSB 0x09
SomeRandomBloke 0:63a8594a3866 26 #define MAG_OFF_X_LSB 0x0A
SomeRandomBloke 0:63a8594a3866 27 #define MAG_OFF_Y_MSB 0x0B
SomeRandomBloke 0:63a8594a3866 28 #define MAG_OFF_Y_LSB 0x0C
SomeRandomBloke 0:63a8594a3866 29 #define MAG_OFF_Z_MSB 0x0D
SomeRandomBloke 0:63a8594a3866 30 #define MAG_OFF_Z_LSB 0x0E
SomeRandomBloke 0:63a8594a3866 31 #define MAG_DIE_TEMP 0x0F
SomeRandomBloke 0:63a8594a3866 32 #define MAG_CTRL_REG1 0x10
SomeRandomBloke 0:63a8594a3866 33 #define MAG_CTRL_REG2 0x11
SomeRandomBloke 0:63a8594a3866 34
SomeRandomBloke 0:63a8594a3866 35 // what should WHO_AM_I return?
SomeRandomBloke 0:63a8594a3866 36 #define MAG_3110_WHO_AM_I_VALUE 0xC4
SomeRandomBloke 0:63a8594a3866 37
SomeRandomBloke 0:63a8594a3866 38
SomeRandomBloke 0:63a8594a3866 39 // Fields in registers
SomeRandomBloke 0:63a8594a3866 40 // CTRL_REG1: dr2,dr1,dr0 os1,os0 fr tm ac
SomeRandomBloke 0:63a8594a3866 41
SomeRandomBloke 0:63a8594a3866 42 // Sampling rate from 80Hz down to 0.625Hz
SomeRandomBloke 0:63a8594a3866 43 #define MAG_3110_SAMPLE80 0
SomeRandomBloke 0:63a8594a3866 44 #define MAG_3110_SAMPLE40 0x20
SomeRandomBloke 0:63a8594a3866 45 #define MAG_3110_SAMPLE20 0x40
SomeRandomBloke 0:63a8594a3866 46 #define MAG_3110_SAMPLE10 0x60
SomeRandomBloke 0:63a8594a3866 47 #define MAG_3110_SAMPLE5 0x80
SomeRandomBloke 0:63a8594a3866 48 #define MAG_3110_SAMPLE2_5 0xA0
SomeRandomBloke 0:63a8594a3866 49 #define MAG_3110_SAMPLE1_25 0xC0
SomeRandomBloke 0:63a8594a3866 50 #define MAG_3110_SAMPLE0_625 0xE0
SomeRandomBloke 0:63a8594a3866 51
SomeRandomBloke 0:63a8594a3866 52 // How many samples to average (lowers data rate)
SomeRandomBloke 0:63a8594a3866 53 #define MAG_3110_OVERSAMPLE1 0
SomeRandomBloke 0:63a8594a3866 54 #define MAG_3110_OVERSAMPLE2 0x08
SomeRandomBloke 0:63a8594a3866 55 #define MAG_3110_OVERSAMPLE3 0x10
SomeRandomBloke 0:63a8594a3866 56 #define MAG_3110_OVERSAMPLE4 0x18
SomeRandomBloke 0:63a8594a3866 57
SomeRandomBloke 0:63a8594a3866 58 // read only 1 byte per axis
SomeRandomBloke 0:63a8594a3866 59 #define MAG_3110_FASTREAD 0x04
SomeRandomBloke 0:63a8594a3866 60 // do one measurement (even if in standby mode)
SomeRandomBloke 0:63a8594a3866 61 #define MAG_3110_TRIGGER 0x02
SomeRandomBloke 0:63a8594a3866 62 // put in active mode
SomeRandomBloke 0:63a8594a3866 63 #define MAG_3110_ACTIVE 0x01
SomeRandomBloke 0:63a8594a3866 64
SomeRandomBloke 0:63a8594a3866 65 // CTRL_REG2: AUTO_MRST_EN _ RAW MAG_RST _ _ _ _ _
SomeRandomBloke 0:63a8594a3866 66 // reset sensor after each reading
SomeRandomBloke 0:63a8594a3866 67 #define MAG_3110_AUTO_MRST_EN 0x80
SomeRandomBloke 0:63a8594a3866 68 // don't subtract user offsets
SomeRandomBloke 0:63a8594a3866 69 #define MAG_3110_RAW 0x20
SomeRandomBloke 0:63a8594a3866 70 // reset magnetic sensor after too-large field
SomeRandomBloke 0:63a8594a3866 71 #define MAG_3110_MAG_RST 0x10
SomeRandomBloke 0:63a8594a3866 72
SomeRandomBloke 0:63a8594a3866 73 // DR_STATUS Register ZYXOW ZOW YOW XOW ZYXDR ZDR YDR XDR
SomeRandomBloke 0:63a8594a3866 74 #define MAG_3110_ZYXDR 0x08
SomeRandomBloke 0:63a8594a3866 75
SomeRandomBloke 0:63a8594a3866 76 class MAG3110
SomeRandomBloke 0:63a8594a3866 77 {
SomeRandomBloke 0:63a8594a3866 78 private:
SomeRandomBloke 0:63a8594a3866 79 short _i2c_address;
SomeRandomBloke 0:63a8594a3866 80 I2C *_i2c;
SomeRandomBloke 0:63a8594a3866 81 Serial *_pc;
SomeRandomBloke 0:63a8594a3866 82 bool _debug;
SomeRandomBloke 0:63a8594a3866 83 int _avgX, _avgY; //, _newX, _tempXmin, _tempXmax, _newY, _tempYmin, _tempYmax;
SomeRandomBloke 0:63a8594a3866 84
SomeRandomBloke 0:63a8594a3866 85
SomeRandomBloke 0:63a8594a3866 86 public:
SomeRandomBloke 0:63a8594a3866 87 MAG3110(I2C *i2c);
SomeRandomBloke 0:63a8594a3866 88 MAG3110(I2C *i2c, Serial *pc); //pass serial for debug
SomeRandomBloke 0:63a8594a3866 89 void begin();
SomeRandomBloke 0:63a8594a3866 90 int readReg(char regAddr);
SomeRandomBloke 0:63a8594a3866 91 int readVal(char regAddr);
SomeRandomBloke 0:63a8594a3866 92 float getHeading();
SomeRandomBloke 0:63a8594a3866 93 void getValues(int *xVal, int *yVal, int *zVal);
SomeRandomBloke 0:63a8594a3866 94 void setCalibration(int minX, int maxX, int minY, int maxY);
SomeRandomBloke 0:63a8594a3866 95 };
SomeRandomBloke 0:63a8594a3866 96 #endif