ST / Mbed 2 deprecated MultiEvent_IKS01A2

Example of multiple event detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of MultiEvent_IKS01A2 by ST Expansion SW Team

Multi Event Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to detect the free fall, tap, double tap, tilt, wake up, 6D Orientation and step events 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 simulate all the events and then view the notification using an hyper terminal.
- the user button can be used to enable/disable all hardware features.

X_NUCLEO_IKS01A2/Components/HTS221Sensor/HTS221Sensor.cpp@0:763b80993db4, 2016-11-24 (annotated)

Committer:
cparata
Date:
Thu Nov 24 15:42:24 2016 +0000
Revision:
0:763b80993db4
Add multi event example

Who changed what in which revision?

UserRevisionLine numberNew contents of line
cparata 0:763b80993db4 1 /**
cparata 0:763b80993db4 2 ******************************************************************************
cparata 0:763b80993db4 3 * @file HTS221Sensor.cpp
cparata 0:763b80993db4 4 * @author AST
cparata 0:763b80993db4 5 * @version V1.0.0
cparata 0:763b80993db4 6 * @date 5 August 2016
cparata 0:763b80993db4 7 * @brief Implementation of an HTS221 Humidity and Temperature sensor.
cparata 0:763b80993db4 8 ******************************************************************************
cparata 0:763b80993db4 9 * @attention
cparata 0:763b80993db4 10 *
cparata 0:763b80993db4 11 * <h2><center>&copy; COPYRIGHT(c) 2016 STMicroelectronics</center></h2>
cparata 0:763b80993db4 12 *
cparata 0:763b80993db4 13 * Redistribution and use in source and binary forms, with or without modification,
cparata 0:763b80993db4 14 * are permitted provided that the following conditions are met:
cparata 0:763b80993db4 15 * 1. Redistributions of source code must retain the above copyright notice,
cparata 0:763b80993db4 16 * this list of conditions and the following disclaimer.
cparata 0:763b80993db4 17 * 2. Redistributions in binary form must reproduce the above copyright notice,
cparata 0:763b80993db4 18 * this list of conditions and the following disclaimer in the documentation
cparata 0:763b80993db4 19 * and/or other materials provided with the distribution.
cparata 0:763b80993db4 20 * 3. Neither the name of STMicroelectronics nor the names of its contributors
cparata 0:763b80993db4 21 * may be used to endorse or promote products derived from this software
cparata 0:763b80993db4 22 * without specific prior written permission.
cparata 0:763b80993db4 23 *
cparata 0:763b80993db4 24 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
cparata 0:763b80993db4 25 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
cparata 0:763b80993db4 26 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
cparata 0:763b80993db4 27 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
cparata 0:763b80993db4 28 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
cparata 0:763b80993db4 29 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
cparata 0:763b80993db4 30 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
cparata 0:763b80993db4 31 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
cparata 0:763b80993db4 32 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
cparata 0:763b80993db4 33 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
cparata 0:763b80993db4 34 *
cparata 0:763b80993db4 35 ******************************************************************************
cparata 0:763b80993db4 36 */
cparata 0:763b80993db4 37
cparata 0:763b80993db4 38
cparata 0:763b80993db4 39 /* Includes ------------------------------------------------------------------*/
cparata 0:763b80993db4 40
cparata 0:763b80993db4 41 #include "mbed.h"
cparata 0:763b80993db4 42 #include "DevI2C.h"
cparata 0:763b80993db4 43 #include "HTS221Sensor.h"
cparata 0:763b80993db4 44 #include "HTS221_Driver.h"
cparata 0:763b80993db4 45
cparata 0:763b80993db4 46
cparata 0:763b80993db4 47 /* Class Implementation ------------------------------------------------------*/
cparata 0:763b80993db4 48
cparata 0:763b80993db4 49 /** Constructor
cparata 0:763b80993db4 50 * @param i2c object of an helper class which handles the I2C peripheral
cparata 0:763b80993db4 51 * @param address the address of the component's instance
cparata 0:763b80993db4 52 */
cparata 0:763b80993db4 53 HTS221Sensor::HTS221Sensor(DevI2C &i2c) : dev_i2c(i2c)
cparata 0:763b80993db4 54 {
cparata 0:763b80993db4 55 address = HTS221_I2C_ADDRESS;
cparata 0:763b80993db4 56 };
cparata 0:763b80993db4 57
cparata 0:763b80993db4 58
cparata 0:763b80993db4 59 /** Constructor
cparata 0:763b80993db4 60 * @param i2c object of an helper class which handles the I2C peripheral
cparata 0:763b80993db4 61 * @param address the address of the component's instance
cparata 0:763b80993db4 62 */
cparata 0:763b80993db4 63 HTS221Sensor::HTS221Sensor(DevI2C &i2c, uint8_t address) : dev_i2c(i2c), address(address)
cparata 0:763b80993db4 64 {
cparata 0:763b80993db4 65
cparata 0:763b80993db4 66 };
cparata 0:763b80993db4 67
cparata 0:763b80993db4 68 /**
cparata 0:763b80993db4 69 * @brief Initializing the component.
cparata 0:763b80993db4 70 * @param[in] init pointer to device specific initalization structure.
cparata 0:763b80993db4 71 * @retval "0" in case of success, an error code otherwise.
cparata 0:763b80993db4 72 */
cparata 0:763b80993db4 73 int HTS221Sensor::Init(void *init)
cparata 0:763b80993db4 74 {
cparata 0:763b80993db4 75 /* Power down the device */
cparata 0:763b80993db4 76 if ( HTS221_DeActivate( (void *)this ) == HTS221_ERROR )
cparata 0:763b80993db4 77 {
cparata 0:763b80993db4 78 return 1;
cparata 0:763b80993db4 79 }
cparata 0:763b80993db4 80
cparata 0:763b80993db4 81 /* Enable BDU */
cparata 0:763b80993db4 82 if ( HTS221_Set_BduMode( (void *)this, HTS221_ENABLE ) == HTS221_ERROR )
cparata 0:763b80993db4 83 {
cparata 0:763b80993db4 84 return 1;
cparata 0:763b80993db4 85 }
cparata 0:763b80993db4 86
cparata 0:763b80993db4 87 if(Set_ODR(1.0f) == 1)
cparata 0:763b80993db4 88 {
cparata 0:763b80993db4 89 return 1;
cparata 0:763b80993db4 90 }
cparata 0:763b80993db4 91
cparata 0:763b80993db4 92 return 0;
cparata 0:763b80993db4 93 }
cparata 0:763b80993db4 94
cparata 0:763b80993db4 95 /**
cparata 0:763b80993db4 96 * @brief Enable HTS221
cparata 0:763b80993db4 97 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 98 */
cparata 0:763b80993db4 99 int HTS221Sensor::Enable(void)
cparata 0:763b80993db4 100 {
cparata 0:763b80993db4 101 /* Power up the device */
cparata 0:763b80993db4 102 if ( HTS221_Activate( (void *)this ) == HTS221_ERROR )
cparata 0:763b80993db4 103 {
cparata 0:763b80993db4 104 return 1;
cparata 0:763b80993db4 105 }
cparata 0:763b80993db4 106
cparata 0:763b80993db4 107 return 0;
cparata 0:763b80993db4 108 }
cparata 0:763b80993db4 109
cparata 0:763b80993db4 110 /**
cparata 0:763b80993db4 111 * @brief Disable HTS221
cparata 0:763b80993db4 112 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 113 */
cparata 0:763b80993db4 114 int HTS221Sensor::Disable(void)
cparata 0:763b80993db4 115 {
cparata 0:763b80993db4 116 /* Power up the device */
cparata 0:763b80993db4 117 if ( HTS221_DeActivate( (void *)this ) == HTS221_ERROR )
cparata 0:763b80993db4 118 {
cparata 0:763b80993db4 119 return 1;
cparata 0:763b80993db4 120 }
cparata 0:763b80993db4 121
cparata 0:763b80993db4 122 return 0;
cparata 0:763b80993db4 123 }
cparata 0:763b80993db4 124
cparata 0:763b80993db4 125 /**
cparata 0:763b80993db4 126 * @brief Read ID address of HTS221
cparata 0:763b80993db4 127 * @param id the pointer where the ID of the device is stored
cparata 0:763b80993db4 128 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 129 */
cparata 0:763b80993db4 130 int HTS221Sensor::ReadID(uint8_t *id)
cparata 0:763b80993db4 131 {
cparata 0:763b80993db4 132 if(!id)
cparata 0:763b80993db4 133 {
cparata 0:763b80993db4 134 return 1;
cparata 0:763b80993db4 135 }
cparata 0:763b80993db4 136
cparata 0:763b80993db4 137 /* Read WHO AM I register */
cparata 0:763b80993db4 138 if ( HTS221_Get_DeviceID( (void *)this, id ) == HTS221_ERROR )
cparata 0:763b80993db4 139 {
cparata 0:763b80993db4 140 return 1;
cparata 0:763b80993db4 141 }
cparata 0:763b80993db4 142
cparata 0:763b80993db4 143 return 0;
cparata 0:763b80993db4 144 }
cparata 0:763b80993db4 145
cparata 0:763b80993db4 146 /**
cparata 0:763b80993db4 147 * @brief Reboot memory content of HTS221
cparata 0:763b80993db4 148 * @param None
cparata 0:763b80993db4 149 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 150 */
cparata 0:763b80993db4 151 int HTS221Sensor::Reset(void)
cparata 0:763b80993db4 152 {
cparata 0:763b80993db4 153 uint8_t tmpreg;
cparata 0:763b80993db4 154
cparata 0:763b80993db4 155 /* Read CTRL_REG2 register */
cparata 0:763b80993db4 156 if (ReadReg(HTS221_CTRL_REG2, &tmpreg) != 0)
cparata 0:763b80993db4 157 {
cparata 0:763b80993db4 158 return 1;
cparata 0:763b80993db4 159 }
cparata 0:763b80993db4 160
cparata 0:763b80993db4 161 /* Enable or Disable the reboot memory */
cparata 0:763b80993db4 162 tmpreg |= (0x01 << HTS221_BOOT_BIT);
cparata 0:763b80993db4 163
cparata 0:763b80993db4 164 /* Write value to MEMS CTRL_REG2 regsister */
cparata 0:763b80993db4 165 if (WriteReg(HTS221_CTRL_REG2, tmpreg) != 0)
cparata 0:763b80993db4 166 {
cparata 0:763b80993db4 167 return 1;
cparata 0:763b80993db4 168 }
cparata 0:763b80993db4 169
cparata 0:763b80993db4 170 return 0;
cparata 0:763b80993db4 171 }
cparata 0:763b80993db4 172
cparata 0:763b80993db4 173 /**
cparata 0:763b80993db4 174 * @brief Read HTS221 output register, and calculate the humidity
cparata 0:763b80993db4 175 * @param pfData the pointer to data output
cparata 0:763b80993db4 176 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 177 */
cparata 0:763b80993db4 178 int HTS221Sensor::GetHumidity(float* pfData)
cparata 0:763b80993db4 179 {
cparata 0:763b80993db4 180 uint16_t uint16data = 0;
cparata 0:763b80993db4 181
cparata 0:763b80993db4 182 /* Read data from HTS221. */
cparata 0:763b80993db4 183 if ( HTS221_Get_Humidity( (void *)this, &uint16data ) == HTS221_ERROR )
cparata 0:763b80993db4 184 {
cparata 0:763b80993db4 185 return 1;
cparata 0:763b80993db4 186 }
cparata 0:763b80993db4 187
cparata 0:763b80993db4 188 *pfData = ( float )uint16data / 10.0f;
cparata 0:763b80993db4 189
cparata 0:763b80993db4 190 return 0;
cparata 0:763b80993db4 191 }
cparata 0:763b80993db4 192
cparata 0:763b80993db4 193 /**
cparata 0:763b80993db4 194 * @brief Read HTS221 output register, and calculate the temperature
cparata 0:763b80993db4 195 * @param pfData the pointer to data output
cparata 0:763b80993db4 196 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 197 */
cparata 0:763b80993db4 198 int HTS221Sensor::GetTemperature(float* pfData)
cparata 0:763b80993db4 199 {
cparata 0:763b80993db4 200 int16_t int16data = 0;
cparata 0:763b80993db4 201
cparata 0:763b80993db4 202 /* Read data from HTS221. */
cparata 0:763b80993db4 203 if ( HTS221_Get_Temperature( (void *)this, &int16data ) == HTS221_ERROR )
cparata 0:763b80993db4 204 {
cparata 0:763b80993db4 205 return 1;
cparata 0:763b80993db4 206 }
cparata 0:763b80993db4 207
cparata 0:763b80993db4 208 *pfData = ( float )int16data / 10.0f;
cparata 0:763b80993db4 209
cparata 0:763b80993db4 210 return 0;
cparata 0:763b80993db4 211 }
cparata 0:763b80993db4 212
cparata 0:763b80993db4 213 /**
cparata 0:763b80993db4 214 * @brief Read HTS221 output register, and calculate the humidity
cparata 0:763b80993db4 215 * @param odr the pointer to the output data rate
cparata 0:763b80993db4 216 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 217 */
cparata 0:763b80993db4 218 int HTS221Sensor::Get_ODR(float* odr)
cparata 0:763b80993db4 219 {
cparata 0:763b80993db4 220 HTS221_Odr_et odr_low_level;
cparata 0:763b80993db4 221
cparata 0:763b80993db4 222 if ( HTS221_Get_Odr( (void *)this, &odr_low_level ) == HTS221_ERROR )
cparata 0:763b80993db4 223 {
cparata 0:763b80993db4 224 return 1;
cparata 0:763b80993db4 225 }
cparata 0:763b80993db4 226
cparata 0:763b80993db4 227 switch( odr_low_level )
cparata 0:763b80993db4 228 {
cparata 0:763b80993db4 229 case HTS221_ODR_ONE_SHOT:
cparata 0:763b80993db4 230 *odr = 0.0f;
cparata 0:763b80993db4 231 break;
cparata 0:763b80993db4 232 case HTS221_ODR_1HZ :
cparata 0:763b80993db4 233 *odr = 1.0f;
cparata 0:763b80993db4 234 break;
cparata 0:763b80993db4 235 case HTS221_ODR_7HZ :
cparata 0:763b80993db4 236 *odr = 7.0f;
cparata 0:763b80993db4 237 break;
cparata 0:763b80993db4 238 case HTS221_ODR_12_5HZ :
cparata 0:763b80993db4 239 *odr = 12.5f;
cparata 0:763b80993db4 240 break;
cparata 0:763b80993db4 241 default :
cparata 0:763b80993db4 242 *odr = -1.0f;
cparata 0:763b80993db4 243 return 1;
cparata 0:763b80993db4 244 }
cparata 0:763b80993db4 245
cparata 0:763b80993db4 246 return 0;
cparata 0:763b80993db4 247 }
cparata 0:763b80993db4 248
cparata 0:763b80993db4 249 /**
cparata 0:763b80993db4 250 * @brief Set ODR
cparata 0:763b80993db4 251 * @param odr the output data rate to be set
cparata 0:763b80993db4 252 * @retval 0 in case of success, an error code otherwise
cparata 0:763b80993db4 253 */
cparata 0:763b80993db4 254 int HTS221Sensor::Set_ODR(float odr)
cparata 0:763b80993db4 255 {
cparata 0:763b80993db4 256 HTS221_Odr_et new_odr;
cparata 0:763b80993db4 257
cparata 0:763b80993db4 258 new_odr = ( odr <= 1.0f ) ? HTS221_ODR_1HZ
cparata 0:763b80993db4 259 : ( odr <= 7.0f ) ? HTS221_ODR_7HZ
cparata 0:763b80993db4 260 : HTS221_ODR_12_5HZ;
cparata 0:763b80993db4 261
cparata 0:763b80993db4 262 if ( HTS221_Set_Odr( (void *)this, new_odr ) == HTS221_ERROR )
cparata 0:763b80993db4 263 {
cparata 0:763b80993db4 264 return 1;
cparata 0:763b80993db4 265 }
cparata 0:763b80993db4 266
cparata 0:763b80993db4 267 return 0;
cparata 0:763b80993db4 268 }
cparata 0:763b80993db4 269
cparata 0:763b80993db4 270
cparata 0:763b80993db4 271 /**
cparata 0:763b80993db4 272 * @brief Read the data from register
cparata 0:763b80993db4 273 * @param reg register address
cparata 0:763b80993db4 274 * @param data register data
cparata 0:763b80993db4 275 * @retval 0 in case of success
cparata 0:763b80993db4 276 * @retval 1 in case of failure
cparata 0:763b80993db4 277 */
cparata 0:763b80993db4 278 int HTS221Sensor::ReadReg( uint8_t reg, uint8_t *data )
cparata 0:763b80993db4 279 {
cparata 0:763b80993db4 280
cparata 0:763b80993db4 281 if ( HTS221_ReadReg( (void *)this, reg, 1, data ) == HTS221_ERROR )
cparata 0:763b80993db4 282 {
cparata 0:763b80993db4 283 return 1;
cparata 0:763b80993db4 284 }
cparata 0:763b80993db4 285
cparata 0:763b80993db4 286 return 0;
cparata 0:763b80993db4 287 }
cparata 0:763b80993db4 288
cparata 0:763b80993db4 289 /**
cparata 0:763b80993db4 290 * @brief Write the data to register
cparata 0:763b80993db4 291 * @param reg register address
cparata 0:763b80993db4 292 * @param data register data
cparata 0:763b80993db4 293 * @retval 0 in case of success
cparata 0:763b80993db4 294 * @retval 1 in case of failure
cparata 0:763b80993db4 295 */
cparata 0:763b80993db4 296 int HTS221Sensor::WriteReg( uint8_t reg, uint8_t data )
cparata 0:763b80993db4 297 {
cparata 0:763b80993db4 298
cparata 0:763b80993db4 299 if ( HTS221_WriteReg( (void *)this, reg, 1, &data ) == HTS221_ERROR )
cparata 0:763b80993db4 300 {
cparata 0:763b80993db4 301 return 1;
cparata 0:763b80993db4 302 }
cparata 0:763b80993db4 303
cparata 0:763b80993db4 304 return 0;
cparata 0:763b80993db4 305 }
cparata 0:763b80993db4 306
cparata 0:763b80993db4 307 uint8_t HTS221_IO_Write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite )
cparata 0:763b80993db4 308 {
cparata 0:763b80993db4 309 return ((HTS221Sensor *)handle)->IO_Write(pBuffer, WriteAddr, nBytesToWrite);
cparata 0:763b80993db4 310 }
cparata 0:763b80993db4 311
cparata 0:763b80993db4 312 uint8_t HTS221_IO_Read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead )
cparata 0:763b80993db4 313 {
cparata 0:763b80993db4 314 return ((HTS221Sensor *)handle)->IO_Read(pBuffer, ReadAddr, nBytesToRead);
cparata 0:763b80993db4 315 }