ST / Mbed 2 deprecated WakeUp_IKS01A2

Example of wake up detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of WakeUp_IKS01A2 by ST Expansion SW Team

Wake up Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to detect the wake up event using the sensor expansion board and send a notification using UART to a connected PC or Desktop and display it on terminal applications like TeraTerm.
After connection has been established:
- the user can try to shake the board and then view the notification using an hyper terminal. When the wake up event is detected, the LED is switched on for a while.
- the user button can be used to enable/disable the wake up detection feature.

X_NUCLEO_IKS01A2/Components/LSM6DSLSensor/LSM6DSLSensor.h@4:fbffbdc722a5, 2016-11-21 (annotated)

Committer:
cparata
Date:
Mon Nov 21 14:58:19 2016 +0000
Revision:
4:fbffbdc722a5
Parent:
2:7ad7571557a5
Child:
6:06f4a71c4743
Add muti-event support

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 2:7ad7571557a5 1 /**
cparata 2:7ad7571557a5 2 ******************************************************************************
cparata 2:7ad7571557a5 3 * @file LSM6DSLSensor.h
cparata 2:7ad7571557a5 4 * @author AST
cparata 2:7ad7571557a5 5 * @version V1.0.0
cparata 2:7ad7571557a5 6 * @date 5 August 2016
cparata 2:7ad7571557a5 7 * @brief Abstract Class of an LSM6DSL Inertial Measurement Unit (IMU) 6 axes
cparata 2:7ad7571557a5 8 * sensor.
cparata 2:7ad7571557a5 9 ******************************************************************************
cparata 2:7ad7571557a5 10 * @attention
cparata 2:7ad7571557a5 11 *
cparata 2:7ad7571557a5 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 2:7ad7571557a5 13 *
cparata 2:7ad7571557a5 14 * Redistribution and use in source and binary forms, with or without modification,
cparata 2:7ad7571557a5 15 * are permitted provided that the following conditions are met:
cparata 2:7ad7571557a5 16 * 1. Redistributions of source code must retain the above copyright notice,
cparata 2:7ad7571557a5 17 * this list of conditions and the following disclaimer.
cparata 2:7ad7571557a5 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 2:7ad7571557a5 19 * this list of conditions and the following disclaimer in the documentation
cparata 2:7ad7571557a5 20 * and/or other materials provided with the distribution.
cparata 2:7ad7571557a5 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 2:7ad7571557a5 22 * may be used to endorse or promote products derived from this software
cparata 2:7ad7571557a5 23 * without specific prior written permission.
cparata 2:7ad7571557a5 24 *
cparata 2:7ad7571557a5 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 2:7ad7571557a5 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 2:7ad7571557a5 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 2:7ad7571557a5 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 2:7ad7571557a5 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 2:7ad7571557a5 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 2:7ad7571557a5 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 2:7ad7571557a5 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 2:7ad7571557a5 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 2:7ad7571557a5 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 2:7ad7571557a5 35 *
cparata 2:7ad7571557a5 36 ******************************************************************************
cparata 2:7ad7571557a5 37 */
cparata 2:7ad7571557a5 38
cparata 2:7ad7571557a5 39
cparata 2:7ad7571557a5 40 /* Prevent recursive inclusion -----------------------------------------------*/
cparata 2:7ad7571557a5 41
cparata 2:7ad7571557a5 42 #ifndef __LSM6DSLSensor_H__
cparata 2:7ad7571557a5 43 #define __LSM6DSLSensor_H__
cparata 2:7ad7571557a5 44
cparata 2:7ad7571557a5 45
cparata 2:7ad7571557a5 46 /* Includes ------------------------------------------------------------------*/
cparata 2:7ad7571557a5 47
cparata 2:7ad7571557a5 48 #include "DevI2C.h"
cparata 2:7ad7571557a5 49 #include "LSM6DSL_ACC_GYRO_driver.h"
cparata 2:7ad7571557a5 50 #include "MotionSensor.h"
cparata 2:7ad7571557a5 51 #include "GyroSensor.h"
cparata 2:7ad7571557a5 52
cparata 2:7ad7571557a5 53 /* Defines -------------------------------------------------------------------*/
cparata 2:7ad7571557a5 54
cparata 2:7ad7571557a5 55 #define LSM6DSL_ACC_SENSITIVITY_FOR_FS_2G 0.061 /**< Sensitivity value for 2 g full scale [mg/LSB] */
cparata 2:7ad7571557a5 56 #define LSM6DSL_ACC_SENSITIVITY_FOR_FS_4G 0.122 /**< Sensitivity value for 4 g full scale [mg/LSB] */
cparata 2:7ad7571557a5 57 #define LSM6DSL_ACC_SENSITIVITY_FOR_FS_8G 0.244 /**< Sensitivity value for 8 g full scale [mg/LSB] */
cparata 2:7ad7571557a5 58 #define LSM6DSL_ACC_SENSITIVITY_FOR_FS_16G 0.488 /**< Sensitivity value for 16 g full scale [mg/LSB] */
cparata 2:7ad7571557a5 59
cparata 2:7ad7571557a5 60 #define LSM6DSL_GYRO_SENSITIVITY_FOR_FS_125DPS 04.375 /**< Sensitivity value for 125 dps full scale [mdps/LSB] */
cparata 2:7ad7571557a5 61 #define LSM6DSL_GYRO_SENSITIVITY_FOR_FS_245DPS 08.750 /**< Sensitivity value for 245 dps full scale [mdps/LSB] */
cparata 2:7ad7571557a5 62 #define LSM6DSL_GYRO_SENSITIVITY_FOR_FS_500DPS 17.500 /**< Sensitivity value for 500 dps full scale [mdps/LSB] */
cparata 2:7ad7571557a5 63 #define LSM6DSL_GYRO_SENSITIVITY_FOR_FS_1000DPS 35.000 /**< Sensitivity value for 1000 dps full scale [mdps/LSB] */
cparata 2:7ad7571557a5 64 #define LSM6DSL_GYRO_SENSITIVITY_FOR_FS_2000DPS 70.000 /**< Sensitivity value for 2000 dps full scale [mdps/LSB] */
cparata 2:7ad7571557a5 65
cparata 2:7ad7571557a5 66 #define LSM6DSL_PEDOMETER_THRESHOLD_LOW 0x00 /**< Lowest value of pedometer threshold */
cparata 2:7ad7571557a5 67 #define LSM6DSL_PEDOMETER_THRESHOLD_MID_LOW 0x07
cparata 2:7ad7571557a5 68 #define LSM6DSL_PEDOMETER_THRESHOLD_MID 0x0F
cparata 2:7ad7571557a5 69 #define LSM6DSL_PEDOMETER_THRESHOLD_MID_HIGH 0x17
cparata 2:7ad7571557a5 70 #define LSM6DSL_PEDOMETER_THRESHOLD_HIGH 0x1F /**< Highest value of pedometer threshold */
cparata 2:7ad7571557a5 71
cparata 2:7ad7571557a5 72 #define LSM6DSL_WAKE_UP_THRESHOLD_LOW 0x01 /**< Lowest value of wake up threshold */
cparata 2:7ad7571557a5 73 #define LSM6DSL_WAKE_UP_THRESHOLD_MID_LOW 0x0F
cparata 2:7ad7571557a5 74 #define LSM6DSL_WAKE_UP_THRESHOLD_MID 0x1F
cparata 2:7ad7571557a5 75 #define LSM6DSL_WAKE_UP_THRESHOLD_MID_HIGH 0x2F
cparata 2:7ad7571557a5 76 #define LSM6DSL_WAKE_UP_THRESHOLD_HIGH 0x3F /**< Highest value of wake up threshold */
cparata 2:7ad7571557a5 77
cparata 2:7ad7571557a5 78 #define LSM6DSL_TAP_THRESHOLD_LOW 0x01 /**< Lowest value of wake up threshold */
cparata 2:7ad7571557a5 79 #define LSM6DSL_TAP_THRESHOLD_MID_LOW 0x08
cparata 2:7ad7571557a5 80 #define LSM6DSL_TAP_THRESHOLD_MID 0x10
cparata 2:7ad7571557a5 81 #define LSM6DSL_TAP_THRESHOLD_MID_HIGH 0x18
cparata 2:7ad7571557a5 82 #define LSM6DSL_TAP_THRESHOLD_HIGH 0x1F /**< Highest value of wake up threshold */
cparata 2:7ad7571557a5 83
cparata 2:7ad7571557a5 84 #define LSM6DSL_TAP_SHOCK_TIME_LOW 0x00 /**< Lowest value of wake up threshold */
cparata 2:7ad7571557a5 85 #define LSM6DSL_TAP_SHOCK_TIME_MID_LOW 0x01
cparata 2:7ad7571557a5 86 #define LSM6DSL_TAP_SHOCK_TIME_MID_HIGH 0x02
cparata 2:7ad7571557a5 87 #define LSM6DSL_TAP_SHOCK_TIME_HIGH 0x03 /**< Highest value of wake up threshold */
cparata 2:7ad7571557a5 88
cparata 2:7ad7571557a5 89 #define LSM6DSL_TAP_QUIET_TIME_LOW 0x00 /**< Lowest value of wake up threshold */
cparata 2:7ad7571557a5 90 #define LSM6DSL_TAP_QUIET_TIME_MID_LOW 0x01
cparata 2:7ad7571557a5 91 #define LSM6DSL_TAP_QUIET_TIME_MID_HIGH 0x02
cparata 2:7ad7571557a5 92 #define LSM6DSL_TAP_QUIET_TIME_HIGH 0x03 /**< Highest value of wake up threshold */
cparata 2:7ad7571557a5 93
cparata 2:7ad7571557a5 94 #define LSM6DSL_TAP_DURATION_TIME_LOW 0x00 /**< Lowest value of wake up threshold */
cparata 2:7ad7571557a5 95 #define LSM6DSL_TAP_DURATION_TIME_MID_LOW 0x04
cparata 2:7ad7571557a5 96 #define LSM6DSL_TAP_DURATION_TIME_MID 0x08
cparata 2:7ad7571557a5 97 #define LSM6DSL_TAP_DURATION_TIME_MID_HIGH 0x0C
cparata 2:7ad7571557a5 98 #define LSM6DSL_TAP_DURATION_TIME_HIGH 0x0F /**< Highest value of wake up threshold */
cparata 2:7ad7571557a5 99
cparata 4:fbffbdc722a5 100 /* Typedefs ------------------------------------------------------------------*/
cparata 4:fbffbdc722a5 101
cparata 4:fbffbdc722a5 102 typedef struct
cparata 4:fbffbdc722a5 103 {
cparata 4:fbffbdc722a5 104 unsigned int FreeFallStatus : 1;
cparata 4:fbffbdc722a5 105 unsigned int TapStatus : 1;
cparata 4:fbffbdc722a5 106 unsigned int DoubleTapStatus : 1;
cparata 4:fbffbdc722a5 107 unsigned int WakeUpStatus : 1;
cparata 4:fbffbdc722a5 108 unsigned int StepStatus : 1;
cparata 4:fbffbdc722a5 109 unsigned int TiltStatus : 1;
cparata 4:fbffbdc722a5 110 unsigned int D6DOrientationStatus : 1;
cparata 4:fbffbdc722a5 111 } LSM6DSL_Event_Status_t;
cparata 4:fbffbdc722a5 112
cparata 2:7ad7571557a5 113 /* Class Declaration ---------------------------------------------------------*/
cparata 2:7ad7571557a5 114
cparata 2:7ad7571557a5 115 /**
cparata 2:7ad7571557a5 116 * Abstract class of an LSM6DSL Inertial Measurement Unit (IMU) 6 axes
cparata 2:7ad7571557a5 117 * sensor.
cparata 2:7ad7571557a5 118 */
cparata 2:7ad7571557a5 119 class LSM6DSLSensor : public MotionSensor, public GyroSensor
cparata 2:7ad7571557a5 120 {
cparata 2:7ad7571557a5 121 public:
cparata 2:7ad7571557a5 122 LSM6DSLSensor(DevI2C &i2c);
cparata 2:7ad7571557a5 123 LSM6DSLSensor(DevI2C &i2c, uint8_t address);
cparata 2:7ad7571557a5 124 virtual int Init(void *init);
cparata 2:7ad7571557a5 125 virtual int ReadID(uint8_t *id);
cparata 2:7ad7571557a5 126 virtual int Get_X_Axes(int32_t *pData);
cparata 2:7ad7571557a5 127 virtual int Get_G_Axes(int32_t *pData);
cparata 2:7ad7571557a5 128 virtual int Get_X_Sensitivity(float *pfData);
cparata 2:7ad7571557a5 129 virtual int Get_G_Sensitivity(float *pfData);
cparata 2:7ad7571557a5 130 virtual int Get_X_AxesRaw(int16_t *pData);
cparata 2:7ad7571557a5 131 virtual int Get_G_AxesRaw(int16_t *pData);
cparata 2:7ad7571557a5 132 virtual int Get_X_ODR(float *odr);
cparata 2:7ad7571557a5 133 virtual int Get_G_ODR(float *odr);
cparata 2:7ad7571557a5 134 virtual int Set_X_ODR(float odr);
cparata 2:7ad7571557a5 135 virtual int Set_G_ODR(float odr);
cparata 2:7ad7571557a5 136 virtual int Get_X_FS(float *fullScale);
cparata 2:7ad7571557a5 137 virtual int Get_G_FS(float *fullScale);
cparata 2:7ad7571557a5 138 virtual int Set_X_FS(float fullScale);
cparata 2:7ad7571557a5 139 virtual int Set_G_FS(float fullScale);
cparata 2:7ad7571557a5 140 int Enable_X(void);
cparata 2:7ad7571557a5 141 int Enable_G(void);
cparata 2:7ad7571557a5 142 int Disable_X(void);
cparata 2:7ad7571557a5 143 int Disable_G(void);
cparata 2:7ad7571557a5 144 int Enable_Free_Fall_Detection(void);
cparata 2:7ad7571557a5 145 int Disable_Free_Fall_Detection(void);
cparata 2:7ad7571557a5 146 int Set_Free_Fall_Threshold(uint8_t thr);
cparata 2:7ad7571557a5 147 int Enable_Pedometer(void);
cparata 2:7ad7571557a5 148 int Disable_Pedometer(void);
cparata 2:7ad7571557a5 149 int Get_Step_Counter(uint16_t *step_count);
cparata 2:7ad7571557a5 150 int Reset_Step_Counter(void);
cparata 2:7ad7571557a5 151 int Set_Pedometer_Threshold(uint8_t thr);
cparata 2:7ad7571557a5 152 int Enable_Tilt_Detection(void);
cparata 2:7ad7571557a5 153 int Disable_Tilt_Detection(void);
cparata 2:7ad7571557a5 154 int Enable_Wake_Up_Detection(void);
cparata 2:7ad7571557a5 155 int Disable_Wake_Up_Detection(void);
cparata 2:7ad7571557a5 156 int Set_Wake_Up_Threshold(uint8_t thr);
cparata 2:7ad7571557a5 157 int Enable_Single_Tap_Detection(void);
cparata 2:7ad7571557a5 158 int Disable_Single_Tap_Detection(void);
cparata 2:7ad7571557a5 159 int Enable_Double_Tap_Detection(void);
cparata 2:7ad7571557a5 160 int Disable_Double_Tap_Detection(void);
cparata 2:7ad7571557a5 161 int Set_Tap_Threshold(uint8_t thr);
cparata 2:7ad7571557a5 162 int Set_Tap_Shock_Time(uint8_t time);
cparata 2:7ad7571557a5 163 int Set_Tap_Quiet_Time(uint8_t time);
cparata 2:7ad7571557a5 164 int Set_Tap_Duration_Time(uint8_t time);
cparata 2:7ad7571557a5 165 int Enable_6D_Orientation(void);
cparata 2:7ad7571557a5 166 int Disable_6D_Orientation(void);
cparata 2:7ad7571557a5 167 int Get_6D_Orientation_XL(uint8_t *xl);
cparata 2:7ad7571557a5 168 int Get_6D_Orientation_XH(uint8_t *xh);
cparata 2:7ad7571557a5 169 int Get_6D_Orientation_YL(uint8_t *yl);
cparata 2:7ad7571557a5 170 int Get_6D_Orientation_YH(uint8_t *yh);
cparata 2:7ad7571557a5 171 int Get_6D_Orientation_ZL(uint8_t *zl);
cparata 2:7ad7571557a5 172 int Get_6D_Orientation_ZH(uint8_t *zh);
cparata 4:fbffbdc722a5 173 int Get_Event_Status(LSM6DSL_Event_Status_t *status);
cparata 2:7ad7571557a5 174 int ReadReg(uint8_t reg, uint8_t *data);
cparata 2:7ad7571557a5 175 int WriteReg(uint8_t reg, uint8_t data);
cparata 2:7ad7571557a5 176
cparata 2:7ad7571557a5 177 /**
cparata 2:7ad7571557a5 178 * @brief Utility function to read data.
cparata 2:7ad7571557a5 179 * @param pBuffer: pointer to data to be read.
cparata 2:7ad7571557a5 180 * @param RegisterAddr: specifies internal address register to be read.
cparata 2:7ad7571557a5 181 * @param NumByteToRead: number of bytes to be read.
cparata 2:7ad7571557a5 182 * @retval 0 if ok, an error code otherwise.
cparata 2:7ad7571557a5 183 */
cparata 2:7ad7571557a5 184 uint8_t IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
cparata 2:7ad7571557a5 185 {
cparata 2:7ad7571557a5 186 return (uint8_t) dev_i2c.i2c_read(pBuffer, address, RegisterAddr, NumByteToRead);
cparata 2:7ad7571557a5 187 }
cparata 2:7ad7571557a5 188
cparata 2:7ad7571557a5 189 /**
cparata 2:7ad7571557a5 190 * @brief Utility function to write data.
cparata 2:7ad7571557a5 191 * @param pBuffer: pointer to data to be written.
cparata 2:7ad7571557a5 192 * @param RegisterAddr: specifies internal address register to be written.
cparata 2:7ad7571557a5 193 * @param NumByteToWrite: number of bytes to write.
cparata 2:7ad7571557a5 194 * @retval 0 if ok, an error code otherwise.
cparata 2:7ad7571557a5 195 */
cparata 2:7ad7571557a5 196 uint8_t IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
cparata 2:7ad7571557a5 197 {
cparata 2:7ad7571557a5 198 return (uint8_t) dev_i2c.i2c_write(pBuffer, address, RegisterAddr, NumByteToWrite);
cparata 2:7ad7571557a5 199 }
cparata 2:7ad7571557a5 200
cparata 2:7ad7571557a5 201 private:
cparata 2:7ad7571557a5 202 int Set_X_ODR_When_Enabled(float odr);
cparata 2:7ad7571557a5 203 int Set_G_ODR_When_Enabled(float odr);
cparata 2:7ad7571557a5 204 int Set_X_ODR_When_Disabled(float odr);
cparata 2:7ad7571557a5 205 int Set_G_ODR_When_Disabled(float odr);
cparata 2:7ad7571557a5 206
cparata 2:7ad7571557a5 207 /* Helper classes. */
cparata 2:7ad7571557a5 208 DevI2C &dev_i2c;
cparata 2:7ad7571557a5 209
cparata 2:7ad7571557a5 210 /* Configuration */
cparata 2:7ad7571557a5 211 uint8_t address;
cparata 2:7ad7571557a5 212
cparata 2:7ad7571557a5 213 uint8_t X_isEnabled;
cparata 2:7ad7571557a5 214 float X_Last_ODR;
cparata 2:7ad7571557a5 215 uint8_t G_isEnabled;
cparata 2:7ad7571557a5 216 float G_Last_ODR;
cparata 2:7ad7571557a5 217 };
cparata 2:7ad7571557a5 218
cparata 2:7ad7571557a5 219 #ifdef __cplusplus
cparata 2:7ad7571557a5 220 extern "C" {
cparata 2:7ad7571557a5 221 #endif
cparata 2:7ad7571557a5 222 uint8_t LSM6DSL_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
cparata 2:7ad7571557a5 223 uint8_t LSM6DSL_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
cparata 2:7ad7571557a5 224 #ifdef __cplusplus
cparata 2:7ad7571557a5 225 }
cparata 2:7ad7571557a5 226 #endif
cparata 2:7ad7571557a5 227
cparata 2:7ad7571557a5 228 #endif