Firmware SDK
twr_hdc2080

Driver for HDC2080 humidity sensor. More...

Typedefs

typedef struct twr_hdc2080_t twr_hdc2080_t
 HDC2080 instance.
 

Enumerations

enum  twr_hdc2080_event_t {
  TWR_HDC2080_EVENT_ERROR = 0,
  TWR_HDC2080_EVENT_UPDATE = 1
}
 Callback events. More...
 

Functions

void twr_hdc2080_init (twr_hdc2080_t *self, twr_i2c_channel_t i2c_channel, uint8_t i2c_address)
 Initialize HDC2080. More...
 
void twr_hdc2080_deinit (twr_hdc2080_t *self)
 Deinitialize HDC2080. More...
 
void twr_hdc2080_set_event_handler (twr_hdc2080_t *self, void(*event_handler)(twr_hdc2080_t *, twr_hdc2080_event_t, void *), void *event_param)
 Set callback function. More...
 
void twr_hdc2080_set_update_interval (twr_hdc2080_t *self, twr_tick_t interval)
 Set measurement interval. More...
 
bool twr_hdc2080_measure (twr_hdc2080_t *self)
 Start measurement manually. More...
 
bool twr_hdc2080_get_humidity_raw (twr_hdc2080_t *self, uint16_t *raw)
 Get measured humidity as raw value. More...
 
bool twr_hdc2080_get_humidity_percentage (twr_hdc2080_t *self, float *percentage)
 Get measured humidity as percentage. More...
 
bool twr_hdc2080_get_temperature_raw (twr_hdc2080_t *self, uint16_t *raw)
 Get measured temperature as raw value. More...
 
bool twr_hdc2080_get_temperature_celsius (twr_hdc2080_t *self, float *celsius)
 Get measured temperature in degrees of Celsius. More...
 

Detailed Description

Driver for HDC2080 humidity sensor.

Enumeration Type Documentation

◆ twr_hdc2080_event_t

Callback events.

Enumerator
TWR_HDC2080_EVENT_ERROR 

Error event.

TWR_HDC2080_EVENT_UPDATE 

Update event.

Definition at line 13 of file twr_hdc2080.h.

Function Documentation

◆ twr_hdc2080_deinit()

void twr_hdc2080_deinit ( twr_hdc2080_t self)

Deinitialize HDC2080.

Parameters
[in]selfInstance

Definition at line 27 of file twr_hdc2080.c.

Here is the call graph for this function:

◆ twr_hdc2080_get_humidity_percentage()

bool twr_hdc2080_get_humidity_percentage ( twr_hdc2080_t self,
float *  percentage 
)

Get measured humidity as percentage.

Parameters
[in]selfInstance
[in]percentagePointer to variable where result will be stored
Returns
true When value is valid
false When value is invalid

Definition at line 84 of file twr_hdc2080.c.

Referenced by twr_tag_humidity_get_humidity_percentage().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ twr_hdc2080_get_humidity_raw()

bool twr_hdc2080_get_humidity_raw ( twr_hdc2080_t self,
uint16_t *  raw 
)

Get measured humidity as raw value.

Parameters
[in]selfInstance
[in]rawPointer to variable where result will be stored
Returns
true When value is valid
false When value is invalid

Definition at line 72 of file twr_hdc2080.c.

Referenced by twr_hdc2080_get_humidity_percentage(), and twr_tag_humidity_get_humidity_raw().

Here is the caller graph for this function:

◆ twr_hdc2080_get_temperature_celsius()

bool twr_hdc2080_get_temperature_celsius ( twr_hdc2080_t self,
float *  celsius 
)

Get measured temperature in degrees of Celsius.

Parameters
[in]selfInstance
[in]celsiusPointer to variable where result will be stored
Returns
true When value is valid
false When value is invalid

Definition at line 115 of file twr_hdc2080.c.

Referenced by twr_tag_humidity_get_temperature_celsius().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ twr_hdc2080_get_temperature_raw()

bool twr_hdc2080_get_temperature_raw ( twr_hdc2080_t self,
uint16_t *  raw 
)

Get measured temperature as raw value.

Parameters
[in]selfInstance
[in]rawPointer to variable where result will be stored
Returns
true When value is valid
false When value is invalid

Definition at line 103 of file twr_hdc2080.c.

Referenced by twr_hdc2080_get_temperature_celsius(), and twr_tag_humidity_get_temperature_raw().

Here is the caller graph for this function:

◆ twr_hdc2080_init()

void twr_hdc2080_init ( twr_hdc2080_t self,
twr_i2c_channel_t  i2c_channel,
uint8_t  i2c_address 
)

Initialize HDC2080.

Parameters
[in]selfInstance
[in]i2c_channelI2C channel
[in]i2c_addressI2C device address

Definition at line 12 of file twr_hdc2080.c.

Referenced by twr_tag_humidity_init().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ twr_hdc2080_measure()

bool twr_hdc2080_measure ( twr_hdc2080_t self)

Start measurement manually.

Parameters
[in]selfInstance
Returns
true On success
false When other measurement is in progress

Definition at line 58 of file twr_hdc2080.c.

Referenced by twr_hdc2080_get_temperature_celsius(), twr_hdc2080_set_update_interval(), and twr_tag_humidity_measure().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ twr_hdc2080_set_event_handler()

void twr_hdc2080_set_event_handler ( twr_hdc2080_t self,
void(*)(twr_hdc2080_t *, twr_hdc2080_event_t, void *)  event_handler,
void *  event_param 
)

Set callback function.

Parameters
[in]selfInstance
[in]event_handlerFunction address
[in]event_paramOptional event parameter (can be NULL)

Definition at line 36 of file twr_hdc2080.c.

Referenced by twr_tag_humidity_init().

Here is the caller graph for this function:

◆ twr_hdc2080_set_update_interval()

void twr_hdc2080_set_update_interval ( twr_hdc2080_t self,
twr_tick_t  interval 
)

Set measurement interval.

Parameters
[in]selfInstance
[in]intervalMeasurement interval

Definition at line 42 of file twr_hdc2080.c.

Referenced by twr_tag_humidity_set_update_interval().

Here is the call graph for this function:
Here is the caller graph for this function: