Vigneshwar Murali / Mbed 2 deprecated 6dof_new_workwith_v2

A system demonstrating interface of 6DOF sensor to Android

Dependencies:   ITG3200 mbed

Fork of 6dof_new_workwith_v2 by Chen Zhai

ADXL345_I2C.h@0:5ca44aa85a30, 2013-03-12 (annotated)

Committer:
chenzhai
Date:
Tue Mar 12 21:56:17 2013 +0000
Revision:
0:5ca44aa85a30
6dof sensor wireless

Who changed what in which revision?

UserRevisionLine numberNew contents of line
chenzhai 0:5ca44aa85a30 1 /**
chenzhai 0:5ca44aa85a30 2 * @author Peter Swanson
chenzhai 0:5ca44aa85a30 3 * A personal note from me: Jesus Christ has changed my life so much it blows my mind. I say this because
chenzhai 0:5ca44aa85a30 4 * today, religion is thought of as something that you do or believe and has about as
chenzhai 0:5ca44aa85a30 5 * little impact on a person as their political stance. But for me, God gives me daily
chenzhai 0:5ca44aa85a30 6 * strength and has filled my life with the satisfaction that I could never find in any
chenzhai 0:5ca44aa85a30 7 * of the other things that I once looked for it in.
chenzhai 0:5ca44aa85a30 8 * If your interested, heres verse that changed my life:
chenzhai 0:5ca44aa85a30 9 * Rom 8:1-3: "Therefore, there is now no condemnation for those who are in Christ Jesus,
chenzhai 0:5ca44aa85a30 10 * because through Christ Jesus, the law of the Spirit who gives life has set
chenzhai 0:5ca44aa85a30 11 * me free from the law of sin (which brings...) and death. For what the law
chenzhai 0:5ca44aa85a30 12 * was powerless to do in that it was weakened by the flesh, God did by sending
chenzhai 0:5ca44aa85a30 13 * His own Son in the likeness of sinful flesh to be a sin offering. And so He
chenzhai 0:5ca44aa85a30 14 * condemned sin in the flesh in order that the righteous requirements of the
chenzhai 0:5ca44aa85a30 15 * (God's) law might be fully met in us, who live not according to the flesh
chenzhai 0:5ca44aa85a30 16 * but according to the Spirit."
chenzhai 0:5ca44aa85a30 17 *
chenzhai 0:5ca44aa85a30 18 * A special thanks to Ewout van Bekkum for all his patient help in developing this library!
chenzhai 0:5ca44aa85a30 19 *
chenzhai 0:5ca44aa85a30 20 * @section LICENSE
chenzhai 0:5ca44aa85a30 21 *
chenzhai 0:5ca44aa85a30 22 * Permission is hereby granted, free of charge, to any person obtaining a copy
chenzhai 0:5ca44aa85a30 23 * of this software and associated documentation files (the "Software"), to deal
chenzhai 0:5ca44aa85a30 24 * in the Software without restriction, including without limitation the rights
chenzhai 0:5ca44aa85a30 25 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
chenzhai 0:5ca44aa85a30 26 * copies of the Software, and to permit persons to whom the Software is
chenzhai 0:5ca44aa85a30 27 * furnished to do so, subject to the following conditions:
chenzhai 0:5ca44aa85a30 28 *
chenzhai 0:5ca44aa85a30 29 * The above copyright notice and this permission notice shall be included in
chenzhai 0:5ca44aa85a30 30 * all copies or substantial portions of the Software.
chenzhai 0:5ca44aa85a30 31 *
chenzhai 0:5ca44aa85a30 32 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
chenzhai 0:5ca44aa85a30 33 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
chenzhai 0:5ca44aa85a30 34 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
chenzhai 0:5ca44aa85a30 35 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
chenzhai 0:5ca44aa85a30 36 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
chenzhai 0:5ca44aa85a30 37 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
chenzhai 0:5ca44aa85a30 38 * THE SOFTWARE.
chenzhai 0:5ca44aa85a30 39 *
chenzhai 0:5ca44aa85a30 40 * @section DESCRIPTION
chenzhai 0:5ca44aa85a30 41 *
chenzhai 0:5ca44aa85a30 42 * ADXL345, triple axis, I2C interface, accelerometer.
chenzhai 0:5ca44aa85a30 43 *
chenzhai 0:5ca44aa85a30 44 * Datasheet:
chenzhai 0:5ca44aa85a30 45 *
chenzhai 0:5ca44aa85a30 46 * http://www.analog.com/static/imported-files/data_sheets/ADXL345.pdf
chenzhai 0:5ca44aa85a30 47 */
chenzhai 0:5ca44aa85a30 48
chenzhai 0:5ca44aa85a30 49
chenzhai 0:5ca44aa85a30 50
chenzhai 0:5ca44aa85a30 51 #ifndef ADXL345_I2C_H
chenzhai 0:5ca44aa85a30 52 #define ADXL345_I2C_H
chenzhai 0:5ca44aa85a30 53
chenzhai 0:5ca44aa85a30 54 /**
chenzhai 0:5ca44aa85a30 55 * Includes
chenzhai 0:5ca44aa85a30 56 */
chenzhai 0:5ca44aa85a30 57 #include "mbed.h"
chenzhai 0:5ca44aa85a30 58
chenzhai 0:5ca44aa85a30 59 /**
chenzhai 0:5ca44aa85a30 60 * Defines
chenzhai 0:5ca44aa85a30 61 */
chenzhai 0:5ca44aa85a30 62 //Registers.
chenzhai 0:5ca44aa85a30 63 #define ADXL345_DEVID_REG 0x00
chenzhai 0:5ca44aa85a30 64 #define ADXL345_THRESH_TAP_REG 0x1D
chenzhai 0:5ca44aa85a30 65 #define ADXL345_OFSX_REG 0x1E
chenzhai 0:5ca44aa85a30 66 #define ADXL345_OFSY_REG 0x1F
chenzhai 0:5ca44aa85a30 67 #define ADXL345_OFSZ_REG 0x20
chenzhai 0:5ca44aa85a30 68 #define ADXL345_DUR_REG 0x21
chenzhai 0:5ca44aa85a30 69 #define ADXL345_LATENT_REG 0x22
chenzhai 0:5ca44aa85a30 70 #define ADXL345_WINDOW_REG 0x23
chenzhai 0:5ca44aa85a30 71 #define ADXL345_THRESH_ACT_REG 0x24
chenzhai 0:5ca44aa85a30 72 #define ADXL345_THRESH_INACT_REG 0x25
chenzhai 0:5ca44aa85a30 73 #define ADXL345_TIME_INACT_REG 0x26
chenzhai 0:5ca44aa85a30 74 #define ADXL345_ACT_INACT_CTL_REG 0x27
chenzhai 0:5ca44aa85a30 75 #define ADXL345_THRESH_FF_REG 0x28
chenzhai 0:5ca44aa85a30 76 #define ADXL345_TIME_FF_REG 0x29
chenzhai 0:5ca44aa85a30 77 #define ADXL345_TAP_AXES_REG 0x2A
chenzhai 0:5ca44aa85a30 78 #define ADXL345_ACT_TAP_STATUS_REG 0x2B
chenzhai 0:5ca44aa85a30 79 #define ADXL345_BW_RATE_REG 0x2C
chenzhai 0:5ca44aa85a30 80 #define ADXL345_POWER_CTL_REG 0x2D
chenzhai 0:5ca44aa85a30 81 #define ADXL345_INT_ENABLE_REG 0x2E
chenzhai 0:5ca44aa85a30 82 #define ADXL345_INT_MAP_REG 0x2F
chenzhai 0:5ca44aa85a30 83 #define ADXL345_INT_SOURCE_REG 0x30
chenzhai 0:5ca44aa85a30 84 #define ADXL345_DATA_FORMAT_REG 0x31
chenzhai 0:5ca44aa85a30 85 #define ADXL345_DATAX0_REG 0x32
chenzhai 0:5ca44aa85a30 86 #define ADXL345_DATAX1_REG 0x33
chenzhai 0:5ca44aa85a30 87 #define ADXL345_DATAY0_REG 0x34
chenzhai 0:5ca44aa85a30 88 #define ADXL345_DATAY1_REG 0x35
chenzhai 0:5ca44aa85a30 89 #define ADXL345_DATAZ0_REG 0x36
chenzhai 0:5ca44aa85a30 90 #define ADXL345_DATAZ1_REG 0x37
chenzhai 0:5ca44aa85a30 91 #define ADXL345_FIFO_CTL 0x38
chenzhai 0:5ca44aa85a30 92 #define ADXL345_FIFO_STATUS 0x39
chenzhai 0:5ca44aa85a30 93
chenzhai 0:5ca44aa85a30 94 //Data rate codes.
chenzhai 0:5ca44aa85a30 95 #define ADXL345_3200HZ 0x0F
chenzhai 0:5ca44aa85a30 96 #define ADXL345_1600HZ 0x0E
chenzhai 0:5ca44aa85a30 97 #define ADXL345_800HZ 0x0D
chenzhai 0:5ca44aa85a30 98 #define ADXL345_400HZ 0x0C
chenzhai 0:5ca44aa85a30 99 #define ADXL345_200HZ 0x0B
chenzhai 0:5ca44aa85a30 100 #define ADXL345_100HZ 0x0A
chenzhai 0:5ca44aa85a30 101 #define ADXL345_50HZ 0x09
chenzhai 0:5ca44aa85a30 102 #define ADXL345_25HZ 0x08
chenzhai 0:5ca44aa85a30 103 #define ADXL345_12HZ5 0x07
chenzhai 0:5ca44aa85a30 104 #define ADXL345_6HZ25 0x06
chenzhai 0:5ca44aa85a30 105
chenzhai 0:5ca44aa85a30 106 // read or write bytes
chenzhai 0:5ca44aa85a30 107 #define ADXL345_I2C_READ 0xA7
chenzhai 0:5ca44aa85a30 108 #define ADXL345_I2C_WRITE 0xA6
chenzhai 0:5ca44aa85a30 109 #define ADXL345_I2C_ADDRESS 0x53 //the ADXL345 7-bit address is 0x53 when ALT ADDRESS is low as it is on the sparkfun chip: when ALT ADDRESS is high the address is 0x1D
chenzhai 0:5ca44aa85a30 110
chenzhai 0:5ca44aa85a30 111 /////////////when ALT ADDRESS pin is high:
chenzhai 0:5ca44aa85a30 112 //#define ADXL345_I2C_READ 0x3B
chenzhai 0:5ca44aa85a30 113 //#define ADXL345_I2C_WRITE 0x3A
chenzhai 0:5ca44aa85a30 114 //#define ADXL345_I2C_ADDRESS 0x1D
chenzhai 0:5ca44aa85a30 115
chenzhai 0:5ca44aa85a30 116 #define ADXL345_X 0x00
chenzhai 0:5ca44aa85a30 117 #define ADXL345_Y 0x01
chenzhai 0:5ca44aa85a30 118 #define ADXL345_Z 0x02
chenzhai 0:5ca44aa85a30 119
chenzhai 0:5ca44aa85a30 120
chenzhai 0:5ca44aa85a30 121
chenzhai 0:5ca44aa85a30 122 // modes
chenzhai 0:5ca44aa85a30 123 #define MeasurementMode 0x08
chenzhai 0:5ca44aa85a30 124
chenzhai 0:5ca44aa85a30 125
chenzhai 0:5ca44aa85a30 126
chenzhai 0:5ca44aa85a30 127
chenzhai 0:5ca44aa85a30 128
chenzhai 0:5ca44aa85a30 129
chenzhai 0:5ca44aa85a30 130
chenzhai 0:5ca44aa85a30 131 class ADXL345_I2C {
chenzhai 0:5ca44aa85a30 132
chenzhai 0:5ca44aa85a30 133 public:
chenzhai 0:5ca44aa85a30 134
chenzhai 0:5ca44aa85a30 135 /**
chenzhai 0:5ca44aa85a30 136 * Constructor.
chenzhai 0:5ca44aa85a30 137 *
chenzhai 0:5ca44aa85a30 138 * @param mosi mbed pin to use for SDA line of I2C interface.
chenzhai 0:5ca44aa85a30 139 * @param sck mbed pin to use for SCL line of I2C interface.
chenzhai 0:5ca44aa85a30 140 */
chenzhai 0:5ca44aa85a30 141 ADXL345_I2C(PinName sda, PinName scl);
chenzhai 0:5ca44aa85a30 142
chenzhai 0:5ca44aa85a30 143 /**
chenzhai 0:5ca44aa85a30 144 * Get the output of all three axes.
chenzhai 0:5ca44aa85a30 145 *
chenzhai 0:5ca44aa85a30 146 * @param Pointer to a buffer to hold the accelerometer value for the
chenzhai 0:5ca44aa85a30 147 * x-axis, y-axis and z-axis [in that order].
chenzhai 0:5ca44aa85a30 148 */
chenzhai 0:5ca44aa85a30 149 void getOutput(int* readings);
chenzhai 0:5ca44aa85a30 150
chenzhai 0:5ca44aa85a30 151 /**
chenzhai 0:5ca44aa85a30 152 * Read the device ID register on the device.
chenzhai 0:5ca44aa85a30 153 *
chenzhai 0:5ca44aa85a30 154 * @return The device ID code [0xE5]
chenzhai 0:5ca44aa85a30 155 */
chenzhai 0:5ca44aa85a30 156 char getDeviceID(void);
chenzhai 0:5ca44aa85a30 157
chenzhai 0:5ca44aa85a30 158
chenzhai 0:5ca44aa85a30 159
chenzhai 0:5ca44aa85a30 160 /**
chenzhai 0:5ca44aa85a30 161 * Set the power mode.
chenzhai 0:5ca44aa85a30 162 *
chenzhai 0:5ca44aa85a30 163 * @param mode 0 -> Normal operation.
chenzhai 0:5ca44aa85a30 164 * 1 -> Reduced power operation.
chenzhai 0:5ca44aa85a30 165 */
chenzhai 0:5ca44aa85a30 166 int setPowerMode(char mode);
chenzhai 0:5ca44aa85a30 167
chenzhai 0:5ca44aa85a30 168 /**
chenzhai 0:5ca44aa85a30 169 * Set the power control settings.
chenzhai 0:5ca44aa85a30 170 *
chenzhai 0:5ca44aa85a30 171 * See datasheet for details.
chenzhai 0:5ca44aa85a30 172 *
chenzhai 0:5ca44aa85a30 173 * @param The control byte to write to the POWER_CTL register.
chenzhai 0:5ca44aa85a30 174 */
chenzhai 0:5ca44aa85a30 175 int setPowerControl(char settings);
chenzhai 0:5ca44aa85a30 176 /**
chenzhai 0:5ca44aa85a30 177 * Get the power control settings.
chenzhai 0:5ca44aa85a30 178 *
chenzhai 0:5ca44aa85a30 179 * See datasheet for details.
chenzhai 0:5ca44aa85a30 180 *
chenzhai 0:5ca44aa85a30 181 * @return The contents of the POWER_CTL register.
chenzhai 0:5ca44aa85a30 182 */
chenzhai 0:5ca44aa85a30 183 char getPowerControl(void);
chenzhai 0:5ca44aa85a30 184
chenzhai 0:5ca44aa85a30 185
chenzhai 0:5ca44aa85a30 186 /**
chenzhai 0:5ca44aa85a30 187 * Get the data format settings.
chenzhai 0:5ca44aa85a30 188 *
chenzhai 0:5ca44aa85a30 189 * @return The contents of the DATA_FORMAT register.
chenzhai 0:5ca44aa85a30 190 */
chenzhai 0:5ca44aa85a30 191
chenzhai 0:5ca44aa85a30 192 char getDataFormatControl(void);
chenzhai 0:5ca44aa85a30 193
chenzhai 0:5ca44aa85a30 194 /**
chenzhai 0:5ca44aa85a30 195 * Set the data format settings.
chenzhai 0:5ca44aa85a30 196 *
chenzhai 0:5ca44aa85a30 197 * @param settings The control byte to write to the DATA_FORMAT register.
chenzhai 0:5ca44aa85a30 198 */
chenzhai 0:5ca44aa85a30 199 int setDataFormatControl(char settings);
chenzhai 0:5ca44aa85a30 200
chenzhai 0:5ca44aa85a30 201 /**
chenzhai 0:5ca44aa85a30 202 * Set the data rate.
chenzhai 0:5ca44aa85a30 203 *
chenzhai 0:5ca44aa85a30 204 * @param rate The rate code (see #defines or datasheet).
chenzhai 0:5ca44aa85a30 205 */
chenzhai 0:5ca44aa85a30 206 int setDataRate(char rate);
chenzhai 0:5ca44aa85a30 207
chenzhai 0:5ca44aa85a30 208
chenzhai 0:5ca44aa85a30 209 /**
chenzhai 0:5ca44aa85a30 210 * Get the current offset for a particular axis.
chenzhai 0:5ca44aa85a30 211 *
chenzhai 0:5ca44aa85a30 212 * @param axis 0x00 -> X-axis
chenzhai 0:5ca44aa85a30 213 * 0x01 -> Y-axis
chenzhai 0:5ca44aa85a30 214 * 0x02 -> Z-axis
chenzhai 0:5ca44aa85a30 215 * @return The current offset as an 8-bit 2's complement number with scale
chenzhai 0:5ca44aa85a30 216 * factor 15.6mg/LSB.
chenzhai 0:5ca44aa85a30 217 */
chenzhai 0:5ca44aa85a30 218
chenzhai 0:5ca44aa85a30 219 char getOffset(char axis);
chenzhai 0:5ca44aa85a30 220
chenzhai 0:5ca44aa85a30 221 /**
chenzhai 0:5ca44aa85a30 222 * Set the offset for a particular axis.
chenzhai 0:5ca44aa85a30 223 *
chenzhai 0:5ca44aa85a30 224 * @param axis 0x00 -> X-axis
chenzhai 0:5ca44aa85a30 225 * 0x01 -> Y-axis
chenzhai 0:5ca44aa85a30 226 * 0x02 -> Z-axis
chenzhai 0:5ca44aa85a30 227 * @param offset The offset as an 8-bit 2's complement number with scale
chenzhai 0:5ca44aa85a30 228 * factor 15.6mg/LSB.
chenzhai 0:5ca44aa85a30 229 */
chenzhai 0:5ca44aa85a30 230 int setOffset(char axis, char offset);
chenzhai 0:5ca44aa85a30 231
chenzhai 0:5ca44aa85a30 232
chenzhai 0:5ca44aa85a30 233
chenzhai 0:5ca44aa85a30 234 /**
chenzhai 0:5ca44aa85a30 235 * Get the FIFO control settings.
chenzhai 0:5ca44aa85a30 236 *
chenzhai 0:5ca44aa85a30 237 * @return The contents of the FIFO_CTL register.
chenzhai 0:5ca44aa85a30 238 */
chenzhai 0:5ca44aa85a30 239 char getFifoControl(void);
chenzhai 0:5ca44aa85a30 240
chenzhai 0:5ca44aa85a30 241 /**
chenzhai 0:5ca44aa85a30 242 * Set the FIFO control settings.
chenzhai 0:5ca44aa85a30 243 *
chenzhai 0:5ca44aa85a30 244 * @param The control byte to write to the FIFO_CTL register.
chenzhai 0:5ca44aa85a30 245 */
chenzhai 0:5ca44aa85a30 246 int setFifoControl(char settings);
chenzhai 0:5ca44aa85a30 247
chenzhai 0:5ca44aa85a30 248 /**
chenzhai 0:5ca44aa85a30 249 * Get FIFO status.
chenzhai 0:5ca44aa85a30 250 *
chenzhai 0:5ca44aa85a30 251 * @return The contents of the FIFO_STATUS register.
chenzhai 0:5ca44aa85a30 252 */
chenzhai 0:5ca44aa85a30 253 char getFifoStatus(void);
chenzhai 0:5ca44aa85a30 254
chenzhai 0:5ca44aa85a30 255 /**
chenzhai 0:5ca44aa85a30 256 * Read the tap threshold on the device.
chenzhai 0:5ca44aa85a30 257 *
chenzhai 0:5ca44aa85a30 258 * @return The tap threshold as an 8-bit number with a scale factor of
chenzhai 0:5ca44aa85a30 259 * 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 260 */
chenzhai 0:5ca44aa85a30 261 char getTapThreshold(void);
chenzhai 0:5ca44aa85a30 262
chenzhai 0:5ca44aa85a30 263 /**
chenzhai 0:5ca44aa85a30 264 * Set the tap threshold.
chenzhai 0:5ca44aa85a30 265 *
chenzhai 0:5ca44aa85a30 266 * @param The tap threshold as an 8-bit number with a scale factor of
chenzhai 0:5ca44aa85a30 267 * 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 268 */
chenzhai 0:5ca44aa85a30 269 int setTapThreshold(char threshold);
chenzhai 0:5ca44aa85a30 270
chenzhai 0:5ca44aa85a30 271 /**
chenzhai 0:5ca44aa85a30 272 * Get the tap duration required to trigger an event.
chenzhai 0:5ca44aa85a30 273 *
chenzhai 0:5ca44aa85a30 274 * @return The max time that an event must be above the tap threshold to
chenzhai 0:5ca44aa85a30 275 * qualify as a tap event, in microseconds.
chenzhai 0:5ca44aa85a30 276 */
chenzhai 0:5ca44aa85a30 277 float getTapDuration(void);
chenzhai 0:5ca44aa85a30 278
chenzhai 0:5ca44aa85a30 279 /**
chenzhai 0:5ca44aa85a30 280 * Set the tap duration required to trigger an event.
chenzhai 0:5ca44aa85a30 281 *
chenzhai 0:5ca44aa85a30 282 * @param duration_us The max time that an event must be above the tap
chenzhai 0:5ca44aa85a30 283 * threshold to qualify as a tap event, in microseconds.
chenzhai 0:5ca44aa85a30 284 * Time will be normalized by the scale factor which is
chenzhai 0:5ca44aa85a30 285 * 625us/LSB. A value of 0 disables the single/double
chenzhai 0:5ca44aa85a30 286 * tap functions.
chenzhai 0:5ca44aa85a30 287 */
chenzhai 0:5ca44aa85a30 288 int setTapDuration(short int duration_us);
chenzhai 0:5ca44aa85a30 289
chenzhai 0:5ca44aa85a30 290 /**
chenzhai 0:5ca44aa85a30 291 * Get the tap latency between the detection of a tap and the time window.
chenzhai 0:5ca44aa85a30 292 *
chenzhai 0:5ca44aa85a30 293 * @return The wait time from the detection of a tap event to the start of
chenzhai 0:5ca44aa85a30 294 * the time window during which a possible second tap event can be
chenzhai 0:5ca44aa85a30 295 * detected in milliseconds.
chenzhai 0:5ca44aa85a30 296 */
chenzhai 0:5ca44aa85a30 297 float getTapLatency(void);
chenzhai 0:5ca44aa85a30 298
chenzhai 0:5ca44aa85a30 299 /**
chenzhai 0:5ca44aa85a30 300 * Set the tap latency between the detection of a tap and the time window.
chenzhai 0:5ca44aa85a30 301 *
chenzhai 0:5ca44aa85a30 302 * @param latency_ms The wait time from the detection of a tap event to the
chenzhai 0:5ca44aa85a30 303 * start of the time window during which a possible
chenzhai 0:5ca44aa85a30 304 * second tap event can be detected in milliseconds.
chenzhai 0:5ca44aa85a30 305 * A value of 0 disables the double tap function.
chenzhai 0:5ca44aa85a30 306 */
chenzhai 0:5ca44aa85a30 307 int setTapLatency(short int latency_ms);
chenzhai 0:5ca44aa85a30 308
chenzhai 0:5ca44aa85a30 309 /**
chenzhai 0:5ca44aa85a30 310 * Get the time of window between tap latency and a double tap.
chenzhai 0:5ca44aa85a30 311 *
chenzhai 0:5ca44aa85a30 312 * @return The amount of time after the expiration of the latency time
chenzhai 0:5ca44aa85a30 313 * during which a second valid tap can begin, in milliseconds.
chenzhai 0:5ca44aa85a30 314 */
chenzhai 0:5ca44aa85a30 315 float getWindowTime(void);
chenzhai 0:5ca44aa85a30 316
chenzhai 0:5ca44aa85a30 317 /**
chenzhai 0:5ca44aa85a30 318 * Set the time of the window between tap latency and a double tap.
chenzhai 0:5ca44aa85a30 319 *
chenzhai 0:5ca44aa85a30 320 * @param window_ms The amount of time after the expiration of the latency
chenzhai 0:5ca44aa85a30 321 * time during which a second valid tap can begin,
chenzhai 0:5ca44aa85a30 322 * in milliseconds.
chenzhai 0:5ca44aa85a30 323 */
chenzhai 0:5ca44aa85a30 324 int setWindowTime(short int window_ms);
chenzhai 0:5ca44aa85a30 325
chenzhai 0:5ca44aa85a30 326 /**
chenzhai 0:5ca44aa85a30 327 * Get the threshold value for detecting activity.
chenzhai 0:5ca44aa85a30 328 *
chenzhai 0:5ca44aa85a30 329 * @return The threshold value for detecting activity as an 8-bit number.
chenzhai 0:5ca44aa85a30 330 * Scale factor is 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 331 */
chenzhai 0:5ca44aa85a30 332 char getActivityThreshold(void);
chenzhai 0:5ca44aa85a30 333
chenzhai 0:5ca44aa85a30 334 /**
chenzhai 0:5ca44aa85a30 335 * Set the threshold value for detecting activity.
chenzhai 0:5ca44aa85a30 336 *
chenzhai 0:5ca44aa85a30 337 * @param threshold The threshold value for detecting activity as an 8-bit
chenzhai 0:5ca44aa85a30 338 * number. Scale factor is 62.5mg/LSB. A value of 0 may
chenzhai 0:5ca44aa85a30 339 * result in undesirable behavior if the activity
chenzhai 0:5ca44aa85a30 340 * interrupt is enabled.
chenzhai 0:5ca44aa85a30 341 */
chenzhai 0:5ca44aa85a30 342 int setActivityThreshold(char threshold);
chenzhai 0:5ca44aa85a30 343
chenzhai 0:5ca44aa85a30 344 /**
chenzhai 0:5ca44aa85a30 345 * Get the threshold value for detecting inactivity.
chenzhai 0:5ca44aa85a30 346 *
chenzhai 0:5ca44aa85a30 347 * @return The threshold value for detecting inactivity as an 8-bit number.
chenzhai 0:5ca44aa85a30 348 * Scale factor is 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 349 */
chenzhai 0:5ca44aa85a30 350 char getInactivityThreshold(void);
chenzhai 0:5ca44aa85a30 351
chenzhai 0:5ca44aa85a30 352 /**
chenzhai 0:5ca44aa85a30 353 * Set the threshold value for detecting inactivity.
chenzhai 0:5ca44aa85a30 354 *
chenzhai 0:5ca44aa85a30 355 * @param threshold The threshold value for detecting inactivity as an
chenzhai 0:5ca44aa85a30 356 * 8-bit number. Scale factor is 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 357 */
chenzhai 0:5ca44aa85a30 358 int setInactivityThreshold(char threshold);
chenzhai 0:5ca44aa85a30 359
chenzhai 0:5ca44aa85a30 360 /**
chenzhai 0:5ca44aa85a30 361 * Get the time required for inactivity to be declared.
chenzhai 0:5ca44aa85a30 362 *
chenzhai 0:5ca44aa85a30 363 * @return The amount of time that acceleration must be less than the
chenzhai 0:5ca44aa85a30 364 * inactivity threshold for inactivity to be declared, in
chenzhai 0:5ca44aa85a30 365 * seconds.
chenzhai 0:5ca44aa85a30 366 */
chenzhai 0:5ca44aa85a30 367 char getTimeInactivity(void);
chenzhai 0:5ca44aa85a30 368
chenzhai 0:5ca44aa85a30 369 /**
chenzhai 0:5ca44aa85a30 370 * Set the time required for inactivity to be declared.
chenzhai 0:5ca44aa85a30 371 *
chenzhai 0:5ca44aa85a30 372 * @param inactivity The amount of time that acceleration must be less than
chenzhai 0:5ca44aa85a30 373 * the inactivity threshold for inactivity to be
chenzhai 0:5ca44aa85a30 374 * declared, in seconds. A value of 0 results in an
chenzhai 0:5ca44aa85a30 375 * interrupt when the output data is less than the
chenzhai 0:5ca44aa85a30 376 * threshold inactivity.
chenzhai 0:5ca44aa85a30 377 */
chenzhai 0:5ca44aa85a30 378 int setTimeInactivity(char timeInactivity);
chenzhai 0:5ca44aa85a30 379
chenzhai 0:5ca44aa85a30 380 /**
chenzhai 0:5ca44aa85a30 381 * Get the activity/inactivity control settings.
chenzhai 0:5ca44aa85a30 382 *
chenzhai 0:5ca44aa85a30 383 * D7 D6 D5 D4
chenzhai 0:5ca44aa85a30 384 * +-----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 385 * | ACT ac/dc | ACT_X enable | ACT_Y enable | ACT_Z enable |
chenzhai 0:5ca44aa85a30 386 * +-----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 387 *
chenzhai 0:5ca44aa85a30 388 * D3 D2 D1 D0
chenzhai 0:5ca44aa85a30 389 * +-------------+----------------+----------------+----------------+
chenzhai 0:5ca44aa85a30 390 * | INACT ac/dc | INACT_X enable | INACT_Y enable | INACT_Z enable |
chenzhai 0:5ca44aa85a30 391 * +-------------+----------------+----------------+----------------+
chenzhai 0:5ca44aa85a30 392 *
chenzhai 0:5ca44aa85a30 393 * See datasheet for details.
chenzhai 0:5ca44aa85a30 394 *
chenzhai 0:5ca44aa85a30 395 * @return The contents of the ACT_INACT_CTL register.
chenzhai 0:5ca44aa85a30 396 */
chenzhai 0:5ca44aa85a30 397 char getActivityInactivityControl(void);
chenzhai 0:5ca44aa85a30 398
chenzhai 0:5ca44aa85a30 399 /**
chenzhai 0:5ca44aa85a30 400 * Set the activity/inactivity control settings.
chenzhai 0:5ca44aa85a30 401 *
chenzhai 0:5ca44aa85a30 402 * D7 D6 D5 D4
chenzhai 0:5ca44aa85a30 403 * +-----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 404 * | ACT ac/dc | ACT_X enable | ACT_Y enable | ACT_Z enable |
chenzhai 0:5ca44aa85a30 405 * +-----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 406 *
chenzhai 0:5ca44aa85a30 407 * D3 D2 D1 D0
chenzhai 0:5ca44aa85a30 408 * +-------------+----------------+----------------+----------------+
chenzhai 0:5ca44aa85a30 409 * | INACT ac/dc | INACT_X enable | INACT_Y enable | INACT_Z enable |
chenzhai 0:5ca44aa85a30 410 * +-------------+----------------+----------------+----------------+
chenzhai 0:5ca44aa85a30 411 *
chenzhai 0:5ca44aa85a30 412 * See datasheet for details.
chenzhai 0:5ca44aa85a30 413 *
chenzhai 0:5ca44aa85a30 414 * @param settings The control byte to write to the ACT_INACT_CTL register.
chenzhai 0:5ca44aa85a30 415 */
chenzhai 0:5ca44aa85a30 416 int setActivityInactivityControl(char settings);
chenzhai 0:5ca44aa85a30 417
chenzhai 0:5ca44aa85a30 418 /**
chenzhai 0:5ca44aa85a30 419 * Get the threshold for free fall detection.
chenzhai 0:5ca44aa85a30 420 *
chenzhai 0:5ca44aa85a30 421 * @return The threshold value for free-fall detection, as an 8-bit number,
chenzhai 0:5ca44aa85a30 422 * with scale factor 62.5mg/LSB.
chenzhai 0:5ca44aa85a30 423 */
chenzhai 0:5ca44aa85a30 424 char getFreefallThreshold(void);
chenzhai 0:5ca44aa85a30 425
chenzhai 0:5ca44aa85a30 426 /**
chenzhai 0:5ca44aa85a30 427 * Set the threshold for free fall detection.
chenzhai 0:5ca44aa85a30 428 *
chenzhai 0:5ca44aa85a30 429 * @return The threshold value for free-fall detection, as an 8-bit number,
chenzhai 0:5ca44aa85a30 430 * with scale factor 62.5mg/LSB. A value of 0 may result in
chenzhai 0:5ca44aa85a30 431 * undesirable behavior if the free-fall interrupt is enabled.
chenzhai 0:5ca44aa85a30 432 * Values between 300 mg and 600 mg (0x05 to 0x09) are recommended.
chenzhai 0:5ca44aa85a30 433 */
chenzhai 0:5ca44aa85a30 434 int setFreefallThreshold(char threshold);
chenzhai 0:5ca44aa85a30 435
chenzhai 0:5ca44aa85a30 436 /**
chenzhai 0:5ca44aa85a30 437 * Get the time required to generate a free fall interrupt.
chenzhai 0:5ca44aa85a30 438 *
chenzhai 0:5ca44aa85a30 439 * @return The minimum time that the value of all axes must be less than
chenzhai 0:5ca44aa85a30 440 * the freefall threshold to generate a free-fall interrupt, in
chenzhai 0:5ca44aa85a30 441 * milliseconds.
chenzhai 0:5ca44aa85a30 442 */
chenzhai 0:5ca44aa85a30 443 char getFreefallTime(void);
chenzhai 0:5ca44aa85a30 444
chenzhai 0:5ca44aa85a30 445 /**
chenzhai 0:5ca44aa85a30 446 * Set the time required to generate a free fall interrupt.
chenzhai 0:5ca44aa85a30 447 *
chenzhai 0:5ca44aa85a30 448 * @return The minimum time that the value of all axes must be less than
chenzhai 0:5ca44aa85a30 449 * the freefall threshold to generate a free-fall interrupt, in
chenzhai 0:5ca44aa85a30 450 * milliseconds. A value of 0 may result in undesirable behavior
chenzhai 0:5ca44aa85a30 451 * if the free-fall interrupt is enabled. Values between 100 ms
chenzhai 0:5ca44aa85a30 452 * and 350 ms (0x14 to 0x46) are recommended.
chenzhai 0:5ca44aa85a30 453 */
chenzhai 0:5ca44aa85a30 454 int setFreefallTime(short int freefallTime_ms);
chenzhai 0:5ca44aa85a30 455
chenzhai 0:5ca44aa85a30 456 /**
chenzhai 0:5ca44aa85a30 457 * Get the axis tap settings.
chenzhai 0:5ca44aa85a30 458 *
chenzhai 0:5ca44aa85a30 459 * D3 D2 D1 D0
chenzhai 0:5ca44aa85a30 460 * +----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 461 * | Suppress | TAP_X enable | TAP_Y enable | TAP_Z enable |
chenzhai 0:5ca44aa85a30 462 * +----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 463 *
chenzhai 0:5ca44aa85a30 464 * (D7-D4 are 0s).
chenzhai 0:5ca44aa85a30 465 *
chenzhai 0:5ca44aa85a30 466 * See datasheet for more details.
chenzhai 0:5ca44aa85a30 467 *
chenzhai 0:5ca44aa85a30 468 * @return The contents of the TAP_AXES register.
chenzhai 0:5ca44aa85a30 469 */
chenzhai 0:5ca44aa85a30 470 char getTapAxisControl(void);
chenzhai 0:5ca44aa85a30 471
chenzhai 0:5ca44aa85a30 472 /**
chenzhai 0:5ca44aa85a30 473 * Set the axis tap settings.
chenzhai 0:5ca44aa85a30 474 *
chenzhai 0:5ca44aa85a30 475 * D3 D2 D1 D0
chenzhai 0:5ca44aa85a30 476 * +----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 477 * | Suppress | TAP_X enable | TAP_Y enable | TAP_Z enable |
chenzhai 0:5ca44aa85a30 478 * +----------+--------------+--------------+--------------+
chenzhai 0:5ca44aa85a30 479 *
chenzhai 0:5ca44aa85a30 480 * (D7-D4 are 0s).
chenzhai 0:5ca44aa85a30 481 *
chenzhai 0:5ca44aa85a30 482 * See datasheet for more details.
chenzhai 0:5ca44aa85a30 483 *
chenzhai 0:5ca44aa85a30 484 * @param The control byte to write to the TAP_AXES register.
chenzhai 0:5ca44aa85a30 485 */
chenzhai 0:5ca44aa85a30 486 int setTapAxisControl(char settings);
chenzhai 0:5ca44aa85a30 487
chenzhai 0:5ca44aa85a30 488 /**
chenzhai 0:5ca44aa85a30 489 * Get the source of a tap.
chenzhai 0:5ca44aa85a30 490 *
chenzhai 0:5ca44aa85a30 491 * @return The contents of the ACT_TAP_STATUS register.
chenzhai 0:5ca44aa85a30 492 */
chenzhai 0:5ca44aa85a30 493 char getTapSource(void);
chenzhai 0:5ca44aa85a30 494
chenzhai 0:5ca44aa85a30 495 /**
chenzhai 0:5ca44aa85a30 496 * Get the interrupt enable settings.
chenzhai 0:5ca44aa85a30 497 *
chenzhai 0:5ca44aa85a30 498 * @return The contents of the INT_ENABLE register.
chenzhai 0:5ca44aa85a30 499 */
chenzhai 0:5ca44aa85a30 500
chenzhai 0:5ca44aa85a30 501 char getInterruptEnableControl(void);
chenzhai 0:5ca44aa85a30 502
chenzhai 0:5ca44aa85a30 503 /**
chenzhai 0:5ca44aa85a30 504 * Set the interrupt enable settings.
chenzhai 0:5ca44aa85a30 505 *
chenzhai 0:5ca44aa85a30 506 * @param settings The control byte to write to the INT_ENABLE register.
chenzhai 0:5ca44aa85a30 507 */
chenzhai 0:5ca44aa85a30 508 int setInterruptEnableControl(char settings);
chenzhai 0:5ca44aa85a30 509
chenzhai 0:5ca44aa85a30 510 /**
chenzhai 0:5ca44aa85a30 511 * Get the interrupt mapping settings.
chenzhai 0:5ca44aa85a30 512 *
chenzhai 0:5ca44aa85a30 513 * @return The contents of the INT_MAP register.
chenzhai 0:5ca44aa85a30 514 */
chenzhai 0:5ca44aa85a30 515 char getInterruptMappingControl(void);
chenzhai 0:5ca44aa85a30 516
chenzhai 0:5ca44aa85a30 517 /**
chenzhai 0:5ca44aa85a30 518 * Set the interrupt mapping settings.
chenzhai 0:5ca44aa85a30 519 *
chenzhai 0:5ca44aa85a30 520 * @param settings The control byte to write to the INT_MAP register.
chenzhai 0:5ca44aa85a30 521 */
chenzhai 0:5ca44aa85a30 522 int setInterruptMappingControl(char settings);
chenzhai 0:5ca44aa85a30 523
chenzhai 0:5ca44aa85a30 524 /**
chenzhai 0:5ca44aa85a30 525 * Get the interrupt source.
chenzhai 0:5ca44aa85a30 526 *
chenzhai 0:5ca44aa85a30 527 * @return The contents of the INT_SOURCE register.
chenzhai 0:5ca44aa85a30 528 */
chenzhai 0:5ca44aa85a30 529 char getInterruptSource(void);
chenzhai 0:5ca44aa85a30 530
chenzhai 0:5ca44aa85a30 531
chenzhai 0:5ca44aa85a30 532 //private:
chenzhai 0:5ca44aa85a30 533
chenzhai 0:5ca44aa85a30 534 I2C i2c_;
chenzhai 0:5ca44aa85a30 535
chenzhai 0:5ca44aa85a30 536
chenzhai 0:5ca44aa85a30 537 /**
chenzhai 0:5ca44aa85a30 538 * Read one byte from a register on the device.
chenzhai 0:5ca44aa85a30 539 *
chenzhai 0:5ca44aa85a30 540 * @param: - the address to be read from
chenzhai 0:5ca44aa85a30 541 *
chenzhai 0:5ca44aa85a30 542 * @return: the value of the data read
chenzhai 0:5ca44aa85a30 543 */
chenzhai 0:5ca44aa85a30 544 char SingleByteRead(char address);
chenzhai 0:5ca44aa85a30 545
chenzhai 0:5ca44aa85a30 546 /**
chenzhai 0:5ca44aa85a30 547 * Write one byte to a register on the device.
chenzhai 0:5ca44aa85a30 548 *
chenzhai 0:5ca44aa85a30 549 * @param:
chenzhai 0:5ca44aa85a30 550 - address of the register to write to.
chenzhai 0:5ca44aa85a30 551 - the value of the data to store
chenzhai 0:5ca44aa85a30 552 */
chenzhai 0:5ca44aa85a30 553
chenzhai 0:5ca44aa85a30 554
chenzhai 0:5ca44aa85a30 555 int SingleByteWrite(char address, char data);
chenzhai 0:5ca44aa85a30 556
chenzhai 0:5ca44aa85a30 557 /**
chenzhai 0:5ca44aa85a30 558 * Read several consecutive bytes on the device and store them in a given location.
chenzhai 0:5ca44aa85a30 559 *
chenzhai 0:5ca44aa85a30 560 * @param startAddress: The address of the first register to read from.
chenzhai 0:5ca44aa85a30 561 * @param ptr_output: a pointer to the location to store the data being read
chenzhai 0:5ca44aa85a30 562 * @param size: The number of bytes to read.
chenzhai 0:5ca44aa85a30 563 */
chenzhai 0:5ca44aa85a30 564 void multiByteRead(char startAddress, char* ptr_output, int size);
chenzhai 0:5ca44aa85a30 565
chenzhai 0:5ca44aa85a30 566 /**
chenzhai 0:5ca44aa85a30 567 * Write several consecutive bytes on the device.
chenzhai 0:5ca44aa85a30 568 *
chenzhai 0:5ca44aa85a30 569 * @param startAddress: The address of the first register to write to.
chenzhai 0:5ca44aa85a30 570 * @param ptr_data: Pointer to a location which contains the data to write.
chenzhai 0:5ca44aa85a30 571 * @param size: The number of bytes to write.
chenzhai 0:5ca44aa85a30 572 */
chenzhai 0:5ca44aa85a30 573 int multiByteWrite(char startAddress, char* ptr_data, int size);
chenzhai 0:5ca44aa85a30 574
chenzhai 0:5ca44aa85a30 575 };
chenzhai 0:5ca44aa85a30 576
chenzhai 0:5ca44aa85a30 577 #endif /* ADXL345_I2C_H */