ST / Mbed 2 deprecated Tilt_IKS01A2

Example of tilt detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of Tilt_IKS01A2 by ST Expansion SW Team

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

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

X_NUCLEO_IKS01A2/X_NUCLEO_COMMON/DevSPI/DevSPI.h@2:39ad2a393143, 2016-08-19 (annotated)

Committer:
cparata
Date:
Fri Aug 19 12:34:01 2016 +0000
Revision:
2:39ad2a393143
Parent:
0:489965565a0d 
Add interfaces to all components

Who changed what in which revision?

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