ST / Mbed 2 deprecated FreeFall_IKS01A2

Example of free fall detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of FreeFall_IKS01A2 by ST Expansion SW Team

Free Fall Detection Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to detect the free fall 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 leave falling the board and then view the notification using an hyper terminal. When the free fall is detected, the LED is switched on for a while.
- the user button can be used to enable/disable the free fall detection feature.

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

Committer:
cparata
Date:
Fri Aug 12 13:39:06 2016 +0000
Revision:
0:6a670fda63c2
First release of Free Fall for LSM6DSL in IKS01A2

Who changed what in which revision?

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