Benoit Marchand / iGreenhouse_Node2_gcc_arm_nucleo_l073rz

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.

Dependencies:   mbed Sht31

Embed: (wiki syntax)

« Back to documentation index

HTS221Sensor Class Reference
Public Member Functions

HTS221Sensor Class Reference

Abstract class of an HTS221 Humidity and Temperature sensor. More...

#include <HTS221Sensor.h>

Inherits HumiditySensor, and TempSensor.

Public Member Functions

 HTS221Sensor (DevI2C *i2c, uint8_t address=HTS221_I2C_ADDRESS, PinName drdy_pin=NC)
 Constructor.
virtual int init (void *init)
 Initializing the component.
virtual int read_id (uint8_t *id)
 Read ID address of HTS221.
virtual int get_humidity (float *pfData)
 Read HTS221 output register, and calculate the humidity.
virtual int get_temperature (float *pfData)
 Read HTS221 output register, and calculate the temperature.
int enable (void)
 Enable HTS221.
int disable (void)
 Disable HTS221.
int reset (void)
 Reboot memory content of HTS221.
int get_odr (float *odr)
 Read HTS221 output register, and calculate the humidity.
int set_odr (float odr)
 Set ODR.
int read_reg (uint8_t reg, uint8_t *data)
 Read the data from register.
int write_reg (uint8_t reg, uint8_t data)
 Write the data to register.
uint8_t io_read (uint8_t *pBuffer, uint8_t RegisterAddr, uint16_t NumByteToRead)
 Utility function to read data.
uint8_t io_write (uint8_t *pBuffer, uint8_t RegisterAddr, uint16_t NumByteToWrite)
 Utility function to write data.
virtual int get_fahrenheit (float *pf_data)
 Get current temperature in degrees Fahrenheit [°F].
virtual int get_fahrenheit (float *pf_data)
 Get current temperature in degrees Fahrenheit [°F].
virtual int get_fahrenheit (float *pf_data)
 Get current temperature in degrees Fahrenheit [°F].
virtual int get_fahrenheit (float *pf_data)
 Get current temperature in degrees Fahrenheit [°F].

Detailed Description

Abstract class of an HTS221 Humidity and Temperature sensor.

Definition at line 58 of file HTS221Sensor.h.

Constructor & Destructor Documentation

HTS221Sensor ( DevI2C *  i2c,
uint8_t  address = HTS221_I2C_ADDRESS,
PinName  drdy_pin = NC 
)

Constructor.

Parameters:
i2cobject of an helper class which handles the I2C peripheral
addressthe address of the component's instance

Definition at line 51 of file HTS221Sensor.cpp.

Member Function Documentation

int disable ( void   )

Disable HTS221.

Return values:
0in case of success, an error code otherwise

Definition at line 103 of file HTS221Sensor.cpp.

int enable ( void   )

Enable HTS221.

Return values:
0in case of success, an error code otherwise

Definition at line 88 of file HTS221Sensor.cpp.

virtual int get_fahrenheit ( float *  pf_data ) [virtual, inherited]

Get current temperature in degrees Fahrenheit [°F].

Parameters:
[out]pf_dataPointer to where to store temperature to
Returns:
0 in case of success, an error code otherwise

Definition at line 71 of file LSM303AGR/ST_INTERFACES/Sensors/TempSensor.h.

virtual int get_fahrenheit ( float *  pf_data ) [virtual, inherited]

Get current temperature in degrees Fahrenheit [°F].

Parameters:
[out]pf_dataPointer to where to store temperature to
Returns:
0 in case of success, an error code otherwise

Definition at line 71 of file LSM6DSL/ST_INTERFACES/Sensors/TempSensor.h.

virtual int get_fahrenheit ( float *  pf_data ) [virtual, inherited]

Get current temperature in degrees Fahrenheit [°F].

Parameters:
[out]pf_dataPointer to where to store temperature to
Returns:
0 in case of success, an error code otherwise

Definition at line 71 of file HTS221/ST_INTERFACES/Sensors/TempSensor.h.

virtual int get_fahrenheit ( float *  pf_data ) [virtual, inherited]

Get current temperature in degrees Fahrenheit [°F].

Parameters:
[out]pf_dataPointer to where to store temperature to
Returns:
0 in case of success, an error code otherwise

Definition at line 71 of file LPS22HB/ST_INTERFACES/Sensors/TempSensor.h.

int get_humidity ( float *  pfData ) [virtual]

Read HTS221 output register, and calculate the humidity.

Parameters:
pfDatathe pointer to data output
Return values:
0in case of success, an error code otherwise

Implements HumiditySensor.

Definition at line 167 of file HTS221Sensor.cpp.

int get_odr ( float *  odr )

Read HTS221 output register, and calculate the humidity.

Parameters:
odrthe pointer to the output data rate
Return values:
0in case of success, an error code otherwise

Definition at line 207 of file HTS221Sensor.cpp.

int get_temperature ( float *  pfData ) [virtual]

Read HTS221 output register, and calculate the temperature.

Parameters:
pfDatathe pointer to data output
Return values:
0in case of success, an error code otherwise

Implements TempSensor.

Definition at line 187 of file HTS221Sensor.cpp.

int init ( void *  init ) [virtual]

Initializing the component.

Parameters:
[in]initpointer to device specific initalization structure.
Return values:
0in case of success, an error code otherwise.

Implements Component.

Definition at line 62 of file HTS221Sensor.cpp.

uint8_t io_read ( uint8_t *  pBuffer,
uint8_t  RegisterAddr,
uint16_t  NumByteToRead 
)

Utility function to read data.

Parameters:
pBuffer,:pointer to data to be read.
RegisterAddr,:specifies internal address register to be read.
NumByteToRead,:number of bytes to be read.
Return values:
0if ok, an error code otherwise.

Definition at line 80 of file HTS221Sensor.h.

uint8_t io_write ( uint8_t *  pBuffer,
uint8_t  RegisterAddr,
uint16_t  NumByteToWrite 
)

Utility function to write data.

Parameters:
pBuffer,:pointer to data to be written.
RegisterAddr,:specifies internal address register to be written.
NumByteToWrite,:number of bytes to write.
Return values:
0if ok, an error code otherwise.

Definition at line 92 of file HTS221Sensor.h.

int read_id ( uint8_t *  id ) [virtual]

Read ID address of HTS221.

Parameters:
idthe pointer where the ID of the device is stored
Return values:
0in case of success, an error code otherwise

Implements Component.

Definition at line 119 of file HTS221Sensor.cpp.

int read_reg ( uint8_t  reg,
uint8_t *  data 
)

Read the data from register.

Parameters:
regregister address
dataregister data
Return values:
0in case of success
1in case of failure

Definition at line 267 of file HTS221Sensor.cpp.

int reset ( void   )

Reboot memory content of HTS221.

Parameters:
None
Return values:
0in case of success, an error code otherwise

Definition at line 140 of file HTS221Sensor.cpp.

int set_odr ( float  odr )

Set ODR.

Parameters:
odrthe output data rate to be set
Return values:
0in case of success, an error code otherwise

Definition at line 243 of file HTS221Sensor.cpp.

int write_reg ( uint8_t  reg,
uint8_t  data 
)

Write the data to register.

Parameters:
regregister address
dataregister data
Return values:
0in case of success
1in case of failure

Definition at line 285 of file HTS221Sensor.cpp.

Generated on Tue Jul 12 2022 21:38:10 by  doxygen 1.7.2