ST / Mbed 2 deprecated Pedometer_IKS01A2

Example of pedometer for LSM6DSL in X-NUCLEO-IKS01A2

Dependencies:   X_NUCLEO_IKS01A2 mbed

Fork of Pedometer_IKS01A2 by ST Expansion SW Team

Pedometer Demo Application based on sensor expansion board X-NUCLEO-IKS01A2

Main function is to show how to count steps 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 to simulate the steps and then view the notification using an hyper terminal. When a new step is detected, the LED is switched on for a while.
- the user button can be used to reset the step counter.

X_NUCLEO_IKS01A2/Components/HTS221Sensor/HTS221Sensor.cpp@2:67af0ad3ea2e, 2016-08-19 (annotated)

Committer:
cparata
Date:
Fri Aug 19 12:29:08 2016 +0000
Revision:
2:67af0ad3ea2e
Add interfaces to all components

Who changed what in which revision?

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