Manuel Caballero / HTS221

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   Arduino_Nano33BLESense_examples

Embed: (wiki syntax)

« Back to documentation index

HTS221 Class Reference
Public Types | Public Member Functions

HTS221 Class Reference

Example: More...

#include <HTS221.h>

Public Types

enum  HTS221_address_t { HTS221_ADDRESS = ( 0b1011111 << 1U ) }
enum  HTS221_registers_t {
  HTS221_WHO_AM_I = 0x0F, HTS221_AV_CONF = 0x10, HTS221_CTRL_REG1 = 0x20, HTS221_CTRL_REG2 = 0x21,
  HTS221_CTRL_REG3 = 0x22, HTS221_STATUS_REG = 0x27, HTS221_HUMIDITY_OUT_L = 0x28, HTS221_HUMIDITY_OUT_H = 0x29,
  HTS221_TEMP_OUT_L = 0x2A, HTS221_TEMP_OUT_H = 0x2B, HTS221_CALIB_0 = 0x30, HTS221_CALIB_1 = 0x31,
  HTS221_CALIB_2 = 0x32, HTS221_CALIB_3 = 0x33, HTS221_CALIB_4 = 0x34, HTS221_CALIB_5 = 0x35,
  HTS221_CALIB_6 = 0x36, HTS221_CALIB_7 = 0x37, HTS221_CALIB_8 = 0x38, HTS221_CALIB_9 = 0x39,
  HTS221_CALIB_A = 0x3A, HTS221_CALIB_B = 0x3B, HTS221_CALIB_C = 0x3C, HTS221_CALIB_D = 0x3D,
  HTS221_CALIB_E = 0x3E, HTS221_CALIB_F = 0x3F
}
 

REGISTERS.

More...
enum  HTS221_who_am_i_t { WHO_AM_I_MASK = 0xFF, WHO_AM_I_VALUE = 0xBC }
 

WHO_AM_I REGISTER.

More...
enum  HTS221_av_config_avgt_t {
  AV_CONF_AVGT_MASK = ( 0b111 << 3U ), AV_CONF_AVGT_2 = ( 0b000 << 3U ), AV_CONF_AVGT_4 = ( 0b001 << 3U ), AV_CONF_AVGT_8 = ( 0b010 << 3U ),
  AV_CONF_AVGT_16 = ( 0b011 << 3U ), AV_CONF_AVGT_32 = ( 0b100 << 3U ), AV_CONF_AVGT_64 = ( 0b101 << 3U ), AV_CONF_AVGT_128 = ( 0b110 << 3U ),
  AV_CONF_AVGT_256 = ( 0b111 << 3U )
}
 

AV_CONF REGISTER.

More...
enum  HTS221_av_config_avgh_t {
  AV_CONF_AVGH_MASK = ( 0b111 << 0U ), AV_CONF_AVGH_4 = ( 0b000 << 0U ), AV_CONF_AVGH_8 = ( 0b001 << 0U ), AV_CONF_AVGH_16 = ( 0b010 << 0U ),
  AV_CONF_AVGH_32 = ( 0b011 << 0U ), AV_CONF_AVGH_64 = ( 0b100 << 0U ), AV_CONF_AVGH_128 = ( 0b101 << 0U ), AV_CONF_AVGH_256 = ( 0b110 << 0U ),
  AV_CONF_AVGH_512 = ( 0b111 << 0U )
}
enum  HTS221_ctrl_reg1_pd_t { CTRL_REG1_PD_MASK = ( 1U << 7U ), CTRL_REG1_PD_POWER_DOWN_MODE = ( 0U << 7U ), CTRL_REG1_PD_ACTIVE_MODE = ( 1U << 7U ) }
 

CTRL_REG1 REGISTER.

More...
enum  HTS221_ctrl_reg1_bdu_t { CTRL_REG1_BDU_MASK = ( 1U << 2U ), CTRL_REG1_BDU_CONTINUOUS_UPDATE = ( 0U << 2U ), CTRL_REG1_BDU_DEFAULT_MODE = ( 1U << 2U ) }
enum  HTS221_ctrl_reg1_odr_t {
  CTRL_REG1_ODR_MASK = ( 0b11 << 0U ), CTRL_REG1_ODR_ONE_SHOT = ( 0b00 << 0U ), CTRL_REG1_ODR_1_HZ = ( 0b01 << 0U ), CTRL_REG1_ODR_7_HZ = ( 0b10 << 0U ),
  CTRL_REG1_ODR_12_5_HZ = ( 0b11 << 0U )
}
enum  HTS221_ctrl_reg2_boot_t { CTRL_REG2_BOOT_MASK = ( 1U << 7U ), CTRL_REG2_BOOT_NORMAL_MODE = ( 0U << 7U ), CTRL_REG2_BOOT_REBOOT_MEMORY_CONTENT = ( 1U << 7U ) }
 

CTRL_REG2 REGISTER.

More...
enum  HTS221_ctrl_reg2_heater_t { CTRL_REG2_HEATER_MASK = ( 1U << 1U ), CTRL_REG2_HEATER_HEATER_DISABLED = ( 0U << 1U ), CTRL_REG2_HEATER_HEATER_ENABLED = ( 1U << 1U ) }
enum  HTS221_ctrl_reg2_one_shot_t { CTRL_REG2_ONE_SHOT_MASK = ( 1U << 0U ), CTRL_REG2_ONE_SHOT_WAITING = ( 0U << 0U ), CTRL_REG2_ONE_SHOT_START = ( 1U << 0U ) }
enum  HTS221_ctrl_reg3_drdy_h_l_t { CTRL_REG3_DRDY_H_L_MASK = ( 1U << 7U ), CTRL_REG3_DRDY_H_L_ACTIVE_HIGH = ( 0U << 7U ), CTRL_REG3_DRDY_H_L_ACTIVE_LOW = ( 1U << 7U ) }
 

CTRL_REG3 REGISTER.

More...
enum  HTS221_ctrl_reg3_pp_od_t { CTRL_REG3_PP_OD_MASK = ( 1U << 6U ), CTRL_REG3_PP_OD_PUSH_PULL = ( 0U << 6U ), CTRL_REG3_PP_OD_OPEN_DRAIN = ( 1U << 6U ) }
enum  HTS221_ctrl_reg3_drdy_en_t { CTRL_REG3_DRDY_EN_MASK = ( 1U << 2U ), CTRL_REG3_DRDY_DATA_READY_DISABLED = ( 0U << 2U ), CTRL_REG3_DRDY_DATA_READY_ENABLED = ( 1U << 2U ) }
enum  HTS221_status_reg_h_da_t { STATUS_REGISTER_H_DA_MASK = ( 1U << 1U ), STATUS_REGISTER_H_DA_DATA_NOT_AVAILABLE = ( 0U << 1U ), STATUS_REGISTER_H_DA_DATA_AVAILABLE = ( 1U << 1U ) }
 

STATUS_REG REGISTER.

More...
enum  HTS221_status_reg_t_da_t { STATUS_REGISTER_T_DA_MASK = ( 1U << 0U ), STATUS_REGISTER_T_DA_DATA_NOT_AVAILABLE = ( 0U << 0U ), STATUS_REGISTER_T_DA_DATA_AVAILABLE = ( 1U << 0U ) }
enum  HTS221_humidity_out_l_t { HUMIDITY_OUT_L_MASK = 0xFF }
 

HUMIDITY_OUT_L REGISTER.

More...
enum  HTS221_humidity_out_h_t { HUMIDITY_OUT_H_MASK = 0xFF }
 

HUMIDITY_OUT_H REGISTER.

More...
enum  HTS221_temp_out_l_t { TEMP_OUT_L_MASK = 0xFF }
 

TEMP_OUT_L REGISTER.

More...
enum  HTS221_temp_out_h_t { TEMP_OUT_H_MASK = 0xFF }
 

TEMP_OUT_H REGISTER.

More...
enum  HTS221_status_t { , I2C_SUCCESS = 0U }
 

INTERNAL CONSTANTS.

More...

Public Member Functions

 HTS221 (PinName sda, PinName scl, uint32_t addr, uint32_t freq)
 Create an HTS221 object connected to the specified I2C pins.
 ~HTS221 ()
 Delete HTS221 object.
HTS221_status_t HTS221_GetDeviceID (HTS221_data_t *myDeviceID)
 It gets the device identification.
HTS221_status_t HTS221_SetResolution (HTS221_data_t myTempHumResolution)
 It sets humidity and temperature resolution mode.
HTS221_status_t HTS221_GetResolution (HTS221_data_t *myTempHumResolution)
 It gets humidity and temperature resolution mode.
HTS221_status_t HTS221_SetPowerDown (HTS221_ctrl_reg1_pd_t myPowerMode)
 It sets power-down control mode.
HTS221_status_t HTS221_SetBlockDataUpdate (HTS221_data_t myBDU)
 It sets the block data update.
HTS221_status_t HTS221_GetBlockDataUpdate (HTS221_data_t *myBDU)
 It gets the block data update.
HTS221_status_t HTS221_SetOutputDataRate (HTS221_data_t myODR)
 It sets the output data rate ( ODR ).
HTS221_status_t HTS221_GetOutputDataRate (HTS221_data_t *myODR)
 It gets the output data rate ( ODR ).
HTS221_status_t HTS221_SetBoot (void)
 It sets reboot memory content.
HTS221_status_t HTS221_GetBoot (HTS221_data_t *myBOOT)
 It gets reboot memory content.
HTS221_status_t HTS221_SetHeater (HTS221_data_t myHeater)
 It sets heater mode: Enabled/Disabled.
HTS221_status_t HTS221_GetHeater (HTS221_data_t *myHeater)
 It gets heater mode.
HTS221_status_t HTS221_SetOneShot (void)
 It sets one-shot, new data set.
HTS221_status_t HTS221_GetOneShot (HTS221_data_t *myOneShot)
 It gets one-shot flag.
HTS221_status_t HTS221_SetDataReadyOuput (HTS221_ctrl_reg3_drdy_h_l_t myDRDY_H_L)
 It sets data ready output signal active high/low.
HTS221_status_t HTS221_SetSelectionOnPin3 (HTS221_ctrl_reg3_pp_od_t myDRDY)
 It sets Push-pull/Open Drain selection on pin 3 ( DRDY ).
HTS221_status_t HTS221_SetDataReadyEnable (HTS221_ctrl_reg3_drdy_en_t myDRDY_EN)
 It sets data ready enable.
HTS221_status_t HTS221_GetHumidityDataAvailable (HTS221_data_t *myHumidityFlag)
 It gets humidity data available flag.
HTS221_status_t HTS221_GetTemperatureDataAvailable (HTS221_data_t *myTemperatureFlag)
 It gets temperature data available flag.
HTS221_status_t HTS221_GetRawHumidity (HTS221_data_t *myRawHumidity)
 It gets raw humidity.
HTS221_status_t HTS221_GetRawTemperature (HTS221_data_t *myRawTemperature)
 It gets raw temperature.
HTS221_status_t HTS221_GetCalibrationCoefficients (HTS221_data_t *myCoeff)
 It gets calibration coefficients.
HTS221_status_t HTS221_GetTemperature (HTS221_data_t *myTemperature)
 It gets the current temperature value in Celsius degrees.
HTS221_status_t HTS221_GetHumidity (HTS221_data_t *myHumidity)
 It gets the current humidity value.

Detailed Description

Example: 

#include "mbed.h"
#include "HTS221.h"

HTS221 myHTS221   ( I2C_SDA, I2C_SCL, HTS221::HTS221_ADDRESS , 400000 );         // I2C_SDA | I2C_SCL
Serial pc         ( USBTX, USBRX );                                             // tx, rx

DigitalOut  myled   ( LED1 );
Ticker      newAction;


//@brief Constants.


//@brief Variables.
volatile uint32_t myState;                                                      //   State that indicates when to perform a new sample  


// @brief   FUNCTION PROTOTYPES
void    changeDATA     ( void );


//@brief FUNCTION FOR APPLICATION MAIN ENTRY.
int main()
{
    HTS221::HTS221_status_t aux;
    HTS221::HTS221_data_t   myHTS221_Data;

    pc.baud ( 115200 );


    myled   =   1;
    wait(3);
    myled   =   0;

    // Get device ID  
    aux  =   myHTS221.HTS221_GetDeviceID ( &myHTS221_Data );

    // Boot the device   
    aux  =   myHTS221.HTS221_SetBoot ();

    // Set device in ACTIVE mode  
    aux  =   myHTS221.HTS221_SetPowerDown ( HTS221::CTRL_REG1_PD_ACTIVE_MODE  );

    // Get calibration coefficients  
    aux  =   myHTS221.HTS221_GetCalibrationCoefficients ( &myHTS221_Data );

    // Output registers not updated until MSB and LSB reading  
    myHTS221_Data.bdu  =   HTS221::CTRL_REG1_BDU_DEFAULT_MODE ;
    aux  =   myHTS221.HTS221_SetBlockDataUpdate ( myHTS221_Data );

    // Set resolution: 16 AVGT, 32 AVGH  
    myHTS221_Data.temperatureResolution  =   HTS221::AV_CONF_AVGT_16 ;
    myHTS221_Data.humidityResolution     =   HTS221::AV_CONF_AVGH_32 ;
    aux  =   myHTS221.HTS221_SetResolution ( myHTS221_Data );

    // ODR  
    myHTS221_Data.odr  =   HTS221::CTRL_REG1_ODR_ONE_SHOT ;
    aux  =   myHTS221.HTS221_SetOutputDataRate ( myHTS221_Data );


    myState  =   0UL;                                                           // Reset the variable
    newAction.attach( &changeDATA, 1U );                                        // the address of the function to be attached ( changeDATA ) and the interval ( 1s )


    // Let the callbacks take care of everything
    while(1) {
        sleep();

        if ( myState == 1UL ) {
            myled = 1U;

            // Trigger to get a new data value  
            aux  =   myHTS221.HTS221_SetOneShot ();

            // Wait until there is a new data  
            do {
                aux  =   myHTS221.HTS221_GetOneShot ( &myHTS221_Data );
            } while( myHTS221_Data.one_shot == HTS221::CTRL_REG2_ONE_SHOT_WAITING  );


            aux  =   myHTS221.HTS221_GetCalibrationCoefficients ( &myHTS221_Data );

            // Get temperature  
            do {
                aux  =   myHTS221.HTS221_GetTemperatureDataAvailable ( &myHTS221_Data );
            } while( myHTS221_Data.t_da == HTS221::STATUS_REGISTER_T_DA_DATA_NOT_AVAILABLE  );

            aux  =   myHTS221.HTS221_GetTemperature ( &myHTS221_Data );

            // Get humidity  
            aux  =   myHTS221.HTS221_GetHumidity ( &myHTS221_Data );

            // Send data through the UART    
            pc.printf ( "T: %0.1f C, RH: %0.1f %%\r\n", myHTS221_Data.temperature, myHTS221_Data.humidity );


            // Reset the variables   
            myState  =   0UL;
            myled    =   0U;
        }
    }
}


 // @brief       changeDATA ( void  )
 //
 // @details     It changes myState variable
 //
 // @param[in]    N/A
 //
 // @param[out]   N/A.
 //
 // @return       N/A.
 //
 // @author      Manuel Caballero
 // @date        31/May/2019
 // @version     31/May/2019   The ORIGIN
 // @pre         N/A
 // @warning     N/A.
void changeDATA ( void )
{
    myState  =   1UL;
}

Library for the HTS221 Capacitive digital sensor for relative humidity and temperature.

Definition at line 155 of file HTS221.h.

Member Enumeration Documentation

enum HTS221_address_t
Enumerator:
HTS221_ADDRESS 

I2C slave address byte

Definition at line 158 of file HTS221.h.

enum HTS221_av_config_avgh_t
Enumerator:
AV_CONF_AVGH_MASK 

AVGH mask

AV_CONF_AVGH_4 

AVGH Nr. internal average 4

AV_CONF_AVGH_8 

AVGH Nr. internal average 8

AV_CONF_AVGH_16 

AVGH Nr. internal average 16

AV_CONF_AVGH_32 

AVGH Nr. internal average 32 [ Default ]

AV_CONF_AVGH_64 

AVGH Nr. internal average 64

AV_CONF_AVGH_128 

AVGH Nr. internal average 128

AV_CONF_AVGH_256 

AVGH Nr. internal average 256

AV_CONF_AVGH_512 

AVGH Nr. internal average 512

Definition at line 230 of file HTS221.h.

enum HTS221_av_config_avgt_t

AV_CONF REGISTER.

Enumerator:
AV_CONF_AVGT_MASK 

AVGT mask

AV_CONF_AVGT_2 

AVGT Nr. internal average 2

AV_CONF_AVGT_4 

AVGT Nr. internal average 4

AV_CONF_AVGT_8 

AVGT Nr. internal average 8

AV_CONF_AVGT_16 

AVGT Nr. internal average 16 [ Default ]

AV_CONF_AVGT_32 

AVGT Nr. internal average 32

AV_CONF_AVGT_64 

AVGT Nr. internal average 64

AV_CONF_AVGT_128 

AVGT Nr. internal average 128

AV_CONF_AVGT_256 

AVGT Nr. internal average 256

Definition at line 214 of file HTS221.h.

enum HTS221_ctrl_reg1_bdu_t
Enumerator:
CTRL_REG1_BDU_MASK 

BDU mask

CTRL_REG1_BDU_CONTINUOUS_UPDATE 

Continuous update

CTRL_REG1_BDU_DEFAULT_MODE 

Output registers not updated until MSB and LSB reading [ Default ]

Definition at line 260 of file HTS221.h.

enum HTS221_ctrl_reg1_odr_t
Enumerator:
CTRL_REG1_ODR_MASK 

ODR mask

CTRL_REG1_ODR_ONE_SHOT 

One-shot

CTRL_REG1_ODR_1_HZ 

1 Hz

CTRL_REG1_ODR_7_HZ 

7 Hz

CTRL_REG1_ODR_12_5_HZ 

12.5 Hz

Definition at line 270 of file HTS221.h.

enum HTS221_ctrl_reg1_pd_t

CTRL_REG1 REGISTER.

Enumerator:
CTRL_REG1_PD_MASK 

PD mask

CTRL_REG1_PD_POWER_DOWN_MODE 

PD power-down mode [ Default ]

CTRL_REG1_PD_ACTIVE_MODE 

PD active mode

Definition at line 250 of file HTS221.h.

enum HTS221_ctrl_reg2_boot_t

CTRL_REG2 REGISTER.

Enumerator:
CTRL_REG2_BOOT_MASK 

BOOT mask

CTRL_REG2_BOOT_NORMAL_MODE 

normal mode [ Default ]

CTRL_REG2_BOOT_REBOOT_MEMORY_CONTENT 

reboot memory content

Definition at line 286 of file HTS221.h.

enum HTS221_ctrl_reg2_heater_t
Enumerator:
CTRL_REG2_HEATER_MASK 

Heater mask

CTRL_REG2_HEATER_HEATER_DISABLED 

Heater disabled [ Default ]

CTRL_REG2_HEATER_HEATER_ENABLED 

Heater enabled

Definition at line 296 of file HTS221.h.

enum HTS221_ctrl_reg2_one_shot_t
Enumerator:
CTRL_REG2_ONE_SHOT_MASK 

ONE_SHOT mask

CTRL_REG2_ONE_SHOT_WAITING 

waiting for start of conversion [ Default ]

CTRL_REG2_ONE_SHOT_START 

start for a new dataset

Definition at line 306 of file HTS221.h.

enum HTS221_ctrl_reg3_drdy_en_t
Enumerator:
CTRL_REG3_DRDY_EN_MASK 

DRDY_EN mask

CTRL_REG3_DRDY_DATA_READY_DISABLED 

Data Ready disabled [ Default ]

CTRL_REG3_DRDY_DATA_READY_ENABLED 

Data Ready signal available on pin 3

Definition at line 340 of file HTS221.h.

enum HTS221_ctrl_reg3_drdy_h_l_t

CTRL_REG3 REGISTER.

Enumerator:
CTRL_REG3_DRDY_H_L_MASK 

DRDY_H_L mask

CTRL_REG3_DRDY_H_L_ACTIVE_HIGH 

active high [ Default ]

CTRL_REG3_DRDY_H_L_ACTIVE_LOW 

active low

Definition at line 320 of file HTS221.h.

enum HTS221_ctrl_reg3_pp_od_t
Enumerator:
CTRL_REG3_PP_OD_MASK 

PP_OD mask

CTRL_REG3_PP_OD_PUSH_PULL 

push-pull [ Default ]

CTRL_REG3_PP_OD_OPEN_DRAIN 

open drain

Definition at line 330 of file HTS221.h.

enum HTS221_humidity_out_h_t

HUMIDITY_OUT_H REGISTER.

NOTE: Relative humidity data (LSB) . *

Enumerator:
HUMIDITY_OUT_H_MASK 

Humidity data MSB mask

Definition at line 393 of file HTS221.h.

enum HTS221_humidity_out_l_t

HUMIDITY_OUT_L REGISTER.

NOTE: Relative humidity data (LSB) . *

Enumerator:
HUMIDITY_OUT_L_MASK 

Humidity data LSB mask

Definition at line 381 of file HTS221.h.

enum HTS221_registers_t

REGISTERS.

Enumerator:
HTS221_WHO_AM_I 

Device identification

HTS221_AV_CONF 

Humidity and temperature resolution mode

HTS221_CTRL_REG1 

Control register 1

HTS221_CTRL_REG2 

Control register 2

HTS221_CTRL_REG3 

Control register 3

HTS221_STATUS_REG 

Status register

HTS221_HUMIDITY_OUT_L 

Relative humidity data (LSB)

HTS221_HUMIDITY_OUT_H 

Relative humidity data (MSB)

HTS221_TEMP_OUT_L 

Temperature data (LSB)

HTS221_TEMP_OUT_H 

Temperature data (MSB)

HTS221_CALIB_0 

Calibration register

HTS221_CALIB_1 

Calibration register

HTS221_CALIB_2 

Calibration register

HTS221_CALIB_3 

Calibration register

HTS221_CALIB_4 

Calibration register

HTS221_CALIB_5 

Calibration register

HTS221_CALIB_6 

Calibration register

HTS221_CALIB_7 

Calibration register

HTS221_CALIB_8 

Calibration register

HTS221_CALIB_9 

Calibration register

HTS221_CALIB_A 

Calibration register

HTS221_CALIB_B 

Calibration register

HTS221_CALIB_C 

Calibration register

HTS221_CALIB_D 

Calibration register

HTS221_CALIB_E 

Calibration register

HTS221_CALIB_F 

Calibration register

Definition at line 167 of file HTS221.h.

enum HTS221_status_reg_h_da_t

STATUS_REG REGISTER.

NOTE: H_DA is set to 1 whenever a new humidity sample is available. H_DA is cleared anytime HUMIDITY_OUT_H (29h) register is read. T_DA is set to 1 whenever a new temperature sample is available. T_DA is cleared anytime TEMP_OUT_H (2Bh) register is read.

Enumerator:
STATUS_REGISTER_H_DA_MASK 

H_DA mask

STATUS_REGISTER_H_DA_DATA_NOT_AVAILABLE 

new data for humidity is not yet available

STATUS_REGISTER_H_DA_DATA_AVAILABLE 

new data for humidity is available

Definition at line 357 of file HTS221.h.

enum HTS221_status_reg_t_da_t
Enumerator:
STATUS_REGISTER_T_DA_MASK 

T_DA mask

STATUS_REGISTER_T_DA_DATA_NOT_AVAILABLE 

new data for temperature is not yet available

STATUS_REGISTER_T_DA_DATA_AVAILABLE 

new data for temperature is available

Definition at line 367 of file HTS221.h.

enum HTS221_status_t

INTERNAL CONSTANTS.

Enumerator:
I2C_SUCCESS 

I2C communication was fine

Definition at line 474 of file HTS221.h.

enum HTS221_temp_out_h_t

TEMP_OUT_H REGISTER.

NOTE: Temperature data (MSB) . *

Enumerator:
TEMP_OUT_H_MASK 

Temperature data MSB mask

Definition at line 417 of file HTS221.h.

enum HTS221_temp_out_l_t

TEMP_OUT_L REGISTER.

NOTE: Temperature data (LSB) . *

Enumerator:
TEMP_OUT_L_MASK 

Temperature data LSB mask

Definition at line 405 of file HTS221.h.

enum HTS221_who_am_i_t

WHO_AM_I REGISTER.

Enumerator:
WHO_AM_I_MASK 

WHO_AM_I mask

WHO_AM_I_VALUE 

WHO_AM_I value

Definition at line 201 of file HTS221.h.

Constructor & Destructor Documentation

HTS221 ( PinName  sda,
PinName  scl,
uint32_t  addr,
uint32_t  freq 
)

Create an HTS221 object connected to the specified I2C pins.

HTS221.cpp.

Parameters:
sdaI2C data pin
sclI2C clock pin
addrI2C slave address
freqI2C frequency

Capacitive digital sensor for relative humidity and temperature. Function file.

Returns:
N/A
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A
Precondition:
This code belongs to AqueronteBlog ( http://unbarquero.blogspot.com ). All rights reserved.

Definition at line 20 of file HTS221.cpp.

~HTS221 (  )

Delete HTS221 object.

Definition at line 28 of file HTS221.cpp.

Member Function Documentation

HTS221::HTS221_status_t HTS221_GetBlockDataUpdate ( HTS221_data_t *  myBDU )

It gets the block data update.

HTS221_GetBlockDataUpdate ( HTS221_data_t* )

It gets the block data update.

Parameters:
[in]N/A.
[out]myBDU,:Block data update mode
Returns:
Status of HTS221_GetBlockDataUpdate.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 277 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetBoot ( HTS221_data_t *  myBOOT )

It gets reboot memory content.

HTS221_GetBoot ( HTS221_data_t* )

It gets reboot memory content.

Parameters:
[in]N/A.
[out]myBOOT,:Reboot memory content flag
Returns:
Status of HTS221_GetBoot.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 456 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetCalibrationCoefficients ( HTS221_data_t *  myCoeff )

It gets calibration coefficients.

HTS221_GetCalibrationCoefficients ( HTS221_data_t* )

It gets calibration coefficients.

Parameters:
[in]N/A.
[out]myCoeff,:Calibration coefficients
Returns:
Status of HTS221_GetCalibrationCoefficients.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
This function uses autoincrementing for reading the registers.
Warning:
N/A.

Definition at line 993 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetDeviceID ( HTS221_data_t *  myDeviceID )

It gets the device identification.

HTS221_GetDeviceID ( HTS221_data_t* )

It gets the device identification.

Parameters:
[in]N/A.
[out]myDeviceID,:Device ID.
Returns:
Status of HTS221_GetDeviceID.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 53 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetHeater ( HTS221_data_t *  myHeater )

It gets heater mode.

HTS221_GetHeater ( HTS221_data_t* )

It gets heater mode.

Parameters:
[in]N/A.
[out]myHeaterHeater mode
Returns:
Status of HTS221_GetHeater.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 546 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetHumidity ( HTS221_data_t *  myHumidity )

It gets the current humidity value.

HTS221_GetHumidity ( HTS221_data_t* )

It gets the current humidity value.

Parameters:
[in]N/A.
[out]myHumidity,:Current humidity value
Returns:
Status of HTS221_GetHumidity.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A.

Definition at line 1110 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetHumidityDataAvailable ( HTS221_data_t *  myHumidityFlag )

It gets humidity data available flag.

HTS221_GetHumidityDataAvailable ( HTS221_data_t* )

It gets humidity data available flag.

Parameters:
[in]N/A.
[out]myHumidityFlag,:Humidity data available flag
Returns:
Status of HTS221_GetHumidityDataAvailable.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 816 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetOneShot ( HTS221_data_t *  myOneShot )

It gets one-shot flag.

HTS221_GetOneShot ( HTS221_data_t* )

It gets one-shot flag.

Parameters:
[in]N/A.
[out]myOneShot,:One-shot flag
Returns:
Status of HTS221_GetOneShot.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 635 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetOutputDataRate ( HTS221_data_t *  myODR )

It gets the output data rate ( ODR ).

HTS221_GetOutputDataRate ( HTS221_data_t* )

It gets the output data rate ( ODR ).

Parameters:
[in]N/A.
[out]myODR,:Output data rate
Returns:
Status of HTS221_GetOutputDataRate.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 367 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetRawHumidity ( HTS221_data_t *  myRawHumidity )

It gets raw humidity.

HTS221_GetRawHumidity ( HTS221_data_t* )

It gets raw humidity.

Parameters:
[in]N/A
[out]myRawHumidity,:Raw humidity
Returns:
Status of HTS221_GetRawHumidity.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
This function uses autoincrementing for reading the registers.
Warning:
N/A.

Definition at line 902 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetRawTemperature ( HTS221_data_t *  myRawTemperature )

It gets raw temperature.

HTS221_GetRawTemperature ( HTS221_data_t* )

It gets raw temperature.

Parameters:
[in]N/A.
[out]myRawTemperature,:Raw temperature
Returns:
Status of HTS221_GetRawTemperature.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
This function uses autoincrementing for reading the registers.
Warning:
N/A.

Definition at line 947 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetResolution ( HTS221_data_t *  myTempHumResolution )

It gets humidity and temperature resolution mode.

HTS221_GetResolution ( HTS221_data_t* )

It get humidity and temperature resolution mode.

Parameters:
[in]N/A
[out]myTempHumResolution,:Humidity and Temperature resolution mode
Returns:
Status of HTS221_GetResolution.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 142 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetTemperature ( HTS221_data_t *  myTemperature )

It gets the current temperature value in Celsius degrees.

HTS221_GetTemperature ( HTS221_data_t* )

It gets the current temperature in Celsius degrees.

Parameters:
[in]N/A.
[out]myTemperature,:Current temperature in Celsius degress
Returns:
Status of HTS221_GetTemperature.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A.

Definition at line 1069 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_GetTemperatureDataAvailable ( HTS221_data_t *  myTemperatureFlag )

It gets temperature data available flag.

HTS221_GetTemperatureDataAvailable ( HTS221_data_t* )

It gets temperature data available flag.

Parameters:
[in]N/A.
[out]myTemperatureFlag,:Temperature data available flag
Returns:
Status of HTS221_GetTemperatureDataAvailable.
Author:
Manuel Caballero
Date:
24/May/2019
Version:
24/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 859 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetBlockDataUpdate ( HTS221_data_t  myBDU )

It sets the block data update.

HTS221_SetBlockDataUpdate ( HTS221_data_t )

It sets the block data update.

Parameters:
[in]myBDU,:Block data update mode.
[out]N/A
Returns:
Status of HTS221_SetBlockDataUpdate.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 232 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetBoot ( void   )

It sets reboot memory content.

HTS221_SetBoot ( void )

It sets reboot memory content.

Parameters:
[in]N/A.
[out]N/A
Returns:
Status of HTS221_SetBoot.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
At the end of the boot process, the BOOT bit is set again to '0'.
Warning:
N/A.

Definition at line 411 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetDataReadyEnable ( HTS221_ctrl_reg3_drdy_en_t  myDRDY_EN )

It sets data ready enable.

HTS221_SetDataReadyEnable ( HTS221_ctrl_reg3_drdy_en_t )

It sets data ready enable.

Parameters:
[in]N/A.
[in]myDRDY_EN,:Data Ready enable.
[out]N/A
Returns:
Status of HTS221_SetDataReadyEnable.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A.

Definition at line 772 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetDataReadyOuput ( HTS221_ctrl_reg3_drdy_h_l_t  myDRDY_H_L )

It sets data ready output signal active high/low.

HTS221_SetDataReadyOuput ( HTS221_ctrl_reg3_drdy_h_l_t )

It sets data ready output signal active high/low.

Parameters:
[in]N/A.
[in]myDRDY_H_L,:Data ready output signal high/low.
[out]N/A
Returns:
Status of HTS221_SetDataReadyOuput.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A.

Definition at line 680 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetHeater ( HTS221_data_t  myHeater )

It sets heater mode: Enabled/Disabled.

HTS221_SetHeater ( HTS221_data_t* )

It sets heater mode: Enabled/Disabled.

Parameters:
[in]N/A.
[in]myHeater,:Heater mode.
[out]N/A
Returns:
Status of HTS221_SetHeater.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 501 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetOneShot ( void   )

It sets one-shot, new data set.

HTS221_SetOneShot ( void )

It sets one-shot, new data set.

Parameters:
[in]N/A.
[out]N/A
Returns:
Status of HTS221_SetOneShot.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
ONE_SHOT bit comes back to '0' by hardware
Warning:
N/A.

Definition at line 590 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetOutputDataRate ( HTS221_data_t  myODR )

It sets the output data rate ( ODR ).

HTS221_SetOutputDataRate ( HTS221_data_t )

It sets the output data rate ( ODR ).

Parameters:
[in]N/A.
[in]myODR,:Output data rate.
[out]N/A
Returns:
Status of HTS221_SetOutputDataRate.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 322 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetPowerDown ( HTS221_ctrl_reg1_pd_t  myPowerMode )

It sets power-down control mode.

HTS221_SetPowerDown ( HTS221_ctrl_reg1_pd_t )

It sets the device into power-down ( low-power mode ) or active mode.

Parameters:
[in]myPowerMode,:Power-Down/Active mode.
[out]N/A
Returns:
Status of HTS221_SetPowerDown.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 187 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetResolution ( HTS221_data_t  myTempHumResolution )

It sets humidity and temperature resolution mode.

HTS221_SetResolution ( HTS221_data_t )

It set humidity and temperature resolution mode.

Parameters:
[in]myTempHumResolution,:Humidity and Temperature resolution mode.
[out]N/A.
Returns:
Status of HTS221_SetResolution.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A
Warning:
N/A.

Definition at line 96 of file HTS221.cpp.

HTS221::HTS221_status_t HTS221_SetSelectionOnPin3 ( HTS221_ctrl_reg3_pp_od_t  myDRDY )

It sets Push-pull/Open Drain selection on pin 3 ( DRDY ).

HTS221_SetSelectionOnPin3 ( HTS221_ctrl_reg3_pp_od_t )

It sets Push-pull/Open Drain selection on pin 3 ( DRDY ).

Parameters:
[in]N/A.
[in]myDRDY,:Push-pull/Open Drain selection on pin 3 (DRDY).
[out]N/A
Returns:
Status of HTS221_SetDataReadyOuput.
Author:
Manuel Caballero
Date:
31/May/2019
Version:
31/May/2019 The ORIGIN
Precondition:
N/A.
Warning:
N/A.

Definition at line 726 of file HTS221.cpp.

Generated on Sun Jul 17 2022 08:46:37 by  doxygen 1.7.2