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/LSM303AGRSensor/LSM303AGR_ACC_Sensor.h@0:e7e920b85676, 2016-08-12 (annotated)

Committer:
cparata
Date:
Fri Aug 12 13:43:40 2016 +0000
Revision:
0:e7e920b85676
First release of Wake-Up Detection for LSM6DSL in IKS01A2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 0:e7e920b85676 1 /**
cparata 0:e7e920b85676 2 ******************************************************************************
cparata 0:e7e920b85676 3 * @file LSM303AGR_ACC_Sensor.h
cparata 0:e7e920b85676 4 * @author AST
cparata 0:e7e920b85676 5 * @version V1.0.0
cparata 0:e7e920b85676 6 * @date 5 August 2016
cparata 0:e7e920b85676 7 * @brief Abstract Class of an LSM303AGR accelerometer sensor.
cparata 0:e7e920b85676 8 ******************************************************************************
cparata 0:e7e920b85676 9 * @attention
cparata 0:e7e920b85676 10 *
cparata 0:e7e920b85676 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 0:e7e920b85676 12 *
cparata 0:e7e920b85676 13 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:e7e920b85676 14 * are permitted provided that the following conditions are met:
cparata 0:e7e920b85676 15 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:e7e920b85676 16 * this list of conditions and the following disclaimer.
cparata 0:e7e920b85676 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:e7e920b85676 18 * this list of conditions and the following disclaimer in the documentation
cparata 0:e7e920b85676 19 * and/or other materials provided with the distribution.
cparata 0:e7e920b85676 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:e7e920b85676 21 * may be used to endorse or promote products derived from this software
cparata 0:e7e920b85676 22 * without specific prior written permission.
cparata 0:e7e920b85676 23 *
cparata 0:e7e920b85676 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:e7e920b85676 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:e7e920b85676 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:e7e920b85676 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:e7e920b85676 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:e7e920b85676 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:e7e920b85676 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:e7e920b85676 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:e7e920b85676 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:e7e920b85676 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:e7e920b85676 34 *
cparata 0:e7e920b85676 35 ******************************************************************************
cparata 0:e7e920b85676 36 */
cparata 0:e7e920b85676 37
cparata 0:e7e920b85676 38
cparata 0:e7e920b85676 39 /* Prevent recursive inclusion -----------------------------------------------*/
cparata 0:e7e920b85676 40
cparata 0:e7e920b85676 41 #ifndef __LSM303AGR_ACC_Sensor_H__
cparata 0:e7e920b85676 42 #define __LSM303AGR_ACC_Sensor_H__
cparata 0:e7e920b85676 43
cparata 0:e7e920b85676 44
cparata 0:e7e920b85676 45 /* Includes ------------------------------------------------------------------*/
cparata 0:e7e920b85676 46
cparata 0:e7e920b85676 47 #include "DevI2C.h"
cparata 0:e7e920b85676 48 #include "LSM303AGR_ACC_driver.h"
cparata 0:e7e920b85676 49
cparata 0:e7e920b85676 50 /* Defines -------------------------------------------------------------------*/
cparata 0:e7e920b85676 51 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_NORMAL_MODE 3.900f /**< Sensitivity value for 2 g full scale and normal mode [mg/LSB] */
cparata 0:e7e920b85676 52 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_HIGH_RESOLUTION_MODE 0.980f /**< Sensitivity value for 2 g full scale and high resolution mode [mg/LSB] */
cparata 0:e7e920b85676 53 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_2G_LOW_POWER_MODE 15.630f /**< Sensitivity value for 2 g full scale and low power mode [mg/LSB] */
cparata 0:e7e920b85676 54 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_NORMAL_MODE 7.820f /**< Sensitivity value for 4 g full scale and normal mode [mg/LSB] */
cparata 0:e7e920b85676 55 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_HIGH_RESOLUTION_MODE 1.950f /**< Sensitivity value for 4 g full scale and high resolution mode [mg/LSB] */
cparata 0:e7e920b85676 56 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_4G_LOW_POWER_MODE 31.260f /**< Sensitivity value for 4 g full scale and low power mode [mg/LSB] */
cparata 0:e7e920b85676 57 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_NORMAL_MODE 15.630f /**< Sensitivity value for 8 g full scale and normal mode [mg/LSB] */
cparata 0:e7e920b85676 58 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_HIGH_RESOLUTION_MODE 3.900f /**< Sensitivity value for 8 g full scale and high resolution mode [mg/LSB] */
cparata 0:e7e920b85676 59 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_8G_LOW_POWER_MODE 62.520f /**< Sensitivity value for 8 g full scale and low power mode [mg/LSB] */
cparata 0:e7e920b85676 60 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_NORMAL_MODE 46.900f /**< Sensitivity value for 16 g full scale and normal mode [mg/LSB] */
cparata 0:e7e920b85676 61 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_HIGH_RESOLUTION_MODE 11.720f /**< Sensitivity value for 16 g full scale and high resolution mode [mg/LSB] */
cparata 0:e7e920b85676 62 #define LSM303AGR_ACC_SENSITIVITY_FOR_FS_16G_LOW_POWER_MODE 187.580f /**< Sensitivity value for 16 g full scale and low power mode [mg/LSB] */
cparata 0:e7e920b85676 63
cparata 0:e7e920b85676 64
cparata 0:e7e920b85676 65 /* Typedefs ------------------------------------------------------------------*/
cparata 0:e7e920b85676 66 typedef enum
cparata 0:e7e920b85676 67 {
cparata 0:e7e920b85676 68 LSM303AGR_ACC_STATUS_OK = 0,
cparata 0:e7e920b85676 69 LSM303AGR_ACC_STATUS_ERROR,
cparata 0:e7e920b85676 70 LSM303AGR_ACC_STATUS_TIMEOUT,
cparata 0:e7e920b85676 71 LSM303AGR_ACC_STATUS_NOT_IMPLEMENTED
cparata 0:e7e920b85676 72 } LSM303AGR_ACC_StatusTypeDef;
cparata 0:e7e920b85676 73
cparata 0:e7e920b85676 74
cparata 0:e7e920b85676 75 /* Class Declaration ---------------------------------------------------------*/
cparata 0:e7e920b85676 76
cparata 0:e7e920b85676 77 /**
cparata 0:e7e920b85676 78 * Abstract class of an LSM303AGR Inertial Measurement Unit (IMU) 6 axes
cparata 0:e7e920b85676 79 * sensor.
cparata 0:e7e920b85676 80 */
cparata 0:e7e920b85676 81 class LSM303AGR_ACC_Sensor
cparata 0:e7e920b85676 82 {
cparata 0:e7e920b85676 83 public:
cparata 0:e7e920b85676 84 LSM303AGR_ACC_Sensor (DevI2C &i2c);
cparata 0:e7e920b85676 85 LSM303AGR_ACC_Sensor (DevI2C &i2c, uint8_t address);
cparata 0:e7e920b85676 86 LSM303AGR_ACC_StatusTypeDef Enable (void);
cparata 0:e7e920b85676 87 LSM303AGR_ACC_StatusTypeDef Disable (void);
cparata 0:e7e920b85676 88 LSM303AGR_ACC_StatusTypeDef ReadID (uint8_t *p_id);
cparata 0:e7e920b85676 89 LSM303AGR_ACC_StatusTypeDef GetAxes (int32_t *pData);
cparata 0:e7e920b85676 90 LSM303AGR_ACC_StatusTypeDef GetSensitivity (float *pfData);
cparata 0:e7e920b85676 91 LSM303AGR_ACC_StatusTypeDef GetAxesRaw (int16_t *pData);
cparata 0:e7e920b85676 92 LSM303AGR_ACC_StatusTypeDef GetODR (float *odr);
cparata 0:e7e920b85676 93 LSM303AGR_ACC_StatusTypeDef SetODR (float odr);
cparata 0:e7e920b85676 94 LSM303AGR_ACC_StatusTypeDef GetFS (float *fullScale);
cparata 0:e7e920b85676 95 LSM303AGR_ACC_StatusTypeDef SetFS (float fullScale);
cparata 0:e7e920b85676 96 LSM303AGR_ACC_StatusTypeDef ReadReg (uint8_t reg, uint8_t *data);
cparata 0:e7e920b85676 97 LSM303AGR_ACC_StatusTypeDef WriteReg (uint8_t reg, uint8_t data);
cparata 0:e7e920b85676 98
cparata 0:e7e920b85676 99 /**
cparata 0:e7e920b85676 100 * @brief Utility function to read data.
cparata 0:e7e920b85676 101 * @param pBuffer: pointer to data to be read.
cparata 0:e7e920b85676 102 * @param RegisterAddr: specifies internal address register to be read.
cparata 0:e7e920b85676 103 * @param NumByteToRead: number of bytes to be read.
cparata 0:e7e920b85676 104 * @retval 0 if ok, an error code otherwise.
cparata 0:e7e920b85676 105 */
cparata 0:e7e920b85676 106 uint8_t IO_Read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
cparata 0:e7e920b85676 107 {
cparata 0:e7e920b85676 108 return (uint8_t) dev_i2c.i2c_read(pBuffer, address, RegisterAddr, NumByteToRead);
cparata 0:e7e920b85676 109 }
cparata 0:e7e920b85676 110
cparata 0:e7e920b85676 111 /**
cparata 0:e7e920b85676 112 * @brief Utility function to write data.
cparata 0:e7e920b85676 113 * @param pBuffer: pointer to data to be written.
cparata 0:e7e920b85676 114 * @param RegisterAddr: specifies internal address register to be written.
cparata 0:e7e920b85676 115 * @param NumByteToWrite: number of bytes to write.
cparata 0:e7e920b85676 116 * @retval 0 if ok, an error code otherwise.
cparata 0:e7e920b85676 117 */
cparata 0:e7e920b85676 118 uint8_t IO_Write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
cparata 0:e7e920b85676 119 {
cparata 0:e7e920b85676 120 return (uint8_t) dev_i2c.i2c_write(pBuffer, address, RegisterAddr, NumByteToWrite);
cparata 0:e7e920b85676 121 }
cparata 0:e7e920b85676 122
cparata 0:e7e920b85676 123 private:
cparata 0:e7e920b85676 124 LSM303AGR_ACC_StatusTypeDef SetODR_When_Enabled(float odr);
cparata 0:e7e920b85676 125 LSM303AGR_ACC_StatusTypeDef SetODR_When_Disabled(float odr);
cparata 0:e7e920b85676 126 LSM303AGR_ACC_StatusTypeDef GetSensitivity_Normal_Mode( float *sensitivity );
cparata 0:e7e920b85676 127 LSM303AGR_ACC_StatusTypeDef GetSensitivity_LP_Mode( float *sensitivity );
cparata 0:e7e920b85676 128 LSM303AGR_ACC_StatusTypeDef GetSensitivity_HR_Mode( float *sensitivity );
cparata 0:e7e920b85676 129
cparata 0:e7e920b85676 130 /* Helper classes. */
cparata 0:e7e920b85676 131 DevI2C &dev_i2c;
cparata 0:e7e920b85676 132
cparata 0:e7e920b85676 133 /* Configuration */
cparata 0:e7e920b85676 134 uint8_t address;
cparata 0:e7e920b85676 135
cparata 0:e7e920b85676 136 uint8_t isEnabled;
cparata 0:e7e920b85676 137 float Last_ODR;
cparata 0:e7e920b85676 138 };
cparata 0:e7e920b85676 139
cparata 0:e7e920b85676 140 #ifdef __cplusplus
cparata 0:e7e920b85676 141 extern "C" {
cparata 0:e7e920b85676 142 #endif
cparata 0:e7e920b85676 143 uint8_t LSM303AGR_ACC_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite );
cparata 0:e7e920b85676 144 uint8_t LSM303AGR_ACC_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead );
cparata 0:e7e920b85676 145 #ifdef __cplusplus
cparata 0:e7e920b85676 146 }
cparata 0:e7e920b85676 147 #endif
cparata 0:e7e920b85676 148
cparata 0:e7e920b85676 149 #endif