ST / Mbed 2 deprecated WakeUp_IKS01A2

Example of wake up detection for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of WakeUp_IKS01A2 by ST Expansion SW Team

Wake up Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

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

X_NUCLEO_IKS01A2/Components/HTS221Sensor/HTS221Sensor.cpp@0:e7e920b85676, 2016-08-12 (annotated)

Committer:
cparata
Date:
Fri Aug 12 13:43:40 2016 +0000
Revision:
0:e7e920b85676
First release of Wake-Up Detection for LSM6DSL in IKS01A2

Who changed what in which revision?

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