ST / Mbed 2 deprecated SingleDoubleTap_IKS01A2

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.

X_NUCLEO_IKS01A2/X_NUCLEO_COMMON/DevI2C/DevI2C.h@2:21a191bd1998, 2016-08-19 (annotated)

Committer:
cparata
Date:
Fri Aug 19 12:31:21 2016 +0000
Revision:
2:21a191bd1998
Parent:
0:e4f89df7a7a5 
Add interfaces to all components

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 0:e4f89df7a7a5 1 /**
cparata 0:e4f89df7a7a5 2 ******************************************************************************
cparata 0:e4f89df7a7a5 3 * @file DevI2C.h
cparata 0:e4f89df7a7a5 4 * @author AST / EST
cparata 0:e4f89df7a7a5 5 * @version V0.0.1
cparata 0:e4f89df7a7a5 6 * @date 21-January-2015
cparata 0:e4f89df7a7a5 7 * @brief Header file for a special I2C class DevI2C which provides some
cparata 0:e4f89df7a7a5 8 * helper function for on-board communication
cparata 0:e4f89df7a7a5 9 ******************************************************************************
cparata 0:e4f89df7a7a5 10 * @attention
cparata 0:e4f89df7a7a5 11 *
cparata 0:e4f89df7a7a5 12 * <h2><center>&copy; COPYRIGHT(c) 2014 STMicroelectronics</center></h2>
cparata 0:e4f89df7a7a5 13 *
cparata 0:e4f89df7a7a5 14 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:e4f89df7a7a5 15 * are permitted provided that the following conditions are met:
cparata 0:e4f89df7a7a5 16 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:e4f89df7a7a5 17 * this list of conditions and the following disclaimer.
cparata 0:e4f89df7a7a5 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:e4f89df7a7a5 19 * this list of conditions and the following disclaimer in the documentation
cparata 0:e4f89df7a7a5 20 * and/or other materials provided with the distribution.
cparata 0:e4f89df7a7a5 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:e4f89df7a7a5 22 * may be used to endorse or promote products derived from this software
cparata 0:e4f89df7a7a5 23 * without specific prior written permission.
cparata 0:e4f89df7a7a5 24 *
cparata 0:e4f89df7a7a5 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:e4f89df7a7a5 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:e4f89df7a7a5 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:e4f89df7a7a5 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:e4f89df7a7a5 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:e4f89df7a7a5 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:e4f89df7a7a5 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:e4f89df7a7a5 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:e4f89df7a7a5 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:e4f89df7a7a5 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:e4f89df7a7a5 35 *
cparata 0:e4f89df7a7a5 36 ******************************************************************************
cparata 0:e4f89df7a7a5 37 */
cparata 0:e4f89df7a7a5 38
cparata 0:e4f89df7a7a5 39 /* Define to prevent from recursive inclusion --------------------------------*/
cparata 0:e4f89df7a7a5 40 #ifndef __DEV_I2C_H
cparata 0:e4f89df7a7a5 41 #define __DEV_I2C_H
cparata 0:e4f89df7a7a5 42
cparata 0:e4f89df7a7a5 43 /* Includes ------------------------------------------------------------------*/
cparata 0:e4f89df7a7a5 44 #include "mbed.h"
cparata 0:e4f89df7a7a5 45
cparata 0:e4f89df7a7a5 46 /* Classes -------------------------------------------------------------------*/
cparata 0:e4f89df7a7a5 47 /** Helper class DevI2C providing functions for multi-register I2C communication
cparata 0:e4f89df7a7a5 48 * common for a series of I2C devices
cparata 0:e4f89df7a7a5 49 */
cparata 0:e4f89df7a7a5 50 class DevI2C : public I2C
cparata 0:e4f89df7a7a5 51 {
cparata 0:e4f89df7a7a5 52 public:
cparata 0:e4f89df7a7a5 53 /** Create a DevI2C Master interface, connected to the specified pins
cparata 0:e4f89df7a7a5 54 *
cparata 0:e4f89df7a7a5 55 * @param sda I2C data line pin
cparata 0:e4f89df7a7a5 56 * @param scl I2C clock line pin
cparata 0:e4f89df7a7a5 57 */
cparata 0:e4f89df7a7a5 58 DevI2C(PinName sda, PinName scl) : I2C(sda, scl) {}
cparata 0:e4f89df7a7a5 59
cparata 0:e4f89df7a7a5 60 /**
cparata 0:e4f89df7a7a5 61 * @brief Writes a buffer towards the I2C peripheral device.
cparata 0:e4f89df7a7a5 62 * @param pBuffer pointer to the byte-array data to send
cparata 0:e4f89df7a7a5 63 * @param DeviceAddr specifies the peripheral device slave address.
cparata 0:e4f89df7a7a5 64 * @param RegisterAddr specifies the internal address register
cparata 0:e4f89df7a7a5 65 * where to start writing to (must be correctly masked).
cparata 0:e4f89df7a7a5 66 * @param NumByteToWrite number of bytes to be written.
cparata 0:e4f89df7a7a5 67 * @retval 0 if ok,
cparata 0:e4f89df7a7a5 68 * @retval -1 if an I2C error has occured, or
cparata 0:e4f89df7a7a5 69 * @retval -2 on temporary buffer overflow (i.e. NumByteToWrite was too high)
cparata 0:e4f89df7a7a5 70 * @note On some devices if NumByteToWrite is greater
cparata 0:e4f89df7a7a5 71 * than one, the RegisterAddr must be masked correctly!
cparata 0:e4f89df7a7a5 72 */
cparata 0:e4f89df7a7a5 73 int i2c_write(uint8_t* pBuffer, uint8_t DeviceAddr, uint8_t RegisterAddr,
cparata 0:e4f89df7a7a5 74 uint16_t NumByteToWrite)
cparata 0:e4f89df7a7a5 75 {
cparata 0:e4f89df7a7a5 76 int ret;
cparata 0:e4f89df7a7a5 77 uint8_t tmp[TEMP_BUF_SIZE];
cparata 0:e4f89df7a7a5 78
cparata 0:e4f89df7a7a5 79 if(NumByteToWrite >= TEMP_BUF_SIZE) return -2;
cparata 0:e4f89df7a7a5 80
cparata 0:e4f89df7a7a5 81 /* First, send device address. Then, send data and STOP condition */
cparata 0:e4f89df7a7a5 82 tmp[0] = RegisterAddr;
cparata 0:e4f89df7a7a5 83 memcpy(tmp+1, pBuffer, NumByteToWrite);
cparata 0:e4f89df7a7a5 84
cparata 0:e4f89df7a7a5 85 ret = write(DeviceAddr, (const char*)tmp, NumByteToWrite+1, false);
cparata 0:e4f89df7a7a5 86
cparata 0:e4f89df7a7a5 87 if(ret) return -1;
cparata 0:e4f89df7a7a5 88 return 0;
cparata 0:e4f89df7a7a5 89 }
cparata 0:e4f89df7a7a5 90
cparata 0:e4f89df7a7a5 91 /**
cparata 0:e4f89df7a7a5 92 * @brief Reads a buffer from the I2C peripheral device.
cparata 0:e4f89df7a7a5 93 * @param pBuffer pointer to the byte-array to read data in to
cparata 0:e4f89df7a7a5 94 * @param DaviceAddr specifies the peripheral device slave address.
cparata 0:e4f89df7a7a5 95 * @param RegisterAddr specifies the internal address register
cparata 0:e4f89df7a7a5 96 * where to start reading from (must be correctly masked).
cparata 0:e4f89df7a7a5 97 * @param NumByteToRead number of bytes to be read.
cparata 0:e4f89df7a7a5 98 * @retval 0 if ok,
cparata 0:e4f89df7a7a5 99 * @retval -1 if an I2C error has occured
cparata 0:e4f89df7a7a5 100 * @note On some devices if NumByteToWrite is greater
cparata 0:e4f89df7a7a5 101 * than one, the RegisterAddr must be masked correctly!
cparata 0:e4f89df7a7a5 102 */
cparata 0:e4f89df7a7a5 103 int i2c_read(uint8_t* pBuffer, uint8_t DeviceAddr, uint8_t RegisterAddr,
cparata 0:e4f89df7a7a5 104 uint16_t NumByteToRead)
cparata 0:e4f89df7a7a5 105 {
cparata 0:e4f89df7a7a5 106 int ret;
cparata 0:e4f89df7a7a5 107
cparata 0:e4f89df7a7a5 108 /* Send device address, with no STOP condition */
cparata 0:e4f89df7a7a5 109 ret = write(DeviceAddr, (const char*)&RegisterAddr, 1, true);
cparata 0:e4f89df7a7a5 110 if(!ret) {
cparata 0:e4f89df7a7a5 111 /* Read data, with STOP condition */
cparata 0:e4f89df7a7a5 112 ret = read(DeviceAddr, (char*)pBuffer, NumByteToRead, false);
cparata 0:e4f89df7a7a5 113 }
cparata 0:e4f89df7a7a5 114
cparata 0:e4f89df7a7a5 115 if(ret) return -1;
cparata 0:e4f89df7a7a5 116 return 0;
cparata 0:e4f89df7a7a5 117 }
cparata 0:e4f89df7a7a5 118
cparata 0:e4f89df7a7a5 119 private:
cparata 0:e4f89df7a7a5 120 static const unsigned int TEMP_BUF_SIZE = 32;
cparata 0:e4f89df7a7a5 121 };
cparata 0:e4f89df7a7a5 122
cparata 0:e4f89df7a7a5 123 #endif /* __DEV_I2C_H */