Firmware SDK
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
bc_hdc2080

Driver for HDC2080 humidity sensor. More...

Typedefs

typedef struct bc_hdc2080_t bc_hdc2080_t
 HDC2080 instance.
 

Enumerations

enum  bc_hdc2080_event_t {
  BC_HDC2080_EVENT_ERROR = 0,
  BC_HDC2080_EVENT_UPDATE = 1
}
 Callback events. More...
 

Functions

void bc_hdc2080_init (bc_hdc2080_t *self, bc_i2c_channel_t i2c_channel, uint8_t i2c_address)
 Initialize HDC2080. More...
 
void bc_hdc2080_set_event_handler (bc_hdc2080_t *self, void(*event_handler)(bc_hdc2080_t *, bc_hdc2080_event_t, void *), void *event_param)
 Set callback function. More...
 
void bc_hdc2080_set_update_interval (bc_hdc2080_t *self, bc_tick_t interval)
 Set measurement interval. More...
 
bool bc_hdc2080_measure (bc_hdc2080_t *self)
 Start measurement manually. More...
 
bool bc_hdc2080_get_humidity_raw (bc_hdc2080_t *self, uint16_t *raw)
 Get measured humidity as raw value. More...
 
bool bc_hdc2080_get_humidity_percentage (bc_hdc2080_t *self, float *percentage)
 Get measured humidity as percentage. More...
 
bool bc_hdc2080_get_temperature_raw (bc_hdc2080_t *self, uint16_t *raw)
 Get measured temperature as raw value. More...
 
bool bc_hdc2080_get_temperature_celsius (bc_hdc2080_t *self, float *celsius)
 Get measured temperature in degrees of Celsius. More...
 

Detailed Description

Driver for HDC2080 humidity sensor.

Enumeration Type Documentation

Callback events.

Enumerator
BC_HDC2080_EVENT_ERROR 

Error event.

BC_HDC2080_EVENT_UPDATE 

Update event.

Definition at line 13 of file bc_hdc2080.h.

Function Documentation

bool bc_hdc2080_get_humidity_percentage ( bc_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 75 of file bc_hdc2080.c.

Referenced by bc_tag_humidity_get_humidity_percentage().

Here is the call graph for this function:

Here is the caller graph for this function:

bool bc_hdc2080_get_humidity_raw ( bc_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 63 of file bc_hdc2080.c.

Referenced by bc_hdc2080_get_humidity_percentage(), and bc_tag_humidity_get_humidity_raw().

Here is the caller graph for this function:

bool bc_hdc2080_get_temperature_celsius ( bc_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 106 of file bc_hdc2080.c.

Referenced by bc_tag_humidity_get_temperature_celsius().

Here is the call graph for this function:

Here is the caller graph for this function:

bool bc_hdc2080_get_temperature_raw ( bc_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 94 of file bc_hdc2080.c.

Referenced by bc_hdc2080_get_temperature_celsius(), and bc_tag_humidity_get_temperature_raw().

Here is the caller graph for this function:

void bc_hdc2080_init ( bc_hdc2080_t self,
bc_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 bc_hdc2080.c.

Referenced by bc_tag_humidity_init().

Here is the call graph for this function:

Here is the caller graph for this function:

bool bc_hdc2080_measure ( bc_hdc2080_t self)

Start measurement manually.

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

Definition at line 49 of file bc_hdc2080.c.

Referenced by bc_hdc2080_set_update_interval(), and bc_tag_humidity_measure().

Here is the call graph for this function:

Here is the caller graph for this function:

void bc_hdc2080_set_event_handler ( bc_hdc2080_t self,
void(*)(bc_hdc2080_t *, bc_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 27 of file bc_hdc2080.c.

Referenced by bc_tag_humidity_init().

Here is the caller graph for this function:

void bc_hdc2080_set_update_interval ( bc_hdc2080_t self,
bc_tick_t  interval 
)

Set measurement interval.

Parameters
[in]selfInstance
[in]intervalMeasurement interval

Definition at line 33 of file bc_hdc2080.c.

Referenced by bc_tag_humidity_set_update_interval().

Here is the call graph for this function:

Here is the caller graph for this function: