jajn HA / Mbed OS C027_SupportTest

final

Fork of C027_SupportTest by u-blox

MMA7455.h@34:2d06e42fac2c, 2017-07-20 (annotated)

Committer:
david8251
Date:
Thu Jul 20 09:02:49 2017 +0000
Revision:
34:2d06e42fac2c
final

Who changed what in which revision?

UserRevisionLine numberNew contents of line
david8251 34:2d06e42fac2c 1 #ifndef MMA7455_H
david8251 34:2d06e42fac2c 2 #define MMA7455_H
david8251 34:2d06e42fac2c 3
david8251 34:2d06e42fac2c 4
david8251 34:2d06e42fac2c 5 /**
david8251 34:2d06e42fac2c 6 * Freescale Accelerometer MMA7455.
david8251 34:2d06e42fac2c 7 */
david8251 34:2d06e42fac2c 8 class MMA7455 {
david8251 34:2d06e42fac2c 9 public:
david8251 34:2d06e42fac2c 10
david8251 34:2d06e42fac2c 11 enum Mode {
david8251 34:2d06e42fac2c 12 ModeStandby = 0,
david8251 34:2d06e42fac2c 13 ModeMeasurement = 1,
david8251 34:2d06e42fac2c 14 };
david8251 34:2d06e42fac2c 15
david8251 34:2d06e42fac2c 16 /** Acceleration range */
david8251 34:2d06e42fac2c 17 enum Range {
david8251 34:2d06e42fac2c 18 Range_8g = 0,
david8251 34:2d06e42fac2c 19 Range_2g = 1,
david8251 34:2d06e42fac2c 20 Range_4g = 2
david8251 34:2d06e42fac2c 21 };
david8251 34:2d06e42fac2c 22
david8251 34:2d06e42fac2c 23 /**
david8251 34:2d06e42fac2c 24 * Create an interface to the MMA7455 accelerometer
david8251 34:2d06e42fac2c 25 *
david8251 34:2d06e42fac2c 26 * @param sda I2C data line pin
david8251 34:2d06e42fac2c 27 * @param scl I2C clock line pin
david8251 34:2d06e42fac2c 28 */
david8251 34:2d06e42fac2c 29 MMA7455(PinName sda, PinName scl);
david8251 34:2d06e42fac2c 30
david8251 34:2d06e42fac2c 31 bool setMode(Mode mode);
david8251 34:2d06e42fac2c 32 bool setRange(Range range);
david8251 34:2d06e42fac2c 33
david8251 34:2d06e42fac2c 34 bool read(int32_t& x, int32_t& y, int32_t& z);
david8251 34:2d06e42fac2c 35
david8251 34:2d06e42fac2c 36 /**
david8251 34:2d06e42fac2c 37 * Calibrate for 0g, that is, calculate offset to achieve
david8251 34:2d06e42fac2c 38 * 0g values when accelerometer is placed on flat surface.
david8251 34:2d06e42fac2c 39 *
david8251 34:2d06e42fac2c 40 * Please make sure the accelerometer is placed on a flat surface before
david8251 34:2d06e42fac2c 41 * calling this function.
david8251 34:2d06e42fac2c 42 *
david8251 34:2d06e42fac2c 43 * @return true if request was successful; otherwise false
david8251 34:2d06e42fac2c 44 */
david8251 34:2d06e42fac2c 45 bool calibrate();
david8251 34:2d06e42fac2c 46
david8251 34:2d06e42fac2c 47 /**
david8251 34:2d06e42fac2c 48 * Get calculated offset values. Offsets will be calculated by the
david8251 34:2d06e42fac2c 49 * calibrate() method.
david8251 34:2d06e42fac2c 50 *
david8251 34:2d06e42fac2c 51 * Use these values and put them in persistent storage to avoid
david8251 34:2d06e42fac2c 52 * having to calibrate the accelerometer after a reset/power cycle.
david8251 34:2d06e42fac2c 53 *
david8251 34:2d06e42fac2c 54 * @param xOff x offset is written to this argument
david8251 34:2d06e42fac2c 55 * @param yOff y offset is written to this argument
david8251 34:2d06e42fac2c 56 * @param zOff z offset is written to this argument
david8251 34:2d06e42fac2c 57 *
david8251 34:2d06e42fac2c 58 * @return true if request was successful; otherwise false
david8251 34:2d06e42fac2c 59 */
david8251 34:2d06e42fac2c 60 bool getCalibrationOffsets(int32_t& xOff, int32_t& yOff, int32_t& zOff);
david8251 34:2d06e42fac2c 61
david8251 34:2d06e42fac2c 62 /**
david8251 34:2d06e42fac2c 63 * Set calibration offset values. These values should normally
david8251 34:2d06e42fac2c 64 * at one point in time have been retrieved by calling the
david8251 34:2d06e42fac2c 65 * getCalibrationOffsets method.
david8251 34:2d06e42fac2c 66 *
david8251 34:2d06e42fac2c 67 *
david8251 34:2d06e42fac2c 68 * @param xOff x offset
david8251 34:2d06e42fac2c 69 * @param yOff y offset
david8251 34:2d06e42fac2c 70 * @param zOff z offset
david8251 34:2d06e42fac2c 71 *
david8251 34:2d06e42fac2c 72 * @return true if request was successful; otherwise false
david8251 34:2d06e42fac2c 73 */
david8251 34:2d06e42fac2c 74 bool setCalibrationOffsets(int32_t xOff, int32_t yOff, int32_t zOff);
david8251 34:2d06e42fac2c 75
david8251 34:2d06e42fac2c 76
david8251 34:2d06e42fac2c 77
david8251 34:2d06e42fac2c 78 private:
david8251 34:2d06e42fac2c 79
david8251 34:2d06e42fac2c 80 I2C _i2c;
david8251 34:2d06e42fac2c 81 Mode _mode;
david8251 34:2d06e42fac2c 82 Range _range;
david8251 34:2d06e42fac2c 83 int32_t _xOff;
david8251 34:2d06e42fac2c 84 int32_t _yOff;
david8251 34:2d06e42fac2c 85 int32_t _zOff;
david8251 34:2d06e42fac2c 86
david8251 34:2d06e42fac2c 87 int getStatus();
david8251 34:2d06e42fac2c 88 int getModeControl();
david8251 34:2d06e42fac2c 89 int setModeControl(uint8_t mctl);
david8251 34:2d06e42fac2c 90
david8251 34:2d06e42fac2c 91 };
david8251 34:2d06e42fac2c 92
david8251 34:2d06e42fac2c 93 #endif