Shane Barton / MMA8451Q8

SB-HW-8.1

Fork of MMA8451Q8 by Stanley Cohen

MMA8451Q8b.h@8:31f7a3426768, 2017-03-08 (annotated)

Committer:
sbart
Date:
Wed Mar 08 04:11:07 2017 +0000
Revision:
8:31f7a3426768
SB-HW-8.1

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sbart 8:31f7a3426768 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
sbart 8:31f7a3426768 2 *
sbart 8:31f7a3426768 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
sbart 8:31f7a3426768 4 * and associated documentation files (the "Software"), to deal in the Software without
sbart 8:31f7a3426768 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
sbart 8:31f7a3426768 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
sbart 8:31f7a3426768 7 * Software is furnished to do so, subject to the following conditions:
sbart 8:31f7a3426768 8 *
sbart 8:31f7a3426768 9 * The above copyright notice and this permission notice shall be included in all copies or
sbart 8:31f7a3426768 10 * substantial portions of the Software.
sbart 8:31f7a3426768 11 *
sbart 8:31f7a3426768 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
sbart 8:31f7a3426768 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
sbart 8:31f7a3426768 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
sbart 8:31f7a3426768 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
sbart 8:31f7a3426768 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
sbart 8:31f7a3426768 17 */
sbart 8:31f7a3426768 18
sbart 8:31f7a3426768 19 #ifndef MMA8451QB_H
sbart 8:31f7a3426768 20 #define MMA8451QB_H
sbart 8:31f7a3426768 21
sbart 8:31f7a3426768 22 #include "mbed.h"
sbart 8:31f7a3426768 23
sbart 8:31f7a3426768 24 /**
sbart 8:31f7a3426768 25 * MMA8451Q accelerometer example
sbart 8:31f7a3426768 26 *
sbart 8:31f7a3426768 27 * @code
sbart 8:31f7a3426768 28 * #include "mbed.h"
sbart 8:31f7a3426768 29 * #include "MMA8451Q.h"
sbart 8:31f7a3426768 30 *
sbart 8:31f7a3426768 31 * #define MMA8451_I2C_ADDRESS (0x1d<<1)
sbart 8:31f7a3426768 32 *
sbart 8:31f7a3426768 33 * int main(void) {
sbart 8:31f7a3426768 34 *
sbart 8:31f7a3426768 35 * MMA8451Q acc(P_E25, P_E24, MMA8451_I2C_ADDRESS);
sbart 8:31f7a3426768 36 * PwmOut rled(LED_RED);
sbart 8:31f7a3426768 37 * PwmOut gled(LED_GREEN);
sbart 8:31f7a3426768 38 * PwmOut bled(LED_BLUE);
sbart 8:31f7a3426768 39 *
sbart 8:31f7a3426768 40 * while (true) {
sbart 8:31f7a3426768 41 * rled = 1.0 - abs(acc.getAccX());
sbart 8:31f7a3426768 42 * gled = 1.0 - abs(acc.getAccY());
sbart 8:31f7a3426768 43 * bled = 1.0 - abs(acc.getAccZ());
sbart 8:31f7a3426768 44 * wait(0.1);
sbart 8:31f7a3426768 45 * }
sbart 8:31f7a3426768 46 * }
sbart 8:31f7a3426768 47 * @endcode
sbart 8:31f7a3426768 48 */
sbart 8:31f7a3426768 49 class MMA8451Q
sbart 8:31f7a3426768 50 {
sbart 8:31f7a3426768 51 public:
sbart 8:31f7a3426768 52 /**
sbart 8:31f7a3426768 53 * MMA8451Q constructor
sbart 8:31f7a3426768 54 *
sbart 8:31f7a3426768 55 * @param sda SDA pin
sbart 8:31f7a3426768 56 * @param sdl SCL pin
sbart 8:31f7a3426768 57 * @param addr addr of the I2C peripheral
sbart 8:31f7a3426768 58 */
sbart 8:31f7a3426768 59 MMA8451Q(PinName sda, PinName scl, int addr);
sbart 8:31f7a3426768 60
sbart 8:31f7a3426768 61 /**
sbart 8:31f7a3426768 62 * MMA8451Q destructor
sbart 8:31f7a3426768 63 */
sbart 8:31f7a3426768 64 ~MMA8451Q();
sbart 8:31f7a3426768 65
sbart 8:31f7a3426768 66 /**
sbart 8:31f7a3426768 67 * Get the value of the WHO_AM_I register
sbart 8:31f7a3426768 68 *
sbart 8:31f7a3426768 69 * @returns WHO_AM_I value
sbart 8:31f7a3426768 70 */
sbart 8:31f7a3426768 71 uint8_t getWhoAmI();
sbart 8:31f7a3426768 72
sbart 8:31f7a3426768 73 /**
sbart 8:31f7a3426768 74 * Get X axis acceleration
sbart 8:31f7a3426768 75 *
sbart 8:31f7a3426768 76 * @returns X axis acceleration
sbart 8:31f7a3426768 77 */
sbart 8:31f7a3426768 78 float getAccX();
sbart 8:31f7a3426768 79
sbart 8:31f7a3426768 80 /**
sbart 8:31f7a3426768 81 * Get Y axis acceleration
sbart 8:31f7a3426768 82 *
sbart 8:31f7a3426768 83 * @returns Y axis acceleration
sbart 8:31f7a3426768 84 */
sbart 8:31f7a3426768 85 float getAccY();
sbart 8:31f7a3426768 86
sbart 8:31f7a3426768 87 /**
sbart 8:31f7a3426768 88 * Get Z axis acceleration
sbart 8:31f7a3426768 89 *
sbart 8:31f7a3426768 90 * @returns Z axis acceleration
sbart 8:31f7a3426768 91 */
sbart 8:31f7a3426768 92 float getAccZ();
sbart 8:31f7a3426768 93
sbart 8:31f7a3426768 94 /**
sbart 8:31f7a3426768 95 * Get XYZ axis acceleration
sbart 8:31f7a3426768 96 *
sbart 8:31f7a3426768 97 * @param res array where acceleration data will be stored
sbart 8:31f7a3426768 98 */
sbart 8:31f7a3426768 99 void getAccAllAxis(float * res);
sbart 8:31f7a3426768 100
sbart 8:31f7a3426768 101 int16_t getAccAxis(uint8_t addr);
sbart 8:31f7a3426768 102
sbart 8:31f7a3426768 103
sbart 8:31f7a3426768 104 I2C m_i2c;
sbart 8:31f7a3426768 105 int m_addr;
sbart 8:31f7a3426768 106 int gChosen;
sbart 8:31f7a3426768 107
sbart 8:31f7a3426768 108
sbart 8:31f7a3426768 109 //Allow the user to set max g's
sbart 8:31f7a3426768 110 void setGLimit(int gSelect);
sbart 8:31f7a3426768 111 void setStandbyMode();
sbart 8:31f7a3426768 112 void setActiveMode();
sbart 8:31f7a3426768 113 void readRegs(int addr, uint8_t * data, int len);
sbart 8:31f7a3426768 114 void writeRegs(uint8_t * data, int len);
sbart 8:31f7a3426768 115
sbart 8:31f7a3426768 116 private:
sbart 8:31f7a3426768 117
sbart 8:31f7a3426768 118
sbart 8:31f7a3426768 119
sbart 8:31f7a3426768 120 };
sbart 8:31f7a3426768 121
sbart 8:31f7a3426768 122 #endif