HTS221 relative humidity and temperature sensor library
Dependencies: X_NUCLEO_COMMON ST_INTERFACES
HTS221Sensor.h@0:7917d6d00a6e, 2017-09-04 (annotated)
- Committer:
- nikapov
- Date:
- Mon Sep 04 16:06:23 2017 +0000
- Revision:
- 0:7917d6d00a6e
- Child:
- 1:c4391f20553e
First version.
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
nikapov | 0:7917d6d00a6e | 1 | /** |
nikapov | 0:7917d6d00a6e | 2 | ****************************************************************************** |
nikapov | 0:7917d6d00a6e | 3 | * @file HTS221Sensor.h |
nikapov | 0:7917d6d00a6e | 4 | * @author CLab |
nikapov | 0:7917d6d00a6e | 5 | * @version V1.0.0 |
nikapov | 0:7917d6d00a6e | 6 | * @date 5 August 2016 |
nikapov | 0:7917d6d00a6e | 7 | * @brief Abstract class of an HTS221 Humidity and Temperature sensor. |
nikapov | 0:7917d6d00a6e | 8 | ****************************************************************************** |
nikapov | 0:7917d6d00a6e | 9 | * @attention |
nikapov | 0:7917d6d00a6e | 10 | * |
nikapov | 0:7917d6d00a6e | 11 | * <h2><center>© COPYRIGHT(c) 2016 STMicroelectronics</center></h2> |
nikapov | 0:7917d6d00a6e | 12 | * |
nikapov | 0:7917d6d00a6e | 13 | * Redistribution and use in source and binary forms, with or without modification, |
nikapov | 0:7917d6d00a6e | 14 | * are permitted provided that the following conditions are met: |
nikapov | 0:7917d6d00a6e | 15 | * 1. Redistributions of source code must retain the above copyright notice, |
nikapov | 0:7917d6d00a6e | 16 | * this list of conditions and the following disclaimer. |
nikapov | 0:7917d6d00a6e | 17 | * 2. Redistributions in binary form must reproduce the above copyright notice, |
nikapov | 0:7917d6d00a6e | 18 | * this list of conditions and the following disclaimer in the documentation |
nikapov | 0:7917d6d00a6e | 19 | * and/or other materials provided with the distribution. |
nikapov | 0:7917d6d00a6e | 20 | * 3. Neither the name of STMicroelectronics nor the names of its contributors |
nikapov | 0:7917d6d00a6e | 21 | * may be used to endorse or promote products derived from this software |
nikapov | 0:7917d6d00a6e | 22 | * without specific prior written permission. |
nikapov | 0:7917d6d00a6e | 23 | * |
nikapov | 0:7917d6d00a6e | 24 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
nikapov | 0:7917d6d00a6e | 25 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
nikapov | 0:7917d6d00a6e | 26 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
nikapov | 0:7917d6d00a6e | 27 | * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
nikapov | 0:7917d6d00a6e | 28 | * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
nikapov | 0:7917d6d00a6e | 29 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
nikapov | 0:7917d6d00a6e | 30 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
nikapov | 0:7917d6d00a6e | 31 | * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
nikapov | 0:7917d6d00a6e | 32 | * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
nikapov | 0:7917d6d00a6e | 33 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
nikapov | 0:7917d6d00a6e | 34 | * |
nikapov | 0:7917d6d00a6e | 35 | ****************************************************************************** |
nikapov | 0:7917d6d00a6e | 36 | */ |
nikapov | 0:7917d6d00a6e | 37 | |
nikapov | 0:7917d6d00a6e | 38 | |
nikapov | 0:7917d6d00a6e | 39 | /* Prevent recursive inclusion -----------------------------------------------*/ |
nikapov | 0:7917d6d00a6e | 40 | |
nikapov | 0:7917d6d00a6e | 41 | #ifndef __HTS221Sensor_H__ |
nikapov | 0:7917d6d00a6e | 42 | #define __HTS221Sensor_H__ |
nikapov | 0:7917d6d00a6e | 43 | |
nikapov | 0:7917d6d00a6e | 44 | |
nikapov | 0:7917d6d00a6e | 45 | /* Includes ------------------------------------------------------------------*/ |
nikapov | 0:7917d6d00a6e | 46 | |
nikapov | 0:7917d6d00a6e | 47 | #include "DevI2C.h" |
nikapov | 0:7917d6d00a6e | 48 | #include "HTS221_driver.h" |
nikapov | 0:7917d6d00a6e | 49 | #include "HumiditySensor.h" |
nikapov | 0:7917d6d00a6e | 50 | #include "TempSensor.h" |
nikapov | 0:7917d6d00a6e | 51 | |
nikapov | 0:7917d6d00a6e | 52 | |
nikapov | 0:7917d6d00a6e | 53 | /* Class Declaration ---------------------------------------------------------*/ |
nikapov | 0:7917d6d00a6e | 54 | |
nikapov | 0:7917d6d00a6e | 55 | /** |
nikapov | 0:7917d6d00a6e | 56 | * Abstract class of an HTS221 Humidity and Temperature sensor. |
nikapov | 0:7917d6d00a6e | 57 | */ |
nikapov | 0:7917d6d00a6e | 58 | class HTS221Sensor : public HumiditySensor, public TempSensor |
nikapov | 0:7917d6d00a6e | 59 | { |
nikapov | 0:7917d6d00a6e | 60 | public: |
nikapov | 0:7917d6d00a6e | 61 | |
nikapov | 0:7917d6d00a6e | 62 | HTS221Sensor(DevI2C &i2c); |
nikapov | 0:7917d6d00a6e | 63 | HTS221Sensor(DevI2C &i2c, uint8_t address); |
nikapov | 0:7917d6d00a6e | 64 | virtual int init(void *init); |
nikapov | 0:7917d6d00a6e | 65 | virtual int read_id(uint8_t *id); |
nikapov | 0:7917d6d00a6e | 66 | virtual int get_humidity(float *pfData); |
nikapov | 0:7917d6d00a6e | 67 | virtual int get_temperature(float *pfData); |
nikapov | 0:7917d6d00a6e | 68 | int enable(void); |
nikapov | 0:7917d6d00a6e | 69 | int disable(void); |
nikapov | 0:7917d6d00a6e | 70 | int reset(void); |
nikapov | 0:7917d6d00a6e | 71 | int get_odr(float *odr); |
nikapov | 0:7917d6d00a6e | 72 | int set_odr(float odr); |
nikapov | 0:7917d6d00a6e | 73 | int read_reg(uint8_t reg, uint8_t *data); |
nikapov | 0:7917d6d00a6e | 74 | int write_reg(uint8_t reg, uint8_t data); |
nikapov | 0:7917d6d00a6e | 75 | /** |
nikapov | 0:7917d6d00a6e | 76 | * @brief Utility function to read data. |
nikapov | 0:7917d6d00a6e | 77 | * @param pBuffer: pointer to data to be read. |
nikapov | 0:7917d6d00a6e | 78 | * @param RegisterAddr: specifies internal address register to be read. |
nikapov | 0:7917d6d00a6e | 79 | * @param NumByteToRead: number of bytes to be read. |
nikapov | 0:7917d6d00a6e | 80 | * @retval 0 if ok, an error code otherwise. |
nikapov | 0:7917d6d00a6e | 81 | */ |
nikapov | 0:7917d6d00a6e | 82 | uint8_t io_read(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead) |
nikapov | 0:7917d6d00a6e | 83 | { |
nikapov | 0:7917d6d00a6e | 84 | return (uint8_t) _dev_i2c.i2c_read(pBuffer, _address, RegisterAddr, NumByteToRead); |
nikapov | 0:7917d6d00a6e | 85 | } |
nikapov | 0:7917d6d00a6e | 86 | |
nikapov | 0:7917d6d00a6e | 87 | /** |
nikapov | 0:7917d6d00a6e | 88 | * @brief Utility function to write data. |
nikapov | 0:7917d6d00a6e | 89 | * @param pBuffer: pointer to data to be written. |
nikapov | 0:7917d6d00a6e | 90 | * @param RegisterAddr: specifies internal address register to be written. |
nikapov | 0:7917d6d00a6e | 91 | * @param NumByteToWrite: number of bytes to write. |
nikapov | 0:7917d6d00a6e | 92 | * @retval 0 if ok, an error code otherwise. |
nikapov | 0:7917d6d00a6e | 93 | */ |
nikapov | 0:7917d6d00a6e | 94 | uint8_t io_write(uint8_t* pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite) |
nikapov | 0:7917d6d00a6e | 95 | { |
nikapov | 0:7917d6d00a6e | 96 | return (uint8_t) _dev_i2c.i2c_write(pBuffer, _address, RegisterAddr, NumByteToWrite); |
nikapov | 0:7917d6d00a6e | 97 | } |
nikapov | 0:7917d6d00a6e | 98 | |
nikapov | 0:7917d6d00a6e | 99 | private: |
nikapov | 0:7917d6d00a6e | 100 | |
nikapov | 0:7917d6d00a6e | 101 | /* Helper classes. */ |
nikapov | 0:7917d6d00a6e | 102 | DevI2C &_dev_i2c; |
nikapov | 0:7917d6d00a6e | 103 | |
nikapov | 0:7917d6d00a6e | 104 | /* Configuration */ |
nikapov | 0:7917d6d00a6e | 105 | uint8_t _address; |
nikapov | 0:7917d6d00a6e | 106 | |
nikapov | 0:7917d6d00a6e | 107 | }; |
nikapov | 0:7917d6d00a6e | 108 | |
nikapov | 0:7917d6d00a6e | 109 | #ifdef __cplusplus |
nikapov | 0:7917d6d00a6e | 110 | extern "C" { |
nikapov | 0:7917d6d00a6e | 111 | #endif |
nikapov | 0:7917d6d00a6e | 112 | uint8_t HTS221_io_write( void *handle, uint8_t WriteAddr, uint8_t *pBuffer, uint16_t nBytesToWrite ); |
nikapov | 0:7917d6d00a6e | 113 | uint8_t HTS221_io_read( void *handle, uint8_t ReadAddr, uint8_t *pBuffer, uint16_t nBytesToRead ); |
nikapov | 0:7917d6d00a6e | 114 | #ifdef __cplusplus |
nikapov | 0:7917d6d00a6e | 115 | } |
nikapov | 0:7917d6d00a6e | 116 | #endif |
nikapov | 0:7917d6d00a6e | 117 | |
nikapov | 0:7917d6d00a6e | 118 | #endif |