ST / Mbed OS WakeUp_LSM6DSO_IKS01A3

Example of wake up detection for LSM6DSO in X-NUCLEO-IKS01A3

Dependencies:   X_NUCLEO_IKS01A3

Wake up Demo Application with LSM6DSO based on sensor expansion board X-NUCLEO-IKS01A3

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.

main.cpp@7:4d85f673378c, 2021-06-24 (annotated)

Committer:
cparata
Date:
Thu Jun 24 12:50:25 2021 +0000
Revision:
7:4d85f673378c
Parent:
5:56ed0a42fd9b 
Update button label

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 0:4afec65463dd 1 /**
cparata 0:4afec65463dd 2 ******************************************************************************
cparata 0:4afec65463dd 3 * @file main.cpp
cparata 0:4afec65463dd 4 * @author SRA
cparata 0:4afec65463dd 5 * @version V1.0.0
cparata 0:4afec65463dd 6 * @date 5-March-2019
cparata 4:387ef72462e0 7 * @brief Simple Example application for using the X_NUCLEO_IKS01A3
cparata 0:4afec65463dd 8 * MEMS Inertial & Environmental Sensor Nucleo expansion board.
cparata 0:4afec65463dd 9 ******************************************************************************
cparata 0:4afec65463dd 10 * @attention
cparata 0:4afec65463dd 11 *
cparata 0:4afec65463dd 12 * <h2><center>&copy; COPYRIGHT(c) 2019 STMicroelectronics</center></h2>
cparata 0:4afec65463dd 13 *
cparata 0:4afec65463dd 14 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:4afec65463dd 15 * are permitted provided that the following conditions are met:
cparata 0:4afec65463dd 16 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:4afec65463dd 17 * this list of conditions and the following disclaimer.
cparata 0:4afec65463dd 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:4afec65463dd 19 * this list of conditions and the following disclaimer in the documentation
cparata 0:4afec65463dd 20 * and/or other materials provided with the distribution.
cparata 0:4afec65463dd 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:4afec65463dd 22 * may be used to endorse or promote products derived from this software
cparata 0:4afec65463dd 23 * without specific prior written permission.
cparata 0:4afec65463dd 24 *
cparata 0:4afec65463dd 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:4afec65463dd 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:4afec65463dd 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:4afec65463dd 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:4afec65463dd 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:4afec65463dd 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:4afec65463dd 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:4afec65463dd 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:4afec65463dd 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:4afec65463dd 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:4afec65463dd 35 *
cparata 0:4afec65463dd 36 ******************************************************************************
cparata 4:387ef72462e0 37 */
cparata 4:387ef72462e0 38
cparata 0:4afec65463dd 39 /* Includes */
cparata 0:4afec65463dd 40 #include "mbed.h"
cparata 5:56ed0a42fd9b 41 #include "rtos.h"
cparata 0:4afec65463dd 42 #include "XNucleoIKS01A3.h"
cparata 4:387ef72462e0 43
cparata 0:4afec65463dd 44 /* Instantiate the expansion board */
cparata 0:4afec65463dd 45 static XNucleoIKS01A3 *mems_expansion_board = XNucleoIKS01A3::instance(D14, D15, D4, D5, A3, D6, A4);
cparata 4:387ef72462e0 46
cparata 0:4afec65463dd 47 /* Retrieve the composing elements of the expansion board */
cparata 0:4afec65463dd 48 static LSM6DSOSensor *acc_gyro = mems_expansion_board->acc_gyro;
cparata 4:387ef72462e0 49
cparata 7:4d85f673378c 50 InterruptIn mybutton(BUTTON1);
cparata 0:4afec65463dd 51 DigitalOut myled(LED1);
cparata 4:387ef72462e0 52
cparata 0:4afec65463dd 53 volatile int mems_event = 0;
cparata 0:4afec65463dd 54 volatile int toggle_wake_up_enable = 0;
cparata 0:4afec65463dd 55 static int wake_up_is_enabled = 1;
cparata 4:387ef72462e0 56
cparata 0:4afec65463dd 57 void pressed_cb();
cparata 0:4afec65463dd 58 void INT1_cb();
cparata 4:387ef72462e0 59
cparata 0:4afec65463dd 60 /* Simple main function */
cparata 4:387ef72462e0 61 int main()
cparata 4:387ef72462e0 62 {
cparata 4:387ef72462e0 63 /* Attach callback to User button press */
cparata 4:387ef72462e0 64 mybutton.fall(&pressed_cb);
cparata 4:387ef72462e0 65 /* Attach callback to LSM6DSO INT1 */
cparata 4:387ef72462e0 66 acc_gyro->attach_int1_irq(&INT1_cb);
cparata 4:387ef72462e0 67
cparata 4:387ef72462e0 68 /* Enable LSM6DSO accelerometer */
cparata 4:387ef72462e0 69 acc_gyro->enable_x();
cparata 4:387ef72462e0 70 /* Enable Wake-Up Detection. */
cparata 4:387ef72462e0 71 acc_gyro->enable_wake_up_detection();
cparata 4:387ef72462e0 72
cparata 4:387ef72462e0 73 printf("\r\n--- Starting new run ---\r\n");
cparata 4:387ef72462e0 74
cparata 4:387ef72462e0 75 while (1) {
cparata 4:387ef72462e0 76 if (toggle_wake_up_enable) {
cparata 4:387ef72462e0 77 toggle_wake_up_enable = 0;
cparata 4:387ef72462e0 78 if (wake_up_is_enabled == 0) {
cparata 4:387ef72462e0 79 acc_gyro->enable_wake_up_detection();
cparata 4:387ef72462e0 80 wake_up_is_enabled = 1;
cparata 4:387ef72462e0 81 } else {
cparata 4:387ef72462e0 82 acc_gyro->disable_wake_up_detection();
cparata 4:387ef72462e0 83 wake_up_is_enabled = 0;
cparata 4:387ef72462e0 84 }
cparata 4:387ef72462e0 85 }
cparata 4:387ef72462e0 86
cparata 4:387ef72462e0 87 if (mems_event) {
cparata 4:387ef72462e0 88 mems_event = 0;
cparata 4:387ef72462e0 89 LSM6DSO_Event_Status_t status;
cparata 4:387ef72462e0 90 acc_gyro->get_event_status(&status);
cparata 4:387ef72462e0 91 if (status.WakeUpStatus) {
cparata 4:387ef72462e0 92 /* Led blinking. */
cparata 4:387ef72462e0 93 myled = 1;
cparata 5:56ed0a42fd9b 94 ThisThread::sleep_for(200);
cparata 4:387ef72462e0 95 myled = 0;
cparata 4:387ef72462e0 96
cparata 4:387ef72462e0 97 /* Output data. */
cparata 4:387ef72462e0 98 printf("Wake Up Detected!\r\n");
cparata 4:387ef72462e0 99 }
cparata 4:387ef72462e0 100 }
cparata 0:4afec65463dd 101 }
cparata 4:387ef72462e0 102 }
cparata 4:387ef72462e0 103
cparata 4:387ef72462e0 104 void pressed_cb()
cparata 4:387ef72462e0 105 {
cparata 4:387ef72462e0 106 toggle_wake_up_enable = 1;
cparata 0:4afec65463dd 107 }
cparata 4:387ef72462e0 108
cparata 4:387ef72462e0 109 void INT1_cb()
cparata 4:387ef72462e0 110 {
cparata 4:387ef72462e0 111 mems_event = 1;
cparata 0:4afec65463dd 112 }