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@2:917662c6fc72, 2019-04-12 (annotated)

Committer:
cparata
Date:
Fri Apr 12 13:47:43 2019 +0000
Revision:
2:917662c6fc72
Parent:
0:4afec65463dd
Child:
4:387ef72462e0
Update X-NUCLEO-IKS01A3 library

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 0:4afec65463dd 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 0:4afec65463dd 37 */
cparata 0:4afec65463dd 38
cparata 0:4afec65463dd 39 /* Includes */
cparata 0:4afec65463dd 40 #include "mbed.h"
cparata 0:4afec65463dd 41 #include "XNucleoIKS01A3.h"
cparata 0:4afec65463dd 42
cparata 0:4afec65463dd 43 /* Instantiate the expansion board */
cparata 0:4afec65463dd 44 static XNucleoIKS01A3 *mems_expansion_board = XNucleoIKS01A3::instance(D14, D15, D4, D5, A3, D6, A4);
cparata 0:4afec65463dd 45
cparata 0:4afec65463dd 46 /* Retrieve the composing elements of the expansion board */
cparata 0:4afec65463dd 47 static LSM6DSOSensor *acc_gyro = mems_expansion_board->acc_gyro;
cparata 0:4afec65463dd 48
cparata 0:4afec65463dd 49 InterruptIn mybutton(USER_BUTTON);
cparata 0:4afec65463dd 50 DigitalOut myled(LED1);
cparata 0:4afec65463dd 51
cparata 0:4afec65463dd 52 volatile int mems_event = 0;
cparata 0:4afec65463dd 53 volatile int toggle_wake_up_enable = 0;
cparata 0:4afec65463dd 54 static int wake_up_is_enabled = 1;
cparata 0:4afec65463dd 55
cparata 0:4afec65463dd 56 void pressed_cb();
cparata 0:4afec65463dd 57 void INT1_cb();
cparata 0:4afec65463dd 58
cparata 0:4afec65463dd 59 /* Simple main function */
cparata 0:4afec65463dd 60 int main() {
cparata 0:4afec65463dd 61 /* Attach callback to User button press */
cparata 0:4afec65463dd 62 mybutton.fall(&pressed_cb);
cparata 0:4afec65463dd 63 /* Attach callback to LSM6DSO INT1 */
cparata 0:4afec65463dd 64 acc_gyro->attach_int1_irq(&INT1_cb);
cparata 0:4afec65463dd 65
cparata 0:4afec65463dd 66 /* Enable LSM6DSO accelerometer */
cparata 0:4afec65463dd 67 acc_gyro->enable_x();
cparata 0:4afec65463dd 68 /* Enable Wake-Up Detection. */
cparata 0:4afec65463dd 69 acc_gyro->enable_wake_up_detection();
cparata 0:4afec65463dd 70
cparata 0:4afec65463dd 71 printf("\r\n--- Starting new run ---\r\n");
cparata 0:4afec65463dd 72
cparata 0:4afec65463dd 73 while(1) {
cparata 0:4afec65463dd 74 if(toggle_wake_up_enable) {
cparata 0:4afec65463dd 75 toggle_wake_up_enable = 0;
cparata 0:4afec65463dd 76 if(wake_up_is_enabled == 0) {
cparata 0:4afec65463dd 77 acc_gyro->enable_wake_up_detection();
cparata 0:4afec65463dd 78 wake_up_is_enabled = 1;
cparata 0:4afec65463dd 79 } else {
cparata 0:4afec65463dd 80 acc_gyro->disable_wake_up_detection();
cparata 0:4afec65463dd 81 wake_up_is_enabled = 0;
cparata 0:4afec65463dd 82 }
cparata 0:4afec65463dd 83 }
cparata 0:4afec65463dd 84
cparata 0:4afec65463dd 85 if (mems_event) {
cparata 0:4afec65463dd 86 mems_event = 0;
cparata 0:4afec65463dd 87 LSM6DSO_Event_Status_t status;
cparata 0:4afec65463dd 88 acc_gyro->get_event_status(&status);
cparata 0:4afec65463dd 89 if (status.WakeUpStatus) {
cparata 0:4afec65463dd 90 /* Led blinking. */
cparata 0:4afec65463dd 91 myled = 1;
cparata 0:4afec65463dd 92 wait(0.2);
cparata 0:4afec65463dd 93 myled = 0;
cparata 0:4afec65463dd 94
cparata 0:4afec65463dd 95 /* Output data. */
cparata 0:4afec65463dd 96 printf("Wake Up Detected!\r\n");
cparata 0:4afec65463dd 97 }
cparata 0:4afec65463dd 98 }
cparata 0:4afec65463dd 99 }
cparata 0:4afec65463dd 100 }
cparata 0:4afec65463dd 101
cparata 0:4afec65463dd 102 void pressed_cb() {
cparata 0:4afec65463dd 103 toggle_wake_up_enable = 1;
cparata 0:4afec65463dd 104 }
cparata 0:4afec65463dd 105
cparata 0:4afec65463dd 106 void INT1_cb() {
cparata 0:4afec65463dd 107 mems_event = 1;
cparata 0:4afec65463dd 108 }