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/Components/HTS221Sensor/HTS221Sensor.cpp@0:69566eea0fba, 2016-08-12 (annotated)

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