Analog Devices / ADXL362

ADXL362 accelerometer library

Dependents:   ADXL362-helloworld EVAL_ADXL362_ARDZ Lab6 Lab6 ... more

For additional information check out the mbed page of the Analog Devices wiki: https://wiki.analog.com/resources/tools-software/mbed-drivers-all

ADXL362.h@0:2e21c4508cab, 2016-05-18 (annotated)

Committer:
adisuciu
Date:
Wed May 18 15:17:10 2016 +0000
Revision:
0:2e21c4508cab
Child:
1:ae171c032dc0
Initial revision

Who changed what in which revision?

UserRevisionLine numberNew contents of line
adisuciu 0:2e21c4508cab 1 #ifndef ADXL362_H_
adisuciu 0:2e21c4508cab 2 #define ADXL362_H_
adisuciu 0:2e21c4508cab 3
adisuciu 0:2e21c4508cab 4 /**
adisuciu 0:2e21c4508cab 5 * @file ADXL362.cpp
adisuciu 0:2e21c4508cab 6 * @brief Header file for ADXL362
adisuciu 0:2e21c4508cab 7 * @author Analog Devices Inc.
adisuciu 0:2e21c4508cab 8 *
adisuciu 0:2e21c4508cab 9 * For support please go to:
adisuciu 0:2e21c4508cab 10 * Github: https://github.com/analogdevicesinc/mbed-adi
adisuciu 0:2e21c4508cab 11 * Support: https://ez.analog.com/community/linux-device-drivers/microcontroller-no-os-drivers
adisuciu 0:2e21c4508cab 12 * Product: http://www.analog.com/adxl362
adisuciu 0:2e21c4508cab 13 * More: https://wiki.analog.com/resources/tools-software/mbed-drivers-all
adisuciu 0:2e21c4508cab 14
adisuciu 0:2e21c4508cab 15 ********************************************************************************
adisuciu 0:2e21c4508cab 16 * Copyright 2016(c) Analog Devices, Inc.
adisuciu 0:2e21c4508cab 17 *
adisuciu 0:2e21c4508cab 18 * All rights reserved.
adisuciu 0:2e21c4508cab 19 *
adisuciu 0:2e21c4508cab 20 * Redistribution and use in source and binary forms, with or without
adisuciu 0:2e21c4508cab 21 * modification, are permitted provided that the following conditions are met:
adisuciu 0:2e21c4508cab 22 * - Redistributions of source code must retain the above copyright
adisuciu 0:2e21c4508cab 23 * notice, this list of conditions and the following disclaimer.
adisuciu 0:2e21c4508cab 24 * - Redistributions in binary form must reproduce the above copyright
adisuciu 0:2e21c4508cab 25 * notice, this list of conditions and the following disclaimer in
adisuciu 0:2e21c4508cab 26 * the documentation and/or other materials provided with the
adisuciu 0:2e21c4508cab 27 * distribution.
adisuciu 0:2e21c4508cab 28 * - Neither the name of Analog Devices, Inc. nor the names of its
adisuciu 0:2e21c4508cab 29 * contributors may be used to endorse or promote products derived
adisuciu 0:2e21c4508cab 30 * from this software without specific prior written permission.
adisuciu 0:2e21c4508cab 31 * - The use of this software may or may not infringe the patent rights
adisuciu 0:2e21c4508cab 32 * of one or more patent holders. This license does not release you
adisuciu 0:2e21c4508cab 33 * from the requirement that you obtain separate licenses from these
adisuciu 0:2e21c4508cab 34 * patent holders to use this software.
adisuciu 0:2e21c4508cab 35 * - Use of the software either in source or binary form, must be run
adisuciu 0:2e21c4508cab 36 * on or directly connected to an Analog Devices Inc. component.
adisuciu 0:2e21c4508cab 37 *
adisuciu 0:2e21c4508cab 38 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
adisuciu 0:2e21c4508cab 39 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
adisuciu 0:2e21c4508cab 40 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
adisuciu 0:2e21c4508cab 41 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
adisuciu 0:2e21c4508cab 42 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
adisuciu 0:2e21c4508cab 43 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
adisuciu 0:2e21c4508cab 44 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
adisuciu 0:2e21c4508cab 45 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
adisuciu 0:2e21c4508cab 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
adisuciu 0:2e21c4508cab 47 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
adisuciu 0:2e21c4508cab 48 *
adisuciu 0:2e21c4508cab 49 ********************************************************************************/
adisuciu 0:2e21c4508cab 50
adisuciu 0:2e21c4508cab 51 #include "mbed.h"
adisuciu 0:2e21c4508cab 52
adisuciu 0:2e21c4508cab 53 class ADXL362
adisuciu 0:2e21c4508cab 54 {
adisuciu 0:2e21c4508cab 55 public:
adisuciu 0:2e21c4508cab 56
adisuciu 0:2e21c4508cab 57 /* Temperature parameters */
adisuciu 0:2e21c4508cab 58 typedef enum {
adisuciu 0:2e21c4508cab 59 DEVID_AD = 0x00,
adisuciu 0:2e21c4508cab 60 DEVID_MST = 0x01,
adisuciu 0:2e21c4508cab 61 PARTID = 0x02,
adisuciu 0:2e21c4508cab 62 REVID = 0x03,
adisuciu 0:2e21c4508cab 63 XDATA = 0x08,
adisuciu 0:2e21c4508cab 64 YDATA = 0x09,
adisuciu 0:2e21c4508cab 65 ZDATA = 0x0A,
adisuciu 0:2e21c4508cab 66 STATUS = 0x0B,
adisuciu 0:2e21c4508cab 67 FIFO_ENTRIES_L = 0x0C,
adisuciu 0:2e21c4508cab 68 FIFO_ENTRIES_H = 0x0D,
adisuciu 0:2e21c4508cab 69 XDATA_L = 0x0E,
adisuciu 0:2e21c4508cab 70 XDATA_H = 0x0F,
adisuciu 0:2e21c4508cab 71 YDATA_L = 0x10,
adisuciu 0:2e21c4508cab 72 YDATA_H = 0x11,
adisuciu 0:2e21c4508cab 73 ZDATA_L = 0x12,
adisuciu 0:2e21c4508cab 74 ZDATA_H = 0x13,
adisuciu 0:2e21c4508cab 75 TEMP_L = 0x14,
adisuciu 0:2e21c4508cab 76 TEMP_H = 0x15,
adisuciu 0:2e21c4508cab 77 // Reserved = 0x16;
adisuciu 0:2e21c4508cab 78 // Reserved = 0x17;
adisuciu 0:2e21c4508cab 79 SOFT_RESET = 0x1F,
adisuciu 0:2e21c4508cab 80 THRESH_ACT_L = 0x20,
adisuciu 0:2e21c4508cab 81 THRESH_ACT_H = 0x21,
adisuciu 0:2e21c4508cab 82 TIME_ACT = 0x22,
adisuciu 0:2e21c4508cab 83 THRESH_INACT_L = 0x23,
adisuciu 0:2e21c4508cab 84 THRESH_INACT_H = 0x24,
adisuciu 0:2e21c4508cab 85 TIME_INACT_L = 0x25,
adisuciu 0:2e21c4508cab 86 TIME_INACT_H = 0x26,
adisuciu 0:2e21c4508cab 87 ACT_INACT_CTL = 0x27,
adisuciu 0:2e21c4508cab 88 FIFO_CONTROL = 0x28,
adisuciu 0:2e21c4508cab 89 FIFO_SAMPLES = 0x29,
adisuciu 0:2e21c4508cab 90 INTMAP1 = 0x2A,
adisuciu 0:2e21c4508cab 91 INTMAP2 = 0x2B,
adisuciu 0:2e21c4508cab 92 FILTER_CTL = 0x2C,
adisuciu 0:2e21c4508cab 93 POWER_CTL = 0x2D,
adisuciu 0:2e21c4508cab 94 SELF_TEST = 0x2E,
adisuciu 0:2e21c4508cab 95 } ADXL362_register_t;
adisuciu 0:2e21c4508cab 96
adisuciu 0:2e21c4508cab 97 typedef enum {
adisuciu 0:2e21c4508cab 98 STANDBY = 0x00,
adisuciu 0:2e21c4508cab 99 MEASUREMENT = 0x02
adisuciu 0:2e21c4508cab 100 } ADXL362_modes_t;
adisuciu 0:2e21c4508cab 101
adisuciu 0:2e21c4508cab 102 typedef enum {
adisuciu 0:2e21c4508cab 103 ERR_USER_REGS = 0x80,
adisuciu 0:2e21c4508cab 104 AWAKE = 0x40,
adisuciu 0:2e21c4508cab 105 INACT = 0x20,
adisuciu 0:2e21c4508cab 106 ACT = 0x10,
adisuciu 0:2e21c4508cab 107 FIFO_OVERRUN = 0x08,
adisuciu 0:2e21c4508cab 108 FIFO_WATERMARK = 0x04,
adisuciu 0:2e21c4508cab 109 FIFO_READY = 0x02,
adisuciu 0:2e21c4508cab 110 DATA_READY = 0x01
adisuciu 0:2e21c4508cab 111 } ADXL362_STATUS_reg_bits_t;
adisuciu 0:2e21c4508cab 112
adisuciu 0:2e21c4508cab 113 typedef enum {
adisuciu 0:2e21c4508cab 114 LINKLOOP1 = 0x20,
adisuciu 0:2e21c4508cab 115 LINKLOOP0 = 0x10,
adisuciu 0:2e21c4508cab 116 DEFAULTMODE = 0x00,
adisuciu 0:2e21c4508cab 117 LINKED_MODE = 0x10,
adisuciu 0:2e21c4508cab 118 LOOP_MODE = 0x30,
adisuciu 0:2e21c4508cab 119 INACT_REF = 0x08,
adisuciu 0:2e21c4508cab 120 INACT_EN = 0x04,
adisuciu 0:2e21c4508cab 121 ACT_REF = 0x02,
adisuciu 0:2e21c4508cab 122 ACT_EN = 0x01
adisuciu 0:2e21c4508cab 123 } ADXL362_ACT_INACT_CTL_reg_bits_t;
adisuciu 0:2e21c4508cab 124
adisuciu 0:2e21c4508cab 125 typedef enum {
adisuciu 0:2e21c4508cab 126 AH = 0x08,
adisuciu 0:2e21c4508cab 127 FIFO_TEMP = 0x04,
adisuciu 0:2e21c4508cab 128 FIFO_MODE1 = 0x02,
adisuciu 0:2e21c4508cab 129 FIFO_MODE = 0x01,
adisuciu 0:2e21c4508cab 130 } ADXL362_FIFO_CONTROL_reg_bits_t;
adisuciu 0:2e21c4508cab 131
adisuciu 0:2e21c4508cab 132 typedef enum {
adisuciu 0:2e21c4508cab 133 FIFO_DISABLED = 0x00,
adisuciu 0:2e21c4508cab 134 FIFO_OLDEST = 0x01,
adisuciu 0:2e21c4508cab 135 FIFO_STREAM = 0x02,
adisuciu 0:2e21c4508cab 136 FIFO_TRIGGERED = 0x03,
adisuciu 0:2e21c4508cab 137 } ADXL362_FIFO_modes_t;
adisuciu 0:2e21c4508cab 138
adisuciu 0:2e21c4508cab 139 typedef enum {
adisuciu 0:2e21c4508cab 140 INT_LOW = 0x80,
adisuciu 0:2e21c4508cab 141 INT_AWAKE = 0x40,
adisuciu 0:2e21c4508cab 142 INT_INACT = 0x20,
adisuciu 0:2e21c4508cab 143 INT_ACT = 0x10,
adisuciu 0:2e21c4508cab 144 INT_FIFO_OVERRUN = 0x08,
adisuciu 0:2e21c4508cab 145 INT_FIFO_WATERMARK = 0x04,
adisuciu 0:2e21c4508cab 146 INT_FIFO_READY = 0x02,
adisuciu 0:2e21c4508cab 147 INT_DATA_READY = 0x01
adisuciu 0:2e21c4508cab 148 } ADXL362_INTMAP_reg_bits_t;
adisuciu 0:2e21c4508cab 149
adisuciu 0:2e21c4508cab 150 typedef enum {
adisuciu 0:2e21c4508cab 151 RANGE1 = 0x80,
adisuciu 0:2e21c4508cab 152 RANGE0 = 0x40,
adisuciu 0:2e21c4508cab 153 RANGE2G = 0x00,
adisuciu 0:2e21c4508cab 154 RANGE4G = 0x40,
adisuciu 0:2e21c4508cab 155 RANGE8G = 0x80,
adisuciu 0:2e21c4508cab 156 HALF_BW = 0x10,
adisuciu 0:2e21c4508cab 157 EXT_SAMPLE = 0x08,
adisuciu 0:2e21c4508cab 158 ODR2 = 0x04,
adisuciu 0:2e21c4508cab 159 ODR1 = 0x02,
adisuciu 0:2e21c4508cab 160 ODR0 = 0x01,
adisuciu 0:2e21c4508cab 161 ODR12HZ = 0x00,
adisuciu 0:2e21c4508cab 162 ODR25HZ = 0x01,
adisuciu 0:2e21c4508cab 163 ODR50Hz = 0x02,
adisuciu 0:2e21c4508cab 164 ODR100HZ = 0x03,
adisuciu 0:2e21c4508cab 165 ODR200Hz = 0x04,
adisuciu 0:2e21c4508cab 166 ODR400HZ = 0x07
adisuciu 0:2e21c4508cab 167 } ADXL362_FILTER_CTL_reg_bits_t;
adisuciu 0:2e21c4508cab 168
adisuciu 0:2e21c4508cab 169 typedef enum {
adisuciu 0:2e21c4508cab 170 EXT_CLK = 0x40,
adisuciu 0:2e21c4508cab 171 LOW_NOISE1 = 0x20,
adisuciu 0:2e21c4508cab 172 LOW_NOISE0 = 0x10,
adisuciu 0:2e21c4508cab 173 NORMAL_OPERATION = 0x00,
adisuciu 0:2e21c4508cab 174 LOW_NOISE = 0x10,
adisuciu 0:2e21c4508cab 175 ULTRALOW_NOISE = 0x20,
adisuciu 0:2e21c4508cab 176 WAKEUP = 0x08,
adisuciu 0:2e21c4508cab 177 AUTOSLEEP = 0x04,
adisuciu 0:2e21c4508cab 178 MEASURE1 = 0x02,
adisuciu 0:2e21c4508cab 179 MEASURE0 = 0x01,
adisuciu 0:2e21c4508cab 180 } ADXL362_POWER_CTL_reg_bits_t;
adisuciu 0:2e21c4508cab 181
adisuciu 0:2e21c4508cab 182 /** SPI configuration & constructor */
adisuciu 0:2e21c4508cab 183 ADXL362(PinName CS = SPI_CS, PinName MOSI = SPI_MOSI, PinName MISO =
adisuciu 0:2e21c4508cab 184 SPI_MISO, PinName SCK = SPI_SCK);
adisuciu 0:2e21c4508cab 185 void frequency(int hz);
adisuciu 0:2e21c4508cab 186
adisuciu 0:2e21c4508cab 187 /** Low level SPI bus comm methods */
adisuciu 0:2e21c4508cab 188 void reset(void);
adisuciu 0:2e21c4508cab 189 void write_reg(ADXL362_register_t reg, uint8_t data);
adisuciu 0:2e21c4508cab 190 uint8_t read_reg(ADXL362_register_t reg);
adisuciu 0:2e21c4508cab 191 uint16_t read_reg_u16(ADXL362_register_t reg);
adisuciu 0:2e21c4508cab 192 void write_reg_u16(ADXL362_register_t reg, uint16_t data);
adisuciu 0:2e21c4508cab 193
adisuciu 0:2e21c4508cab 194 /** ADXL general register R/W methods */
adisuciu 0:2e21c4508cab 195 void set_power_ctl_reg(uint8_t data);
adisuciu 0:2e21c4508cab 196 void set_filter_ctl_reg(uint8_t data);
adisuciu 0:2e21c4508cab 197 uint8_t read_status();
adisuciu 0:2e21c4508cab 198 void set_mode(ADXL362_modes_t mode);
adisuciu 0:2e21c4508cab 199
adisuciu 0:2e21c4508cab 200 /** ADXL X/Y/Z/T scanning methods*/
adisuciu 0:2e21c4508cab 201 uint64_t scan();
adisuciu 0:2e21c4508cab 202 uint8_t scanx_u8();
adisuciu 0:2e21c4508cab 203 uint16_t scanx();
adisuciu 0:2e21c4508cab 204 uint8_t scany_u8();
adisuciu 0:2e21c4508cab 205 uint16_t scany();
adisuciu 0:2e21c4508cab 206 uint8_t scanz_u8();
adisuciu 0:2e21c4508cab 207 uint16_t scanz();
adisuciu 0:2e21c4508cab 208 uint16_t scant();
adisuciu 0:2e21c4508cab 209
adisuciu 0:2e21c4508cab 210 /** ADXL362 activity methods */
adisuciu 0:2e21c4508cab 211 void set_activity_threshold(uint16_t threshold);
adisuciu 0:2e21c4508cab 212 void set_activity_time(uint8_t time);
adisuciu 0:2e21c4508cab 213 void set_inactivity_threshold(uint16_t threshold);
adisuciu 0:2e21c4508cab 214 void set_inactivity_time(uint16_t time);
adisuciu 0:2e21c4508cab 215 void set_act_inact_ctl_reg(uint8_t data);
adisuciu 0:2e21c4508cab 216
adisuciu 0:2e21c4508cab 217 /** ADXL362 interrupt methods */
adisuciu 0:2e21c4508cab 218 void set_interrupt1_pin(PinName in, uint8_t data, void (*callback_rising)(void), void (*callback_falling)(void), PinMode pull = PullNone);
adisuciu 0:2e21c4508cab 219 void set_interrupt2_pin(PinName in, uint8_t data, void (*callback_rising)(void), void (*callback_falling)(void), PinMode pull = PullNone);
adisuciu 0:2e21c4508cab 220 void enable_interrupt1();
adisuciu 0:2e21c4508cab 221 void enable_interrupt2();
adisuciu 0:2e21c4508cab 222 void disable_interrupt1();
adisuciu 0:2e21c4508cab 223 void disable_interrupt2();
adisuciu 0:2e21c4508cab 224
adisuciu 0:2e21c4508cab 225 void set_polling_interrupt1_pin(PinName in, uint8_t data, PinMode pull = PullNone);
adisuciu 0:2e21c4508cab 226 void set_polling_interrupt2_pin(PinName in, uint8_t data, PinMode pull = PullNone);
adisuciu 0:2e21c4508cab 227
adisuciu 0:2e21c4508cab 228 bool get_int1();
adisuciu 0:2e21c4508cab 229 bool get_int2();
adisuciu 0:2e21c4508cab 230
adisuciu 0:2e21c4508cab 231 /** ADXL362 FIFO methods */
adisuciu 0:2e21c4508cab 232 uint16_t fifo_read_nr_of_entries();
adisuciu 0:2e21c4508cab 233 void fifo_setup(bool store_temp, ADXL362_FIFO_modes_t mode, uint16_t nr_of_entries);
adisuciu 0:2e21c4508cab 234 uint16_t fifo_read_u16();
adisuciu 0:2e21c4508cab 235 uint64_t fifo_scan();
adisuciu 0:2e21c4508cab 236
adisuciu 0:2e21c4508cab 237 SPI adxl362; ///< SPI instance of the ADXL362
adisuciu 0:2e21c4508cab 238 DigitalOut cs; ///< DigitalOut instance for the chipselect of the ADXL362
adisuciu 0:2e21c4508cab 239
adisuciu 0:2e21c4508cab 240 private:
adisuciu 0:2e21c4508cab 241
adisuciu 0:2e21c4508cab 242 InterruptIn *_int1;
adisuciu 0:2e21c4508cab 243 InterruptIn *_int2;
adisuciu 0:2e21c4508cab 244 DigitalIn _int1_poll;
adisuciu 0:2e21c4508cab 245 DigitalIn _int2_poll;
adisuciu 0:2e21c4508cab 246 bool _int1_act_low;
adisuciu 0:2e21c4508cab 247 bool _int2_act_low;
adisuciu 0:2e21c4508cab 248 bool _temp_stored_in_fifo;
adisuciu 0:2e21c4508cab 249
adisuciu 0:2e21c4508cab 250 const static uint8_t _DUMMY_BYTE = 0xAA;
adisuciu 0:2e21c4508cab 251 const static uint8_t _WRITE_REG_CMD = 0x0A; // write register
adisuciu 0:2e21c4508cab 252 const static uint8_t _READ_REG_CMD = 0x0B; // read register
adisuciu 0:2e21c4508cab 253 const static uint8_t _READ_FIFO_CMD = 0x0D; // read FIFO
adisuciu 0:2e21c4508cab 254 const static uint8_t _SPI_MODE = 0;
adisuciu 0:2e21c4508cab 255 };
adisuciu 0:2e21c4508cab 256
adisuciu 0:2e21c4508cab 257 #endif