Kenji Arai / LIS3DH

LIS3DH / STMicroelectronics / MEMS motion sensor, 3-axis accelerometer library

Dependents:   GR-PEACH_test_wo_rtos GR-PEACH_test_on_rtos_works_well Skywire_Demo_3 Skywire_Kinetis_K64_demo ... more

LIS3DH.h@5:725df775f168, 2015-02-24 (annotated)

Committer:
kenjiArai
Date:
Tue Feb 24 12:21:54 2015 +0000
Revision:
5:725df775f168
Parent:
4:64dac49da306
Child:
6:e269772dad35
unified format, data name and others, added function call

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kenjiArai 0:5d5aac272642 1 /*
kenjiArai 0:5d5aac272642 2 * mbed library program
kenjiArai 0:5d5aac272642 3 * LIS3DH MEMS motion sensor: 3-axis "nano" accelerometer, made by STMicroelectronics
kenjiArai 0:5d5aac272642 4 * http://www.st-japan.co.jp/web/jp/catalog/sense_power/FM89/SC444/PF250725
kenjiArai 0:5d5aac272642 5 *
kenjiArai 5:725df775f168 6 * Copyright (c) 2014,'15 Kenji Arai / JH1PJL
kenjiArai 0:5d5aac272642 7 * http://www.page.sannet.ne.jp/kenjia/index.html
kenjiArai 0:5d5aac272642 8 * http://mbed.org/users/kenjiArai/
kenjiArai 0:5d5aac272642 9 * Created: July 14th, 2014
kenjiArai 5:725df775f168 10 * Revised: Feburary 24th, 2015
kenjiArai 0:5d5aac272642 11 *
kenjiArai 0:5d5aac272642 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
kenjiArai 0:5d5aac272642 13 * INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
kenjiArai 0:5d5aac272642 14 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
kenjiArai 0:5d5aac272642 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kenjiArai 0:5d5aac272642 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
kenjiArai 0:5d5aac272642 17 */
kenjiArai 0:5d5aac272642 18
kenjiArai 0:5d5aac272642 19 #ifndef LIS3DH_H
kenjiArai 0:5d5aac272642 20 #define LIS3DH_H
kenjiArai 0:5d5aac272642 21
kenjiArai 0:5d5aac272642 22 #include "mbed.h"
kenjiArai 0:5d5aac272642 23
kenjiArai 0:5d5aac272642 24 // LIS3DH Address
kenjiArai 0:5d5aac272642 25 // 7bit address = 0b001100x(0x18 or 0x19 depends on SA0/SDO)
kenjiArai 5:725df775f168 26 #define LIS3DH_G_CHIP_ADDR (0x18 << 1) // SA0(=SDO pin) = Ground
kenjiArai 5:725df775f168 27 #define LIS3DH_V_CHIP_ADDR (0x19 << 1) // SA0(=SDO pin) = Vdd
kenjiArai 0:5d5aac272642 28
kenjiArai 0:5d5aac272642 29
kenjiArai 0:5d5aac272642 30 // LIS3DH ID
kenjiArai 5:725df775f168 31 #define I_AM_LIS3DH 0x33
kenjiArai 0:5d5aac272642 32
kenjiArai 0:5d5aac272642 33 // Register's definition
kenjiArai 0:5d5aac272642 34 #define LIS3DH_STATUS_REG_AUX 0x07
kenjiArai 0:5d5aac272642 35 #define LIS3DH_OUT_ADC1_L 0x08
kenjiArai 0:5d5aac272642 36 #define LIS3DH_OUT_ADC1_H 0x09
kenjiArai 0:5d5aac272642 37 #define LIS3DH_OUT_ADC2_L 0x0a
kenjiArai 0:5d5aac272642 38 #define LIS3DH_OUT_ADC2_H 0x0b
kenjiArai 0:5d5aac272642 39 #define LIS3DH_OUT_ADC3_L 0x0c
kenjiArai 0:5d5aac272642 40 #define LIS3DH_OUT_ADC3_H 0x0d
kenjiArai 0:5d5aac272642 41 #define LIS3DH_INT_COUNTER_REG 0x0e
kenjiArai 0:5d5aac272642 42 #define LIS3DH_WHO_AM_I 0x0f
kenjiArai 0:5d5aac272642 43 #define LIS3DH_TEMP_CFG_REG 0x1f
kenjiArai 0:5d5aac272642 44 #define LIS3DH_CTRL_REG1 0x20
kenjiArai 0:5d5aac272642 45 #define LIS3DH_CTRL_REG2 0x21
kenjiArai 0:5d5aac272642 46 #define LIS3DH_CTRL_REG3 0x22
kenjiArai 0:5d5aac272642 47 #define LIS3DH_CTRL_REG4 0x23
kenjiArai 0:5d5aac272642 48 #define LIS3DH_CTRL_REG5 0x24
kenjiArai 0:5d5aac272642 49 #define LIS3DH_CTRL_REG6 0x25
kenjiArai 0:5d5aac272642 50 #define LIS3DH_REFERENCE 0x26
kenjiArai 0:5d5aac272642 51 #define LIS3DH_STATUS_REG2 0x27
kenjiArai 0:5d5aac272642 52 #define LIS3DH_OUT_X_L 0x28
kenjiArai 0:5d5aac272642 53 #define LIS3DH_OUT_X_H 0x29
kenjiArai 0:5d5aac272642 54 #define LIS3DH_OUT_Y_L 0x2a
kenjiArai 0:5d5aac272642 55 #define LIS3DH_OUT_Y_H 0x2b
kenjiArai 0:5d5aac272642 56 #define LIS3DH_OUT_Z_L 0x2c
kenjiArai 0:5d5aac272642 57 #define LIS3DH_OUT_Z_H 0x2d
kenjiArai 0:5d5aac272642 58 #define LIS3DH_FIFO_CTRL_REG 0x2e
kenjiArai 0:5d5aac272642 59 #define LIS3DH_FIFO_SRC_REG 0x2f
kenjiArai 0:5d5aac272642 60 #define LIS3DH_INT1_CFG 0x30
kenjiArai 0:5d5aac272642 61 #define LIS3DH_INT1_SOURCE 0x31
kenjiArai 0:5d5aac272642 62 #define LIS3DH_INT1_THS 0x32
kenjiArai 0:5d5aac272642 63 #define LIS3DH_INT1_DURATION 0x33
kenjiArai 0:5d5aac272642 64 #define LIS3DH_CLICK_CFG 0x38
kenjiArai 0:5d5aac272642 65 #define LIS3DH_CLICK_SRC 0x39
kenjiArai 0:5d5aac272642 66 #define LIS3DH_CLICK_THS 0x3a
kenjiArai 0:5d5aac272642 67 #define LIS3DH_TIME_LIMIT 0x3b
kenjiArai 0:5d5aac272642 68 #define LIS3DH_TIME_LATENCY 0x3c
kenjiArai 0:5d5aac272642 69 #define LIS3DH_TIME_WINDOW 0x3d
kenjiArai 0:5d5aac272642 70
kenjiArai 0:5d5aac272642 71 // Output Data Rate (ODR)
kenjiArai 0:5d5aac272642 72 #define LIS3DH_DR_PWRDWN 0
kenjiArai 0:5d5aac272642 73 #define LIS3DH_DR_NR_LP_1HZ 1
kenjiArai 0:5d5aac272642 74 #define LIS3DH_DR_NR_LP_10HZ 2
kenjiArai 0:5d5aac272642 75 #define LIS3DH_DR_NR_LP_25HZ 3
kenjiArai 0:5d5aac272642 76 #define LIS3DH_DR_NR_LP_50HZ 4
kenjiArai 0:5d5aac272642 77 #define LIS3DH_DR_NR_LP_100HZ 5
kenjiArai 0:5d5aac272642 78 #define LIS3DH_DR_NR_LP_200HZ 6
kenjiArai 0:5d5aac272642 79 #define LIS3DH_DR_NR_LP_400HZ 7
kenjiArai 0:5d5aac272642 80 #define LIS3DH_DR_LP_1R6KHZ 8
kenjiArai 0:5d5aac272642 81 #define LIS3DH_DR_NR_1R25KHZ 9
kenjiArai 0:5d5aac272642 82
kenjiArai 0:5d5aac272642 83 // Bandwidth (Low pass)
kenjiArai 0:5d5aac272642 84 #define LIS3DH_BW_LOW 0
kenjiArai 0:5d5aac272642 85 #define LIS3DH_BW_M_LOW 1
kenjiArai 0:5d5aac272642 86 #define LIS3DH_BW_M_HI 2
kenjiArai 0:5d5aac272642 87 #define LIS3DH_BW_HI 3
kenjiArai 0:5d5aac272642 88
kenjiArai 0:5d5aac272642 89 // Low power mode enable/disable
kenjiArai 0:5d5aac272642 90 #define LIS3DH_LP_EN 0
kenjiArai 0:5d5aac272642 91 #define LIS3DH_LP_DIS 1
kenjiArai 0:5d5aac272642 92
kenjiArai 0:5d5aac272642 93 // Axis control
kenjiArai 0:5d5aac272642 94 #define LIS3DH_X_EN 1
kenjiArai 0:5d5aac272642 95 #define LIS3DH_X_DIS 0
kenjiArai 0:5d5aac272642 96 #define LIS3DH_Y_EN 1
kenjiArai 0:5d5aac272642 97 #define LIS3DH_Y_DIS 0
kenjiArai 0:5d5aac272642 98 #define LIS3DH_Z_EN 1
kenjiArai 0:5d5aac272642 99 #define LIS3DH_Z_DIS 0
kenjiArai 0:5d5aac272642 100
kenjiArai 0:5d5aac272642 101 // Full Scale
kenjiArai 0:5d5aac272642 102 #define LIS3DH_FS_2G 0
kenjiArai 0:5d5aac272642 103 #define LIS3DH_FS_4G 1
kenjiArai 0:5d5aac272642 104 #define LIS3DH_FS_8G 2
kenjiArai 0:5d5aac272642 105 #define LIS3DH_FS_16G 3
kenjiArai 0:5d5aac272642 106
kenjiArai 0:5d5aac272642 107 // definition for Nomalization
kenjiArai 0:5d5aac272642 108 #define LIS3DH_SENSITIVITY_2G (0.001F)
kenjiArai 0:5d5aac272642 109 #define LIS3DH_SENSITIVITY_4G (0.002F)
kenjiArai 0:5d5aac272642 110 #define LIS3DH_SENSITIVITY_8G (0.004F)
kenjiArai 0:5d5aac272642 111 #define LIS3DH_SENSITIVITY_16G (0.012F)
kenjiArai 0:5d5aac272642 112
kenjiArai 0:5d5aac272642 113 //Gravity at Earth's surface in m/s/s
kenjiArai 0:5d5aac272642 114 #define GRAVITY (9.80665F)
kenjiArai 0:5d5aac272642 115
kenjiArai 0:5d5aac272642 116 /** Interface for STMicronics MEMS motion sensor: 3-axis "nano" accelerometer
kenjiArai 0:5d5aac272642 117 * Chip: LIS3DH
kenjiArai 0:5d5aac272642 118 *
kenjiArai 0:5d5aac272642 119 * @code
kenjiArai 0:5d5aac272642 120 * #include "mbed.h"
kenjiArai 0:5d5aac272642 121 *
kenjiArai 0:5d5aac272642 122 * // I2C Communication
kenjiArai 0:5d5aac272642 123 * LIS3DH acc(p_sda, p_scl, chip_addr, datarate, bandwidth, fullscale);
kenjiArai 0:5d5aac272642 124 * // If you connected I2C line not only this device but also other devices,
kenjiArai 0:5d5aac272642 125 * // you need to declare following method.
kenjiArai 0:5d5aac272642 126 * I2C i2c(dp5,dp27); // SDA, SCL
kenjiArai 0:5d5aac272642 127 * LIS3DH acc(i2c, chip_addr, datarate, bandwidth, fullscale);
kenjiArai 0:5d5aac272642 128 *
kenjiArai 0:5d5aac272642 129 * int main() {
kenjiArai 0:5d5aac272642 130 * float f[3];
kenjiArai 0:5d5aac272642 131 *
kenjiArai 0:5d5aac272642 132 * if (acc.read_id() == I_AM_LIS3DH){
kenjiArai 0:5d5aac272642 133 * acc.read_data(f);
kenjiArai 0:5d5aac272642 134 * }
kenjiArai 0:5d5aac272642 135 * }
kenjiArai 0:5d5aac272642 136 * @endcode
kenjiArai 0:5d5aac272642 137 */
kenjiArai 0:5d5aac272642 138
kenjiArai 0:5d5aac272642 139 class LIS3DH{
kenjiArai 0:5d5aac272642 140 public:
kenjiArai 0:5d5aac272642 141 /** Configure data pin
kenjiArai 0:5d5aac272642 142 * @param data SDA and SCL pins
kenjiArai 0:5d5aac272642 143 * @param device address LIS3DH(SA0=0 or 1), LIS3DH_G_CHIP_ADDR or LIS3DH_V_CHIP_ADDR
kenjiArai 0:5d5aac272642 144 * @param output data rate selection, power down mode, 1Hz to 5KHz
kenjiArai 0:5d5aac272642 145 * @param full scale selection, +/-2g to +/-16g
kenjiArai 0:5d5aac272642 146 */
kenjiArai 0:5d5aac272642 147 LIS3DH(PinName p_sda, PinName p_scl,
kenjiArai 0:5d5aac272642 148 uint8_t addr, uint8_t data_rate, uint8_t fullscale);
kenjiArai 5:725df775f168 149
kenjiArai 5:725df775f168 150 /** Configure data pin
kenjiArai 5:725df775f168 151 * @param data SDA and SCL pins
kenjiArai 5:725df775f168 152 * @param device address LIS3DH(SA0=0 or 1), LIS3DH_G_CHIP_ADDR or LIS3DH_V_CHIP_ADDR
kenjiArai 5:725df775f168 153 * @default output data rate selection = 50Hz
kenjiArai 5:725df775f168 154 * @default full scale selection = +/-8g
kenjiArai 5:725df775f168 155 */
kenjiArai 5:725df775f168 156 LIS3DH(PinName p_sda, PinName p_scl, uint8_t addr);
kenjiArai 5:725df775f168 157
kenjiArai 0:5d5aac272642 158 /** Configure data pin (with other devices on I2C line)
kenjiArai 0:5d5aac272642 159 * @param I2C previous definition
kenjiArai 0:5d5aac272642 160 * @param other parameters -> please see LIS3DH(PinName p_sda, PinName p_scl,...)
kenjiArai 0:5d5aac272642 161 */
kenjiArai 0:5d5aac272642 162 LIS3DH(I2C& p_i2c,
kenjiArai 0:5d5aac272642 163 uint8_t addr, uint8_t data_rate, uint8_t fullscale);
kenjiArai 5:725df775f168 164
kenjiArai 5:725df775f168 165 /** Configure data pin (with other devices on I2C line)
kenjiArai 5:725df775f168 166 * @param I2C previous definition
kenjiArai 5:725df775f168 167 * @param other parameters -> please see LIS3DH(PinName p_sda, PinName p_scl,...)
kenjiArai 5:725df775f168 168 * @default output data rate selection = 50Hz
kenjiArai 5:725df775f168 169 * @default full scale selection = +/-8g
kenjiArai 5:725df775f168 170 */
kenjiArai 5:725df775f168 171 LIS3DH(I2C& p_i2c, uint8_t addr);
kenjiArai 0:5d5aac272642 172
kenjiArai 0:5d5aac272642 173 /** Read a float type data from acc
kenjiArai 5:725df775f168 174 * @param float type of three arry's address, e.g. float dt_usr[3];
kenjiArai 0:5d5aac272642 175 * @return acc motion data unit: m/s/s(m/s2)
kenjiArai 5:725df775f168 176 * @return dt_usr[0]->x, dt_usr[1]->y, dt_usr[2]->z
kenjiArai 0:5d5aac272642 177 */
kenjiArai 5:725df775f168 178 void read_data(float *dt_usr);
kenjiArai 0:5d5aac272642 179
kenjiArai 0:5d5aac272642 180 /** Read a float type data from acc
kenjiArai 5:725df775f168 181 * @param float type of three arry's address, e.g. float dt_usr[3];
kenjiArai 0:5d5aac272642 182 * @return acc motion data unit: mg
kenjiArai 5:725df775f168 183 * @return dt_usr[0]->x, dt_usr[1]->y, dt_usr[2]->z
kenjiArai 0:5d5aac272642 184 */
kenjiArai 5:725df775f168 185 void read_mg_data(float *dt_usr);
kenjiArai 0:5d5aac272642 186
kenjiArai 0:5d5aac272642 187 /** Read a acc ID number
kenjiArai 0:5d5aac272642 188 * @param none
kenjiArai 0:5d5aac272642 189 * @return if STM MEMS acc, it should be I_AM_ LIS3DH(0x33)
kenjiArai 0:5d5aac272642 190 */
kenjiArai 0:5d5aac272642 191 uint8_t read_id();
kenjiArai 0:5d5aac272642 192
kenjiArai 0:5d5aac272642 193 /** Read Data Ready flag
kenjiArai 0:5d5aac272642 194 * @param none
kenjiArai 0:5d5aac272642 195 * @return 1 = Ready
kenjiArai 0:5d5aac272642 196 */
kenjiArai 0:5d5aac272642 197 uint8_t data_ready();
kenjiArai 0:5d5aac272642 198
kenjiArai 1:d4d569952436 199 /** Set I2C clock frequency
kenjiArai 1:d4d569952436 200 * @param freq.
kenjiArai 1:d4d569952436 201 * @return none
kenjiArai 1:d4d569952436 202 */
kenjiArai 1:d4d569952436 203 void frequency(int hz);
kenjiArai 1:d4d569952436 204
kenjiArai 0:5d5aac272642 205 /** Read register (general purpose)
kenjiArai 0:5d5aac272642 206 * @param register's address
kenjiArai 0:5d5aac272642 207 * @return register data
kenjiArai 0:5d5aac272642 208 */
kenjiArai 0:5d5aac272642 209 uint8_t read_reg(uint8_t addr);
kenjiArai 0:5d5aac272642 210
kenjiArai 0:5d5aac272642 211 /** Write register (general purpose)
kenjiArai 0:5d5aac272642 212 * @param register's address
kenjiArai 0:5d5aac272642 213 * @param data
kenjiArai 0:5d5aac272642 214 * @return none
kenjiArai 0:5d5aac272642 215 */
kenjiArai 0:5d5aac272642 216 void write_reg(uint8_t addr, uint8_t data);
kenjiArai 0:5d5aac272642 217
kenjiArai 0:5d5aac272642 218 protected:
kenjiArai 0:5d5aac272642 219 void initialize(uint8_t, uint8_t, uint8_t);
kenjiArai 0:5d5aac272642 220 void read_reg_data(char *data);
kenjiArai 0:5d5aac272642 221
kenjiArai 5:725df775f168 222 I2C _i2c;
kenjiArai 0:5d5aac272642 223
kenjiArai 0:5d5aac272642 224 private:
kenjiArai 5:725df775f168 225 float fs_factor; // full scale factor
kenjiArai 5:725df775f168 226 char dt[2]; // working buffer
kenjiArai 0:5d5aac272642 227 uint8_t acc_addr; // acc sensor address
kenjiArai 0:5d5aac272642 228 uint8_t acc_id; // acc ID
kenjiArai 0:5d5aac272642 229 uint8_t acc_ready; // acc is on I2C line = 1, not = 0
kenjiArai 0:5d5aac272642 230 };
kenjiArai 0:5d5aac272642 231
kenjiArai 0:5d5aac272642 232 #endif // LIS3DH_H