Example of single tap and double tap detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of SingleDoubleTap_IKS01A2 by ST Expansion SW Team

Single and Double Tap Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to detect the single and double tap events 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 tap the board and then view the notification using an hyper terminal. When the single tap is detected, the LED is switched on for a while.
- the user can press the user button to pass from the single tap detection to the double tap detection feature. The user can try to double tap the board and then view the notification using an hyper terminal. When the double tap is detected, the LED is switched on twice for a while.
- the user can press again the user button to disable the single and double tap detection feature.
- the user can press the user button to enable again the single tap detection feature and so on.

Committer:
cparata
Date:
Fri Aug 12 13:42:02 2016 +0000
Revision:
0:e4f89df7a7a5
First release of Single/Double Tap for LSM6DSL in IKS01A2

Who changed what in which revision?

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