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/x_nucleo_iks01a2.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 x_nucleo_iks01a2.h
cparata 0:e7e920b85676 4 * @author AST / EST
cparata 0:e7e920b85676 5 * @version V0.0.1
cparata 0:e7e920b85676 6 * @date 9-August-2016
cparata 0:e7e920b85676 7 * @brief Header file for class X_NUCLEO_IKS01A2 representing a X-NUCLEO-IKS01A2
cparata 0:e7e920b85676 8 * expansion board
cparata 0:e7e920b85676 9 ******************************************************************************
cparata 0:e7e920b85676 10 * @attention
cparata 0:e7e920b85676 11 *
cparata 0:e7e920b85676 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 0:e7e920b85676 13 *
cparata 0:e7e920b85676 14 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:e7e920b85676 15 * are permitted provided that the following conditions are met:
cparata 0:e7e920b85676 16 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:e7e920b85676 17 * this list of conditions and the following disclaimer.
cparata 0:e7e920b85676 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:e7e920b85676 19 * this list of conditions and the following disclaimer in the documentation
cparata 0:e7e920b85676 20 * and/or other materials provided with the distribution.
cparata 0:e7e920b85676 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:e7e920b85676 22 * may be used to endorse or promote products derived from this software
cparata 0:e7e920b85676 23 * without specific prior written permission.
cparata 0:e7e920b85676 24 *
cparata 0:e7e920b85676 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:e7e920b85676 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:e7e920b85676 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:e7e920b85676 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:e7e920b85676 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:e7e920b85676 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:e7e920b85676 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:e7e920b85676 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:e7e920b85676 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:e7e920b85676 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:e7e920b85676 35 *
cparata 0:e7e920b85676 36 ******************************************************************************
cparata 0:e7e920b85676 37 */
cparata 0:e7e920b85676 38
cparata 0:e7e920b85676 39 /* Define to prevent from recursive inclusion --------------------------------*/
cparata 0:e7e920b85676 40 #ifndef __X_NUCLEO_IKS01A2_H
cparata 0:e7e920b85676 41 #define __X_NUCLEO_IKS01A2_H
cparata 0:e7e920b85676 42
cparata 0:e7e920b85676 43 /* Includes ------------------------------------------------------------------*/
cparata 0:e7e920b85676 44 #include "mbed.h"
cparata 0:e7e920b85676 45 #include "x_nucleo_iks01a2_targets.h"
cparata 0:e7e920b85676 46 #include "HTS221Sensor/HTS221Sensor.h"
cparata 0:e7e920b85676 47 #include "LSM303AGRSensor/LSM303AGR_ACC_Sensor.h"
cparata 0:e7e920b85676 48 #include "LSM303AGRSensor/LSM303AGR_MAG_Sensor.h"
cparata 0:e7e920b85676 49 #include "LPS22HBSensor/LPS22HBSensor.h"
cparata 0:e7e920b85676 50 #include "LSM6DSLSensor/LSM6DSLSensor.h"
cparata 0:e7e920b85676 51 #include "DevI2C.h"
cparata 0:e7e920b85676 52
cparata 0:e7e920b85676 53 /* Macros -------------------------------------------------------------------*/
cparata 0:e7e920b85676 54 #define CALL_METH(obj, meth, param, ret) ((obj == NULL) ? \
cparata 0:e7e920b85676 55 ((*(param) = (ret)), 0) : \
cparata 0:e7e920b85676 56 ((obj)->meth(param)) \
cparata 0:e7e920b85676 57 )
cparata 0:e7e920b85676 58
cparata 0:e7e920b85676 59 /* Classes -------------------------------------------------------------------*/
cparata 0:e7e920b85676 60 /** Class X_NUCLEO_IKS01A2 is intended to represent the MEMS Inertial & Environmental
cparata 0:e7e920b85676 61 * Nucleo Expansion Board with the same name.
cparata 0:e7e920b85676 62 *
cparata 0:e7e920b85676 63 * The expansion board is featuring basically four IPs:\n
cparata 0:e7e920b85676 64 * -# a HTS221 Relative Humidity and Temperature Sensor\n
cparata 0:e7e920b85676 65 * -# a LSM303AGR 3-Axis Magnetometer and 3D Acceleromenter\n
cparata 0:e7e920b85676 66 * -# a LPS22HB MEMS Pressure Sensor (and Temperature Sensor)\n
cparata 0:e7e920b85676 67 * -# and a LSM6DSL 3D Acceleromenter and 3D Gyroscope\n
cparata 0:e7e920b85676 68 *
cparata 0:e7e920b85676 69 * The expansion board features also a DIL 24-pin socket which makes it possible
cparata 0:e7e920b85676 70 * to add further MEMS adapters and other sensors (e.g. UV index).
cparata 0:e7e920b85676 71 *
cparata 0:e7e920b85676 72 * It is intentionally implemented as a singleton because only one
cparata 0:e7e920b85676 73 * X_NUCLEO_IKS01A2 at a time might be deployed in a HW component stack.\n
cparata 0:e7e920b85676 74 * In order to get the singleton instance you have to call class method `Instance()`,
cparata 0:e7e920b85676 75 * e.g.:
cparata 0:e7e920b85676 76 * @code
cparata 0:e7e920b85676 77 * // Inertial & Environmental expansion board singleton instance
cparata 0:e7e920b85676 78 * static X_NUCLEO_IKS01A2 *<TODO>_expansion_board = X_NUCLEO_IKS01A2::Instance();
cparata 0:e7e920b85676 79 * @endcode
cparata 0:e7e920b85676 80 */
cparata 0:e7e920b85676 81 class X_NUCLEO_IKS01A2
cparata 0:e7e920b85676 82 {
cparata 0:e7e920b85676 83 protected:
cparata 0:e7e920b85676 84 X_NUCLEO_IKS01A2(DevI2C *ext_i2c);
cparata 0:e7e920b85676 85
cparata 0:e7e920b85676 86 ~X_NUCLEO_IKS01A2(void) {
cparata 0:e7e920b85676 87 /* should never be called */
cparata 0:e7e920b85676 88 error("Trial to delete X_NUCLEO_IKS01A2 singleton!\n");
cparata 0:e7e920b85676 89 }
cparata 0:e7e920b85676 90
cparata 0:e7e920b85676 91 public:
cparata 0:e7e920b85676 92 static X_NUCLEO_IKS01A2* Instance(DevI2C *ext_i2c = NULL);
cparata 0:e7e920b85676 93 static X_NUCLEO_IKS01A2* Instance(PinName sda, PinName scl);
cparata 0:e7e920b85676 94
cparata 0:e7e920b85676 95 DevI2C *dev_i2c;
cparata 0:e7e920b85676 96
cparata 0:e7e920b85676 97 HTS221Sensor *ht_sensor;
cparata 0:e7e920b85676 98 LSM303AGR_MAG_Sensor *magnetometer;
cparata 0:e7e920b85676 99 LSM303AGR_ACC_Sensor *accelerometer;
cparata 0:e7e920b85676 100 LPS22HBSensor *pt_sensor;
cparata 0:e7e920b85676 101 LSM6DSLSensor *acc_gyro;
cparata 0:e7e920b85676 102
cparata 0:e7e920b85676 103 private:
cparata 0:e7e920b85676 104 static X_NUCLEO_IKS01A2 *_instance;
cparata 0:e7e920b85676 105 };
cparata 0:e7e920b85676 106
cparata 0:e7e920b85676 107 #endif /* __X_NUCLEO_IKS01A2_H */