Example of single tap and double tap detection for LSM6DSO in X-NUCLEO-IKS01A3

Dependencies:   X_NUCLEO_IKS01A3

Single and Double Tap Demo Application with LSM6DSO based on sensor expansion board X-NUCLEO-IKS01A3

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.

main.cpp

Committer:
cparata
Date:
2021-06-24
Revision:
8:71f36814ea4d
Parent:
6:d4003733e337

File content as of revision 8:71f36814ea4d:

/**
 ******************************************************************************
 * @file    main.cpp
 * @author  SRA
 * @version V1.0.0
 * @date    5-March-2019
 * @brief   Simple Example application for using the X_NUCLEO_IKS01A3
 *          MEMS Inertial & Environmental Sensor Nucleo expansion board.
 ******************************************************************************
 * @attention
 *
 * <h2><center>&copy; COPYRIGHT(c) 2019 STMicroelectronics</center></h2>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *   1. Redistributions of source code must retain the above copyright notice,
 *      this list of conditions and the following disclaimer.
 *   2. Redistributions in binary form must reproduce the above copyright notice,
 *      this list of conditions and the following disclaimer in the documentation
 *      and/or other materials provided with the distribution.
 *   3. Neither the name of STMicroelectronics nor the names of its contributors
 *      may be used to endorse or promote products derived from this software
 *      without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 *  SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************
*/

/* Includes */
#include "mbed.h"
#include "rtos.h"
#include "XNucleoIKS01A3.h"

/* Instantiate the expansion board */
static XNucleoIKS01A3 *mems_expansion_board = XNucleoIKS01A3::instance(D14, D15, D4, D5, A3, D6, A4);

/* Retrieve the composing elements of the expansion board */
static LSM6DSOSensor *acc_gyro = mems_expansion_board->acc_gyro;

InterruptIn mybutton(BUTTON1);
DigitalOut myled(LED1);

volatile int mems_event = 0;
volatile int change_mode = 0;
static int mode = 1; /* 0 means No tap, 1 means Single Tap enabled, 2 means Double Tap enabled*/

/* User button callback. */
void pressed_cb()
{
    change_mode = 1;
}

/* Interrupt 1 callback. */
void int1_cb()
{
    mems_event = 1;
}

/* Simple main function */
int main()
{
    /* Attach callback to User button press */
    mybutton.fall(&pressed_cb);
    /* Attach callback to LSM6DSO INT1 */
    acc_gyro->attach_int1_irq(&int1_cb);

    /* Enable LSM6DSO accelerometer */
    acc_gyro->enable_x();
    /* Enable Single Tap Detection. */
    acc_gyro->enable_single_tap_detection();

    printf("\r\n--- Starting new run ---\r\n");

    while (1) {
        if (change_mode) {
            change_mode = 0;
            mode = ((mode + 1) % 3);
            switch (mode) {
                case 0:
                    /* Disable Double Tap */
                    acc_gyro->disable_double_tap_detection();
                    break;
                case 1:
                    /* Enable Single Tap */
                    acc_gyro->enable_single_tap_detection();
                    break;
                case 2:
                    /* Disable Single Tap and Enable Double Tap */
                    acc_gyro->disable_single_tap_detection();
                    acc_gyro->enable_double_tap_detection();
                    break;
            }
        }

        if (mems_event) {
            mems_event = 0;
            switch (mode) {
                case 0:
                default:
                    break;
                case 1: {
                    LSM6DSO_Event_Status_t status;
                    acc_gyro->get_event_status(&status);
                    if (status.TapStatus) {
                        /* Led blinking. */
                        myled = 1;
                        ThisThread::sleep_for(100);
                        myled = 0;

                        /* Output data. */
                        printf("Single Tap Detected!\r\n");
                    }
                    break;
                }
                case 2: {
                    LSM6DSO_Event_Status_t status;
                    acc_gyro->get_event_status(&status);
                    if (status.DoubleTapStatus) {
                        /* Double Led blinking */
                        myled = 1;
                        ThisThread::sleep_for(100);
                        myled = 0;
                        ThisThread::sleep_for(100);
                        myled = 1;
                        ThisThread::sleep_for(100);
                        myled = 0;

                        /* Output data. */
                        printf("Double Tap Detected!\r\n");
                    }
                    break;
                }
            }
        }
    }
}