masaaki makabe / Mbed 2 deprecated BLE_API

test

Dependencies:   BLE_API nRF51822 mbed

Fork of KS7 by masaaki makabe

MMA845x.h@36:3cca74c30551, 2016-08-12 (annotated)

Committer:
masaaki_makabe
Date:
Fri Aug 12 04:07:00 2016 +0000
Branch:
KS3
Revision:
36:3cca74c30551
Parent:
31:b5e19d153db4 
???????????????????????????????

Who changed what in which revision?

UserRevisionLine numberNew contents of line
masaaki_makabe 31:b5e19d153db4 1 /**
masaaki_makabe 31:b5e19d153db4 2 * @file MMA845x.h
masaaki_makabe 31:b5e19d153db4 3 * @brief Device driver - MMA845x 3-axis accelerometer IC
masaaki_makabe 31:b5e19d153db4 4 * @author sam grove
masaaki_makabe 31:b5e19d153db4 5 * @version 1.0
masaaki_makabe 31:b5e19d153db4 6 * @see http://cache.freescale.com/files/sensors/doc/data_sheet/MMA8451Q.pdf
masaaki_makabe 31:b5e19d153db4 7 * @see http://cache.freescale.com/files/sensors/doc/data_sheet/MMA8452Q.pdf
masaaki_makabe 31:b5e19d153db4 8 * @see http://cache.freescale.com/files/sensors/doc/data_sheet/MMA8453Q.pdf
masaaki_makabe 31:b5e19d153db4 9 *
masaaki_makabe 31:b5e19d153db4 10 * Copyright (c) 2013
masaaki_makabe 31:b5e19d153db4 11 *
masaaki_makabe 31:b5e19d153db4 12 * Licensed under the Apache License, Version 2.0 (the "License");
masaaki_makabe 31:b5e19d153db4 13 * you may not use this file except in compliance with the License.
masaaki_makabe 31:b5e19d153db4 14 * You may obtain a copy of the License at
masaaki_makabe 31:b5e19d153db4 15 *
masaaki_makabe 31:b5e19d153db4 16 * http://www.apache.org/licenses/LICENSE-2.0
masaaki_makabe 31:b5e19d153db4 17 *
masaaki_makabe 31:b5e19d153db4 18 * Unless required by applicable law or agreed to in writing, software
masaaki_makabe 31:b5e19d153db4 19 * distributed under the License is distributed on an "AS IS" BASIS,
masaaki_makabe 31:b5e19d153db4 20 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
masaaki_makabe 31:b5e19d153db4 21 * See the License for the specific language governing permissions and
masaaki_makabe 31:b5e19d153db4 22 * limitations under the License.
masaaki_makabe 31:b5e19d153db4 23 */
masaaki_makabe 31:b5e19d153db4 24
masaaki_makabe 31:b5e19d153db4 25 #ifndef MMA845X_H
masaaki_makabe 31:b5e19d153db4 26 #define MMA845X_H
masaaki_makabe 31:b5e19d153db4 27
masaaki_makabe 31:b5e19d153db4 28 #include "mbed.h"
masaaki_makabe 31:b5e19d153db4 29
masaaki_makabe 31:b5e19d153db4 30 /** Using the Sparkfun SEN-10955
masaaki_makabe 31:b5e19d153db4 31 *
masaaki_makabe 31:b5e19d153db4 32 * Example:
masaaki_makabe 31:b5e19d153db4 33 * @code
masaaki_makabe 31:b5e19d153db4 34 * #include "mbed.h"
masaaki_makabe 31:b5e19d153db4 35 * #include "MMA845x.h"
masaaki_makabe 31:b5e19d153db4 36 *
masaaki_makabe 31:b5e19d153db4 37
masaaki_makabe 31:b5e19d153db4 38 *
masaaki_makabe 31:b5e19d153db4 39 * int main()
masaaki_makabe 31:b5e19d153db4 40 * {
masaaki_makabe 31:b5e19d153db4 41
masaaki_makabe 31:b5e19d153db4 42 * }
masaaki_makabe 31:b5e19d153db4 43 * @endcode
masaaki_makabe 31:b5e19d153db4 44 */
masaaki_makabe 31:b5e19d153db4 45
masaaki_makabe 31:b5e19d153db4 46
masaaki_makabe 31:b5e19d153db4 47 /**
masaaki_makabe 31:b5e19d153db4 48 * @class MMA845x_DATA
masaaki_makabe 31:b5e19d153db4 49 * @brief API abstraction for the MMA845x 3-axis accelerometer IC data
masaaki_makabe 31:b5e19d153db4 50 */
masaaki_makabe 31:b5e19d153db4 51 class MMA845x_DATA
masaaki_makabe 31:b5e19d153db4 52 {
masaaki_makabe 31:b5e19d153db4 53 public:
masaaki_makabe 31:b5e19d153db4 54
masaaki_makabe 31:b5e19d153db4 55 volatile uint16_t _x; /*!< volatile data variable */
masaaki_makabe 31:b5e19d153db4 56 volatile uint16_t _y; /*!< volatile data variable */
masaaki_makabe 31:b5e19d153db4 57 volatile uint16_t _z; /*!< volatile data variable */
masaaki_makabe 31:b5e19d153db4 58
masaaki_makabe 31:b5e19d153db4 59 /** Create the MMA845x_DATA object initialized to the parameter (or 0 if none)
masaaki_makabe 31:b5e19d153db4 60 * @param x - the init value of _x
masaaki_makabe 31:b5e19d153db4 61 * @param y - the init value of _y
masaaki_makabe 31:b5e19d153db4 62 * @param x - the init value of _z
masaaki_makabe 31:b5e19d153db4 63 */
masaaki_makabe 31:b5e19d153db4 64 MMA845x_DATA(uint16_t x = 0, uint16_t y = 0, uint16_t z = 0) : _x(x), _y(y), _z(z) {}
masaaki_makabe 31:b5e19d153db4 65
masaaki_makabe 31:b5e19d153db4 66 /** Overloaded '=' operator to allow shorthand coding, assigning objects to one another
masaaki_makabe 31:b5e19d153db4 67 * @param rhs - an object of the same type to assign ourself the same values of
masaaki_makabe 31:b5e19d153db4 68 * @return this
masaaki_makabe 31:b5e19d153db4 69 */
masaaki_makabe 31:b5e19d153db4 70 MMA845x_DATA &operator= (MMA845x_DATA const &rhs)
masaaki_makabe 31:b5e19d153db4 71 {
masaaki_makabe 31:b5e19d153db4 72 _x = rhs._x;
masaaki_makabe 31:b5e19d153db4 73 _y = rhs._y;
masaaki_makabe 31:b5e19d153db4 74 _z = rhs._z;
masaaki_makabe 31:b5e19d153db4 75
masaaki_makabe 31:b5e19d153db4 76 return *this;
masaaki_makabe 31:b5e19d153db4 77 }
masaaki_makabe 31:b5e19d153db4 78
masaaki_makabe 31:b5e19d153db4 79 /** Overloaded '=' operator to allow shorthand coding, assigning objects to one another
masaaki_makabe 31:b5e19d153db4 80 * @param val - Assign each data member (_x, _y, _z) this value
masaaki_makabe 31:b5e19d153db4 81 * @return this
masaaki_makabe 31:b5e19d153db4 82 */
masaaki_makabe 31:b5e19d153db4 83 MMA845x_DATA &operator= (uint16_t const val)
masaaki_makabe 31:b5e19d153db4 84 {
masaaki_makabe 31:b5e19d153db4 85 _x = _y = _z = val;
masaaki_makabe 31:b5e19d153db4 86
masaaki_makabe 31:b5e19d153db4 87 return *this;
masaaki_makabe 31:b5e19d153db4 88 }
masaaki_makabe 31:b5e19d153db4 89
masaaki_makabe 31:b5e19d153db4 90 /** Overloaded '==' operator to allow shorthand coding, test objects to one another
masaaki_makabe 31:b5e19d153db4 91 * @param rhs - the object to compare against
masaaki_makabe 31:b5e19d153db4 92 * @return 1 if the data members are the same and 0 otherwise
masaaki_makabe 31:b5e19d153db4 93 */
masaaki_makabe 31:b5e19d153db4 94 bool operator== (MMA845x_DATA const &rhs) const
masaaki_makabe 31:b5e19d153db4 95 {
masaaki_makabe 31:b5e19d153db4 96 return ((_x == rhs._x)&&(_y == rhs._y)&&(_z == rhs._z)) ? 1 : 0;
masaaki_makabe 31:b5e19d153db4 97 }
masaaki_makabe 31:b5e19d153db4 98
masaaki_makabe 31:b5e19d153db4 99 };
masaaki_makabe 31:b5e19d153db4 100
masaaki_makabe 31:b5e19d153db4 101 /**
masaaki_makabe 31:b5e19d153db4 102 * @class MMA845x
masaaki_makabe 31:b5e19d153db4 103 * @brief API abstraction for the MMA845x 3-axis accelerometer IC
masaaki_makabe 31:b5e19d153db4 104 */
masaaki_makabe 31:b5e19d153db4 105 class MMA845x
masaaki_makabe 31:b5e19d153db4 106 {
masaaki_makabe 31:b5e19d153db4 107 public:
masaaki_makabe 31:b5e19d153db4 108
masaaki_makabe 31:b5e19d153db4 109 /**
masaaki_makabe 31:b5e19d153db4 110 * @enum MMA845x_SA0
masaaki_makabe 31:b5e19d153db4 111 * @brief Possible terminations for the ADDR pin
masaaki_makabe 31:b5e19d153db4 112 */
masaaki_makabe 31:b5e19d153db4 113 enum MMA845x_SA0
masaaki_makabe 31:b5e19d153db4 114 {
masaaki_makabe 31:b5e19d153db4 115 SA0_VSS = 0, /*!< SA0 connected to VSS */
masaaki_makabe 31:b5e19d153db4 116 SA0_VDD /*!< SA0 connected to VDD */
masaaki_makabe 31:b5e19d153db4 117 };
masaaki_makabe 31:b5e19d153db4 118
masaaki_makabe 31:b5e19d153db4 119 /**
masaaki_makabe 31:b5e19d153db4 120 * @enum MMA845x_WHO_AM_I
masaaki_makabe 31:b5e19d153db4 121 * @brief Device ID's that this class is compatible with
masaaki_makabe 31:b5e19d153db4 122 */
masaaki_makabe 31:b5e19d153db4 123 enum MMA845x_WHO_AM_I
masaaki_makabe 31:b5e19d153db4 124 {
masaaki_makabe 31:b5e19d153db4 125 MMA8451 = 0x1a, /*!< MMA8451 WHO_AM_I register content */
masaaki_makabe 31:b5e19d153db4 126 MMA8452 = 0x2a, /*!< MMA8452 WHO_AM_I register content */
masaaki_makabe 31:b5e19d153db4 127 MMA8453 = 0x3a, /*!< MMA8453 WHO_AM_I register content */
masaaki_makabe 31:b5e19d153db4 128 MMA8652 = 0x4a, /*!< MMA8652 WHO_AM_I register content */
masaaki_makabe 31:b5e19d153db4 129 };
masaaki_makabe 31:b5e19d153db4 130
masaaki_makabe 31:b5e19d153db4 131 /**
masaaki_makabe 31:b5e19d153db4 132 * @enum MMA845x_REGISTER
masaaki_makabe 31:b5e19d153db4 133 * @brief The device register map
masaaki_makabe 31:b5e19d153db4 134 */
masaaki_makabe 31:b5e19d153db4 135 enum MMA845x_REGISTER
masaaki_makabe 31:b5e19d153db4 136 {
masaaki_makabe 31:b5e19d153db4 137 STATUS = 0x0,
masaaki_makabe 31:b5e19d153db4 138 OUT_X_MSB, OUT_X_LSB, OUT_Y_MSB, OUT_Y_LSB, OUT_Z_MSB, OUT_Z_LSB,
masaaki_makabe 31:b5e19d153db4 139
masaaki_makabe 31:b5e19d153db4 140 F_SETUP = 0x9, TRIG_CFG, // only available on the MMA8451 variant
masaaki_makabe 31:b5e19d153db4 141
masaaki_makabe 31:b5e19d153db4 142 SYSMOD = 0xb,
masaaki_makabe 31:b5e19d153db4 143 INT_SOURCE, WHO_AM_I, XYZ_DATA_CFG, HP_FILTER_CUTOFF, PL_STATUS,
masaaki_makabe 31:b5e19d153db4 144 PL_CFG, PL_COUNT, PL_BF_ZCOMP, P_L_THS_REG, FF_MT_CFG, FF_MT_SRC,
masaaki_makabe 31:b5e19d153db4 145 FF_MT_THS, FF_MT_COUNT,
masaaki_makabe 31:b5e19d153db4 146
masaaki_makabe 31:b5e19d153db4 147 TRANSIENT_CFG = 0x1d,
masaaki_makabe 31:b5e19d153db4 148 TRANSIENT_SRC, TRANSIENT_THS, TRANSIENT_COUNT, PULSE_CFG, PULSE_SRC,
masaaki_makabe 31:b5e19d153db4 149 PULSE_THSX, PULSE_THSY, PULSE_THSZ, PULSE_TMLT, PULSE_LTCY, PULSE_WIND,
masaaki_makabe 31:b5e19d153db4 150 ASLP_COUNT, CTRL_REG1, CTRL_REG2, CTRL_REG3, CTRL_REG4, CTRL_REG5,
masaaki_makabe 31:b5e19d153db4 151 OFF_X, OFF_Y, OFF_Z
masaaki_makabe 31:b5e19d153db4 152 };
masaaki_makabe 31:b5e19d153db4 153
masaaki_makabe 31:b5e19d153db4 154 /** Create the MMA845x object
masaaki_makabe 31:b5e19d153db4 155 * @param i2c - A defined I2C object
masaaki_makabe 31:b5e19d153db4 156 * @param int1 - A defined InterruptIn object
masaaki_makabe 31:b5e19d153db4 157 * @param int2 - A defined InterruptIn object
masaaki_makabe 31:b5e19d153db4 158 * @param i2c_addr - Connection of the address line
masaaki_makabe 31:b5e19d153db4 159 */
masaaki_makabe 31:b5e19d153db4 160 MMA845x(I2C &i2c, PinName p_int1, PinName p_int2, MMA845x_SA0 const i2c_addr) : _int1(p_int1), _int2(p_int2)
masaaki_makabe 31:b5e19d153db4 161 //MMA845x(I2C &i2c, InterruptIn int1, InterruptIn int2, MMA845x_SA0 const i2c_addr)
masaaki_makabe 31:b5e19d153db4 162 {
masaaki_makabe 31:b5e19d153db4 163 _i2c = &i2c;
masaaki_makabe 31:b5e19d153db4 164
masaaki_makabe 31:b5e19d153db4 165 _i2c_addr = (0x1d << 1) | i2c_addr;
masaaki_makabe 31:b5e19d153db4 166
masaaki_makabe 31:b5e19d153db4 167 _int1_waiting = false;
masaaki_makabe 31:b5e19d153db4 168 _intMode = 0;
masaaki_makabe 31:b5e19d153db4 169
masaaki_makabe 31:b5e19d153db4 170 _int1.fall(this, &MMA845x::interrupt_1);
masaaki_makabe 31:b5e19d153db4 171 _int1.mode(PullUp);
masaaki_makabe 31:b5e19d153db4 172 };
masaaki_makabe 31:b5e19d153db4 173 // 割込み使わない場合のコンストラクタ
masaaki_makabe 31:b5e19d153db4 174 MMA845x(I2C &i2c, MMA845x_SA0 const i2c_addr) : _int1(P0_29/*dummy*/), _int2(P0_29/*dummy*/)
masaaki_makabe 31:b5e19d153db4 175 {
masaaki_makabe 31:b5e19d153db4 176 _i2c = &i2c;
masaaki_makabe 31:b5e19d153db4 177 _i2c_addr = (0x1d << 1) | i2c_addr;
masaaki_makabe 31:b5e19d153db4 178 _int1_waiting = false;
masaaki_makabe 31:b5e19d153db4 179 _intMode = 0;
masaaki_makabe 31:b5e19d153db4 180 //_ticker.attach(this, &MMA845x::interrupt_1, 0.5); // ポーリングで見る
masaaki_makabe 31:b5e19d153db4 181 }
masaaki_makabe 31:b5e19d153db4 182
masaaki_makabe 31:b5e19d153db4 183 float getXX(void){
masaaki_makabe 31:b5e19d153db4 184 interrupt_1();
masaaki_makabe 31:b5e19d153db4 185 return g_values[0];
masaaki_makabe 31:b5e19d153db4 186 }
masaaki_makabe 31:b5e19d153db4 187 float getYY(void){
masaaki_makabe 31:b5e19d153db4 188 interrupt_1();
masaaki_makabe 31:b5e19d153db4 189 return g_values[1];
masaaki_makabe 31:b5e19d153db4 190 }
masaaki_makabe 31:b5e19d153db4 191 float getZZ(void){
masaaki_makabe 31:b5e19d153db4 192 interrupt_1();
masaaki_makabe 31:b5e19d153db4 193 return g_values[2];
masaaki_makabe 31:b5e19d153db4 194 }
masaaki_makabe 31:b5e19d153db4 195
masaaki_makabe 31:b5e19d153db4 196
masaaki_makabe 31:b5e19d153db4 197 /** Get the X data
masaaki_makabe 31:b5e19d153db4 198 * @return The last valid reading from the accelerometer
masaaki_makabe 31:b5e19d153db4 199 */
masaaki_makabe 31:b5e19d153db4 200 uint16_t getX(void) const;
masaaki_makabe 31:b5e19d153db4 201
masaaki_makabe 31:b5e19d153db4 202 /** Get the Y data
masaaki_makabe 31:b5e19d153db4 203 * @return The last valid reading from the accelerometer
masaaki_makabe 31:b5e19d153db4 204 */
masaaki_makabe 31:b5e19d153db4 205 uint16_t getY(void) const;
masaaki_makabe 31:b5e19d153db4 206
masaaki_makabe 31:b5e19d153db4 207 /** Get the Z data
masaaki_makabe 31:b5e19d153db4 208 * @return The last valid reading from the accelerometer
masaaki_makabe 31:b5e19d153db4 209 */
masaaki_makabe 31:b5e19d153db4 210 uint16_t getZ(void) const;
masaaki_makabe 31:b5e19d153db4 211
masaaki_makabe 31:b5e19d153db4 212 /** Get the XYZ data structure
masaaki_makabe 31:b5e19d153db4 213 * @return The last valid reading from the accelerometer
masaaki_makabe 31:b5e19d153db4 214 */
masaaki_makabe 31:b5e19d153db4 215 MMA845x_DATA getXYZ(void) const;
masaaki_makabe 31:b5e19d153db4 216
masaaki_makabe 31:b5e19d153db4 217 void enableDataReadyMode(void) const;
masaaki_makabe 31:b5e19d153db4 218 void enableMotionMode(void) const;
masaaki_makabe 31:b5e19d153db4 219 void enablePulseMode(void) const;
masaaki_makabe 31:b5e19d153db4 220 void enableOrientationMode(void) const;
masaaki_makabe 31:b5e19d153db4 221 void enableTransitMode(void) const;
masaaki_makabe 31:b5e19d153db4 222 void enableAutoSleepMode(void) const;
masaaki_makabe 31:b5e19d153db4 223 void enableFIFOMode(void) const;
masaaki_makabe 31:b5e19d153db4 224 /** Put the MMA845x in the lowest possible power mode and suspend operation
masaaki_makabe 31:b5e19d153db4 225 */
masaaki_makabe 31:b5e19d153db4 226 void disable(void);
masaaki_makabe 31:b5e19d153db4 227
masaaki_makabe 31:b5e19d153db4 228 /** Write to a register (exposed for debugging reasons)
masaaki_makabe 31:b5e19d153db4 229 * Note: most writes are only valid in stop mode
masaaki_makabe 31:b5e19d153db4 230 * @param reg - The register to be written
masaaki_makabe 31:b5e19d153db4 231 * @param data - The data to be written
masaaki_makabe 31:b5e19d153db4 232 */
masaaki_makabe 31:b5e19d153db4 233 void writeRegister(uint8_t const reg, uint8_t const data) const;
masaaki_makabe 31:b5e19d153db4 234
masaaki_makabe 31:b5e19d153db4 235 /** Read from a register (exposed for debugging reasons)
masaaki_makabe 31:b5e19d153db4 236 * @param reg - The register to read from
masaaki_makabe 31:b5e19d153db4 237 * @return The register contents
masaaki_makabe 31:b5e19d153db4 238 */
masaaki_makabe 31:b5e19d153db4 239 uint8_t readRegister(uint8_t const reg) const;
masaaki_makabe 31:b5e19d153db4 240
masaaki_makabe 31:b5e19d153db4 241 /** print the register map and values to the console
masaaki_makabe 31:b5e19d153db4 242 */
masaaki_makabe 31:b5e19d153db4 243 void registerDump(void) const;
masaaki_makabe 31:b5e19d153db4 244
masaaki_makabe 31:b5e19d153db4 245 /** Set display mode of interrupt
masaaki_makabe 31:b5e19d153db4 246 * @return The last valid reading from the accelerometer
masaaki_makabe 31:b5e19d153db4 247 */
masaaki_makabe 31:b5e19d153db4 248 void setIntMode(int);
masaaki_makabe 31:b5e19d153db4 249 void attachZAxisPulse(void (*function)(void));
masaaki_makabe 31:b5e19d153db4 250 void interrupt_1(void);
masaaki_makabe 31:b5e19d153db4 251 void interrupt_handler(void);
masaaki_makabe 31:b5e19d153db4 252
masaaki_makabe 31:b5e19d153db4 253 private:
masaaki_makabe 31:b5e19d153db4 254
masaaki_makabe 31:b5e19d153db4 255 I2C *_i2c;
masaaki_makabe 31:b5e19d153db4 256 InterruptIn _int1;
masaaki_makabe 31:b5e19d153db4 257 InterruptIn _int2;
masaaki_makabe 31:b5e19d153db4 258 uint8_t _i2c_addr;
masaaki_makabe 31:b5e19d153db4 259 MMA845x_DATA _data;
masaaki_makabe 31:b5e19d153db4 260 bool _int1_waiting;
masaaki_makabe 31:b5e19d153db4 261 int _intMode;
masaaki_makabe 31:b5e19d153db4 262 FunctionPointer _callbackZAxisPulse;
masaaki_makabe 31:b5e19d153db4 263
masaaki_makabe 31:b5e19d153db4 264 void init(void) const;
masaaki_makabe 31:b5e19d153db4 265 //Ticker _ticker;
masaaki_makabe 31:b5e19d153db4 266 float g_values[3];
masaaki_makabe 31:b5e19d153db4 267
masaaki_makabe 31:b5e19d153db4 268 };
masaaki_makabe 31:b5e19d153db4 269
masaaki_makabe 31:b5e19d153db4 270 #endif