ST / Mbed 2 deprecated WakeUp_IKS01A2

Example of wake up detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of WakeUp_IKS01A2 by ST Expansion SW Team

Wake up Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

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.

X_NUCLEO_IKS01A2/X_NUCLEO_COMMON/DevSPI/DevSPI.h@0:e7e920b85676, 2016-08-12 (annotated)

Committer:
cparata
Date:
Fri Aug 12 13:43:40 2016 +0000
Revision:
0:e7e920b85676
First release of Wake-Up Detection for LSM6DSL in IKS01A2

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 0:e7e920b85676 1 /**
cparata 0:e7e920b85676 2 ******************************************************************************
cparata 0:e7e920b85676 3 * @file DevSPI.h
cparata 0:e7e920b85676 4 * @author AST / Software Platforms and Cloud / EST
cparata 0:e7e920b85676 5 * @version V1.2.1
cparata 0:e7e920b85676 6 * @date 19-February-2016
cparata 0:e7e920b85676 7 * @brief Header file for a special SPI class DevSPI which provides some
cparata 0:e7e920b85676 8 * helper functions for on-board communication.
cparata 0:e7e920b85676 9 ******************************************************************************
cparata 0:e7e920b85676 10 * @attention
cparata 0:e7e920b85676 11 *
cparata 0:e7e920b85676 12 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 0:e7e920b85676 13 *
cparata 0:e7e920b85676 14 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:e7e920b85676 15 * are permitted provided that the following conditions are met:
cparata 0:e7e920b85676 16 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:e7e920b85676 17 * this list of conditions and the following disclaimer.
cparata 0:e7e920b85676 18 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:e7e920b85676 19 * this list of conditions and the following disclaimer in the documentation
cparata 0:e7e920b85676 20 * and/or other materials provided with the distribution.
cparata 0:e7e920b85676 21 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:e7e920b85676 22 * may be used to endorse or promote products derived from this software
cparata 0:e7e920b85676 23 * without specific prior written permission.
cparata 0:e7e920b85676 24 *
cparata 0:e7e920b85676 25 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:e7e920b85676 26 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:e7e920b85676 27 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:e7e920b85676 28 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:e7e920b85676 29 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:e7e920b85676 30 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:e7e920b85676 31 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:e7e920b85676 32 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:e7e920b85676 33 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:e7e920b85676 34 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:e7e920b85676 35 *
cparata 0:e7e920b85676 36 ******************************************************************************
cparata 0:e7e920b85676 37 */
cparata 0:e7e920b85676 38
cparata 0:e7e920b85676 39 /* Define to prevent from recursive inclusion --------------------------------*/
cparata 0:e7e920b85676 40 #ifndef __DEV_SPI_H
cparata 0:e7e920b85676 41 #define __DEV_SPI_H
cparata 0:e7e920b85676 42
cparata 0:e7e920b85676 43 /* Includes ------------------------------------------------------------------*/
cparata 0:e7e920b85676 44 #include "mbed.h"
cparata 0:e7e920b85676 45
cparata 0:e7e920b85676 46 /* Macros --------------------------------------------------------------------*/
cparata 0:e7e920b85676 47 #if (defined(__BYTE_ORDER__) && (__BYTE_ORDER__ == __ORDER_BIG_ENDIAN__)) /* GCC */ || \
cparata 0:e7e920b85676 48 (defined(G_BYTE_ORDER) && (G_BYTE_ORDER == G_BIG_ENDIAN)) /* IAR */ || \
cparata 0:e7e920b85676 49 (defined(__BIG_ENDIAN)) /* ARM */
cparata 0:e7e920b85676 50 #define __DEV_SPI_BIG_ENDIAN
cparata 0:e7e920b85676 51 #endif
cparata 0:e7e920b85676 52
cparata 0:e7e920b85676 53 /* Classes -------------------------------------------------------------------*/
cparata 0:e7e920b85676 54 /** Helper class DevSPI providing functions for synchronous SPI communication
cparata 0:e7e920b85676 55 * common for a series of SPI devices.
cparata 0:e7e920b85676 56 */
cparata 0:e7e920b85676 57 class DevSPI : public SPI
cparata 0:e7e920b85676 58 {
cparata 0:e7e920b85676 59 public:
cparata 0:e7e920b85676 60 /*
cparata 0:e7e920b85676 61 * Create a DevSPI interface.
cparata 0:e7e920b85676 62 * @param mosi pin name of the MOSI pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 63 * @param miso pin name of the MISO pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 64 * @param sclk pin name of the SCLK pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 65 */
cparata 0:e7e920b85676 66 DevSPI(PinName mosi, PinName miso, PinName sclk) : SPI(mosi, miso, sclk)
cparata 0:e7e920b85676 67 {
cparata 0:e7e920b85676 68 /* Set default configuration. */
cparata 0:e7e920b85676 69 setup(8, 3, 1E6);
cparata 0:e7e920b85676 70 }
cparata 0:e7e920b85676 71
cparata 0:e7e920b85676 72 /*
cparata 0:e7e920b85676 73 * Setup the spi.
cparata 0:e7e920b85676 74 * Typically:
cparata 0:e7e920b85676 75 * + 8 bit data;
cparata 0:e7e920b85676 76 * + high steady state clock;
cparata 0:e7e920b85676 77 * + second edge capture;
cparata 0:e7e920b85676 78 * + 1MHz clock rate.
cparata 0:e7e920b85676 79 *
cparata 0:e7e920b85676 80 * @param bits Number of bits per SPI frame (4 - 16)
cparata 0:e7e920b85676 81 * @param mode Clock polarity and phase mode (0 - 3)
cparata 0:e7e920b85676 82 * @param frequency_hz SCLK frequency in hz (default = 1MHz)
cparata 0:e7e920b85676 83 *
cparata 0:e7e920b85676 84 * @code
cparata 0:e7e920b85676 85 * mode | POL PHA
cparata 0:e7e920b85676 86 * -----+--------
cparata 0:e7e920b85676 87 * 0 | 0 0
cparata 0:e7e920b85676 88 * 1 | 0 1
cparata 0:e7e920b85676 89 * 2 | 1 0
cparata 0:e7e920b85676 90 * 3 | 1 1
cparata 0:e7e920b85676 91 * @endcode
cparata 0:e7e920b85676 92 */
cparata 0:e7e920b85676 93 void setup(int bits, int mode = 0, int frequency_hz = 1E6)
cparata 0:e7e920b85676 94 {
cparata 0:e7e920b85676 95 /* Set given configuration. */
cparata 0:e7e920b85676 96 format(bits, mode);
cparata 0:e7e920b85676 97 frequency(frequency_hz);
cparata 0:e7e920b85676 98 }
cparata 0:e7e920b85676 99
cparata 0:e7e920b85676 100 /**
cparata 0:e7e920b85676 101 * @brief Writes a buffer to the SPI peripheral device in 8-bit data mode
cparata 0:e7e920b85676 102 * using synchronous SPI communication.
cparata 0:e7e920b85676 103 * @param[in] pBuffer pointer to the buffer of data to send.
cparata 0:e7e920b85676 104 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 105 * @param[in] NumBytesToWrite number of bytes to write.
cparata 0:e7e920b85676 106 * @retval 0 if ok.
cparata 0:e7e920b85676 107 * @retval -1 if data format error.
cparata 0:e7e920b85676 108 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 109 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 110 */
cparata 0:e7e920b85676 111 int spi_write(uint8_t* pBuffer, DigitalOut &ssel, uint16_t NumBytesToWrite)
cparata 0:e7e920b85676 112 {
cparata 0:e7e920b85676 113 /* Check data format */
cparata 0:e7e920b85676 114 if(_bits != 8) return -1;
cparata 0:e7e920b85676 115
cparata 0:e7e920b85676 116 /* Select the chip. */
cparata 0:e7e920b85676 117 ssel = 0;
cparata 0:e7e920b85676 118
cparata 0:e7e920b85676 119 /* Write data. */
cparata 0:e7e920b85676 120 for (int i = 0; i < NumBytesToWrite; i++) {
cparata 0:e7e920b85676 121 write(pBuffer[i]);
cparata 0:e7e920b85676 122 }
cparata 0:e7e920b85676 123
cparata 0:e7e920b85676 124 /* Unselect the chip. */
cparata 0:e7e920b85676 125 ssel = 1;
cparata 0:e7e920b85676 126
cparata 0:e7e920b85676 127 return 0;
cparata 0:e7e920b85676 128 }
cparata 0:e7e920b85676 129
cparata 0:e7e920b85676 130 /**
cparata 0:e7e920b85676 131 * @brief Reads a buffer from the SPI peripheral device in 8-bit data mode
cparata 0:e7e920b85676 132 * using synchronous SPI communication.
cparata 0:e7e920b85676 133 * @param[out] pBuffer pointer to the buffer to read data into.
cparata 0:e7e920b85676 134 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 135 * @param[in] NumBytesToRead number of bytes to read.
cparata 0:e7e920b85676 136 * @retval 0 if ok.
cparata 0:e7e920b85676 137 * @retval -1 if data format error.
cparata 0:e7e920b85676 138 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 139 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 140 */
cparata 0:e7e920b85676 141 int spi_read(uint8_t* pBuffer, DigitalOut &ssel, uint16_t NumBytesToRead)
cparata 0:e7e920b85676 142 {
cparata 0:e7e920b85676 143 /* Check data format */
cparata 0:e7e920b85676 144 if(_bits != 8) return -1;
cparata 0:e7e920b85676 145
cparata 0:e7e920b85676 146 /* Select the chip. */
cparata 0:e7e920b85676 147 ssel = 0;
cparata 0:e7e920b85676 148
cparata 0:e7e920b85676 149 /* Read data. */
cparata 0:e7e920b85676 150 for (int i = 0; i < NumBytesToRead; i++) {
cparata 0:e7e920b85676 151 pBuffer[i] = write(0);
cparata 0:e7e920b85676 152 }
cparata 0:e7e920b85676 153
cparata 0:e7e920b85676 154 /* Unselect the chip. */
cparata 0:e7e920b85676 155 ssel = 1;
cparata 0:e7e920b85676 156
cparata 0:e7e920b85676 157 return 0;
cparata 0:e7e920b85676 158 }
cparata 0:e7e920b85676 159
cparata 0:e7e920b85676 160 /**
cparata 0:e7e920b85676 161 * @brief Reads and write a buffer from/to the SPI peripheral device at the same time
cparata 0:e7e920b85676 162 * in 8-bit data mode using synchronous SPI communication.
cparata 0:e7e920b85676 163 * @param[out] pBufferToRead pointer to the buffer to read data into.
cparata 0:e7e920b85676 164 * @param[in] pBufferToWrite pointer to the buffer of data to send.
cparata 0:e7e920b85676 165 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 166 * @param[in] NumBytes number of bytes to read and write.
cparata 0:e7e920b85676 167 * @retval 0 if ok.
cparata 0:e7e920b85676 168 * @retval -1 if data format error.
cparata 0:e7e920b85676 169 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 170 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 171 */
cparata 0:e7e920b85676 172 int spi_read_write(uint8_t* pBufferToRead, uint8_t* pBufferToWrite, DigitalOut &ssel, uint16_t NumBytes)
cparata 0:e7e920b85676 173 {
cparata 0:e7e920b85676 174 /* Check data format */
cparata 0:e7e920b85676 175 if(_bits != 8) return -1;
cparata 0:e7e920b85676 176
cparata 0:e7e920b85676 177 /* Select the chip. */
cparata 0:e7e920b85676 178 ssel = 0;
cparata 0:e7e920b85676 179
cparata 0:e7e920b85676 180 /* Read and write data at the same time. */
cparata 0:e7e920b85676 181 for (int i = 0; i < NumBytes; i++) {
cparata 0:e7e920b85676 182 pBufferToRead[i] = write(pBufferToWrite[i]);
cparata 0:e7e920b85676 183 }
cparata 0:e7e920b85676 184
cparata 0:e7e920b85676 185 /* Unselect the chip. */
cparata 0:e7e920b85676 186 ssel = 1;
cparata 0:e7e920b85676 187
cparata 0:e7e920b85676 188 return 0;
cparata 0:e7e920b85676 189 }
cparata 0:e7e920b85676 190
cparata 0:e7e920b85676 191 /**
cparata 0:e7e920b85676 192 * @brief Writes a buffer to the SPI peripheral device in 16-bit data mode
cparata 0:e7e920b85676 193 * using synchronous SPI communication.
cparata 0:e7e920b85676 194 * @param[in] pBuffer pointer to the buffer of data to send.
cparata 0:e7e920b85676 195 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 196 * @param[in] NumValuesToWrite number of 16-bit values to write.
cparata 0:e7e920b85676 197 * @retval 0 if ok.
cparata 0:e7e920b85676 198 * @retval -1 if data format error.
cparata 0:e7e920b85676 199 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 200 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 201 * @note In order to guarantee this method to work correctly you have to
cparata 0:e7e920b85676 202 * pass buffers which are correctly aligned.
cparata 0:e7e920b85676 203 */
cparata 0:e7e920b85676 204 int spi_write(uint16_t* pBuffer, DigitalOut &ssel, uint16_t NumValuesToWrite)
cparata 0:e7e920b85676 205 {
cparata 0:e7e920b85676 206 /* Check data format */
cparata 0:e7e920b85676 207 if(_bits != 16) return -1;
cparata 0:e7e920b85676 208
cparata 0:e7e920b85676 209 /* Select the chip. */
cparata 0:e7e920b85676 210 ssel = 0;
cparata 0:e7e920b85676 211
cparata 0:e7e920b85676 212 /* Write data. */
cparata 0:e7e920b85676 213 for (int i = 0; i < NumValuesToWrite; i++) {
cparata 0:e7e920b85676 214 write(htons(pBuffer[i]));
cparata 0:e7e920b85676 215 }
cparata 0:e7e920b85676 216
cparata 0:e7e920b85676 217 /* Unselect the chip. */
cparata 0:e7e920b85676 218 ssel = 1;
cparata 0:e7e920b85676 219
cparata 0:e7e920b85676 220 return 0;
cparata 0:e7e920b85676 221 }
cparata 0:e7e920b85676 222
cparata 0:e7e920b85676 223 /**
cparata 0:e7e920b85676 224 * @brief Reads a buffer from the SPI peripheral device in 16-bit data mode
cparata 0:e7e920b85676 225 * using synchronous SPI communication.
cparata 0:e7e920b85676 226 * @param[out] pBuffer pointer to the buffer to read data into.
cparata 0:e7e920b85676 227 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 228 * @param[in] NumValuesToRead number of 16-bit values to read.
cparata 0:e7e920b85676 229 * @retval 0 if ok.
cparata 0:e7e920b85676 230 * @retval -1 if data format error.
cparata 0:e7e920b85676 231 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 232 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 233 * @note In order to guarantee this method to work correctly you have to
cparata 0:e7e920b85676 234 * pass buffers which are correctly aligned.
cparata 0:e7e920b85676 235 */
cparata 0:e7e920b85676 236 int spi_read(uint16_t* pBuffer, DigitalOut &ssel, uint16_t NumValuesToRead)
cparata 0:e7e920b85676 237 {
cparata 0:e7e920b85676 238 /* Check data format */
cparata 0:e7e920b85676 239 if(_bits != 16) return -1;
cparata 0:e7e920b85676 240
cparata 0:e7e920b85676 241 /* Select the chip. */
cparata 0:e7e920b85676 242 ssel = 0;
cparata 0:e7e920b85676 243
cparata 0:e7e920b85676 244 /* Read data. */
cparata 0:e7e920b85676 245 for (int i = 0; i < NumValuesToRead; i++) {
cparata 0:e7e920b85676 246 pBuffer[i] = ntohs((uint16_t)write(0));
cparata 0:e7e920b85676 247 }
cparata 0:e7e920b85676 248
cparata 0:e7e920b85676 249 /* Unselect the chip. */
cparata 0:e7e920b85676 250 ssel = 1;
cparata 0:e7e920b85676 251
cparata 0:e7e920b85676 252 return 0;
cparata 0:e7e920b85676 253 }
cparata 0:e7e920b85676 254
cparata 0:e7e920b85676 255 /**
cparata 0:e7e920b85676 256 * @brief Reads and write a buffer from/to the SPI peripheral device at the same time
cparata 0:e7e920b85676 257 * in 16-bit data mode using synchronous SPI communication.
cparata 0:e7e920b85676 258 * @param[out] pBufferToRead pointer to the buffer to read data into.
cparata 0:e7e920b85676 259 * @param[in] pBufferToWrite pointer to the buffer of data to send.
cparata 0:e7e920b85676 260 * @param[in] ssel GPIO of the SSEL pin of the SPI device to be used for communication.
cparata 0:e7e920b85676 261 * @param[in] NumValues number of 16-bit values to read and write.
cparata 0:e7e920b85676 262 * @retval 0 if ok.
cparata 0:e7e920b85676 263 * @retval -1 if data format error.
cparata 0:e7e920b85676 264 * @note When using the SPI in Interrupt-mode, remember to disable interrupts
cparata 0:e7e920b85676 265 * before calling this function and to enable them again after.
cparata 0:e7e920b85676 266 * @note In order to guarantee this method to work correctly you have to
cparata 0:e7e920b85676 267 * pass buffers which are correctly aligned.
cparata 0:e7e920b85676 268 */
cparata 0:e7e920b85676 269 int spi_read_write(uint16_t* pBufferToRead, uint16_t* pBufferToWrite, DigitalOut &ssel, uint16_t NumValues)
cparata 0:e7e920b85676 270 {
cparata 0:e7e920b85676 271 /* Check data format */
cparata 0:e7e920b85676 272 if(_bits != 16) return -1;
cparata 0:e7e920b85676 273
cparata 0:e7e920b85676 274 /* Select the chip. */
cparata 0:e7e920b85676 275 ssel = 0;
cparata 0:e7e920b85676 276
cparata 0:e7e920b85676 277 /* Read and write data at the same time. */
cparata 0:e7e920b85676 278 for (int i = 0; i < NumValues; i++) {
cparata 0:e7e920b85676 279 pBufferToRead[i] = ntohs((uint16_t)write(htons(pBufferToWrite[i])));
cparata 0:e7e920b85676 280 }
cparata 0:e7e920b85676 281
cparata 0:e7e920b85676 282 /* Unselect the chip. */
cparata 0:e7e920b85676 283 ssel = 1;
cparata 0:e7e920b85676 284
cparata 0:e7e920b85676 285 return 0;
cparata 0:e7e920b85676 286 }
cparata 0:e7e920b85676 287
cparata 0:e7e920b85676 288 protected:
cparata 0:e7e920b85676 289 inline uint16_t htons(uint16_t x) {
cparata 0:e7e920b85676 290 #ifndef __DEV_SPI_BIG_ENDIAN
cparata 0:e7e920b85676 291 return (((x)<<8)|((x)>>8));
cparata 0:e7e920b85676 292 #else // __DEV_SPI_BIG_ENDIAN
cparata 0:e7e920b85676 293 return (x);
cparata 0:e7e920b85676 294 #endif // __DEV_SPI_BIG_ENDIAN
cparata 0:e7e920b85676 295 }
cparata 0:e7e920b85676 296
cparata 0:e7e920b85676 297 inline uint16_t ntohs(uint16_t x) {
cparata 0:e7e920b85676 298 return htons(x);
cparata 0:e7e920b85676 299 }
cparata 0:e7e920b85676 300 };
cparata 0:e7e920b85676 301
cparata 0:e7e920b85676 302 #endif /* __DEV_SPI_H */