ST / Mbed 2 deprecated HelloWorld_IKS01A2

Example of hello world for X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of HelloWorld_IKS01A2 by ST Expansion SW Team

Hello World Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to get humidity, temperature, pressure, accelerometer, magnetomer and gyroscope data using the sensor expansion board and send them using UART to a connected PC or Desktop and display it on terminal applications like TeraTerm.

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

Committer:
cparata
Date:
Fri Aug 12 13:40:12 2016 +0000
Revision:
0:69566eea0fba
First release of Hello World for IKS01A2

Who changed what in which revision?

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