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/Components/HTS221Sensor/HTS221Sensor.cpp@2:8308cb42bc49, 2016-08-19 (annotated)

Committer:
cparata
Date:
Fri Aug 19 12:26:01 2016 +0000
Revision:
2:8308cb42bc49
Add interfaces to all components

Who changed what in which revision?

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