Jim Carver / Mbed OS pelion-workshop

Workshop example

Dependencies:   X_NUCLEO_COMMON ST_INTERFACES

sensors/HTS221/HTS221Sensor.cpp@35:42b3fba640b1, 2019-05-21 (annotated)

Committer:
JimCarver
Date:
Tue May 21 21:16:24 2019 +0000
Revision:
35:42b3fba640b1
Parent:
18:a15bfe7aaebd 
Simple version for workshop

Who changed what in which revision?

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