Mihail Stoyanov / MMA8652

test

Fork of MMA8652 by Jim Carver

MMA8652.h@2:29c2dd97ca95, 2014-06-02 (annotated)

Committer:
screamer
Date:
Mon Jun 02 18:22:59 2014 +0000
Revision:
2:29c2dd97ca95
Parent:
1:ff30cc4759b4 
Documentation fixes

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JimCarver 1:ff30cc4759b4 1 /* Copyright (c) 2010-2011 mbed.org, MIT License
JimCarver 1:ff30cc4759b4 2 *
JimCarver 1:ff30cc4759b4 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
JimCarver 1:ff30cc4759b4 4 * and associated documentation files (the "Software"), to deal in the Software without
JimCarver 1:ff30cc4759b4 5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
JimCarver 1:ff30cc4759b4 6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
JimCarver 1:ff30cc4759b4 7 * Software is furnished to do so, subject to the following conditions:
JimCarver 1:ff30cc4759b4 8 *
JimCarver 1:ff30cc4759b4 9 * The above copyright notice and this permission notice shall be included in all copies or
JimCarver 1:ff30cc4759b4 10 * substantial portions of the Software.
JimCarver 1:ff30cc4759b4 11 *
JimCarver 1:ff30cc4759b4 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
JimCarver 1:ff30cc4759b4 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
JimCarver 1:ff30cc4759b4 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
JimCarver 1:ff30cc4759b4 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
JimCarver 1:ff30cc4759b4 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
JimCarver 1:ff30cc4759b4 17 */
JimCarver 1:ff30cc4759b4 18
JimCarver 0:3ae1e808e61c 19 #ifndef MMA8652_H
JimCarver 0:3ae1e808e61c 20 #define MMA8652_H
JimCarver 0:3ae1e808e61c 21
JimCarver 0:3ae1e808e61c 22 #include "mbed.h"
JimCarver 0:3ae1e808e61c 23
JimCarver 0:3ae1e808e61c 24
JimCarver 0:3ae1e808e61c 25 // MMA8652 Slave Address
JimCarver 0:3ae1e808e61c 26 #define MMA8652_SLAVE_ADDR 0x3A
JimCarver 0:3ae1e808e61c 27
JimCarver 0:3ae1e808e61c 28 // MMA8652 internal register addresses
JimCarver 0:3ae1e808e61c 29 #define MMA8652_STATUS 0x00
JimCarver 1:ff30cc4759b4 30 #define MMA8652_OUT_X_MSB 0x01
JimCarver 0:3ae1e808e61c 31 #define MMA8652_WHOAMI 0x0D
JimCarver 0:3ae1e808e61c 32 #define MMA8652_XYZ_DATA_CFG 0x0E
JimCarver 0:3ae1e808e61c 33 #define MMA8652_CTRL_REG1 0x2A
JimCarver 0:3ae1e808e61c 34 #define MMA8652_WHOAMI_VAL 0x4A
JimCarver 0:3ae1e808e61c 35
screamer 2:29c2dd97ca95 36 /**
screamer 2:29c2dd97ca95 37 * MMA8652 Xtrinsic accelerometer on I2C
screamer 2:29c2dd97ca95 38 */
JimCarver 0:3ae1e808e61c 39 class MMA8652
JimCarver 0:3ae1e808e61c 40 {
JimCarver 0:3ae1e808e61c 41 public:
JimCarver 0:3ae1e808e61c 42 /**
screamer 2:29c2dd97ca95 43 * MMA8652 constructor
screamer 2:29c2dd97ca95 44 *
screamer 2:29c2dd97ca95 45 * @param sda SDA pin
screamer 2:29c2dd97ca95 46 * @param sdl SCL pin
screamer 2:29c2dd97ca95 47 */
JimCarver 0:3ae1e808e61c 48 MMA8652(PinName sda, PinName scl);
JimCarver 1:ff30cc4759b4 49
screamer 2:29c2dd97ca95 50 /**
screamer 2:29c2dd97ca95 51 * MMA8652 destructor
screamer 2:29c2dd97ca95 52 */
screamer 2:29c2dd97ca95 53 ~MMA8652();
JimCarver 0:3ae1e808e61c 54
screamer 2:29c2dd97ca95 55 /**
screamer 2:29c2dd97ca95 56 * Get XYZ axis acceleration in floating point G's
screamer 2:29c2dd97ca95 57 *
screamer 2:29c2dd97ca95 58 * @param res array where acceleration data will be stored
screamer 2:29c2dd97ca95 59 */
screamer 2:29c2dd97ca95 60 void ReadXYZ(float * a);
screamer 2:29c2dd97ca95 61
screamer 2:29c2dd97ca95 62 /**
screamer 2:29c2dd97ca95 63 * Get XYZ axis acceleration, signed 16 bit values
screamer 2:29c2dd97ca95 64 *
screamer 2:29c2dd97ca95 65 * @param res array where acceleration data will be stored
screamer 2:29c2dd97ca95 66 */
JimCarver 1:ff30cc4759b4 67 void ReadXYZraw(int16_t * d);
JimCarver 0:3ae1e808e61c 68
screamer 2:29c2dd97ca95 69 /**
screamer 2:29c2dd97ca95 70 * Get the value of the WHO_AM_I register
screamer 2:29c2dd97ca95 71 *
screamer 2:29c2dd97ca95 72 * @returns DEVICE_ID value == 0x3A
screamer 2:29c2dd97ca95 73 */
screamer 2:29c2dd97ca95 74 char getWhoAmI(void);
screamer 2:29c2dd97ca95 75
JimCarver 0:3ae1e808e61c 76 private:
JimCarver 0:3ae1e808e61c 77 I2C _i2c;
screamer 2:29c2dd97ca95 78
screamer 2:29c2dd97ca95 79 /**
screamer 2:29c2dd97ca95 80 * Set the device in active mode
screamer 2:29c2dd97ca95 81 */
JimCarver 0:3ae1e808e61c 82 void begin( void);
screamer 2:29c2dd97ca95 83
JimCarver 0:3ae1e808e61c 84 void RegRead( char reg, char * d, int len);
JimCarver 0:3ae1e808e61c 85
JimCarver 0:3ae1e808e61c 86 };
JimCarver 0:3ae1e808e61c 87
JimCarver 0:3ae1e808e61c 88 #endif