Firmware SDK
twr_tag_barometer

Driver for HARDWARIO Barometer Module. More...

Typedefs

typedef twr_mpl3115a2_t twr_tag_barometer_t
 HARDWARIO Barometer Module instance.
 

Enumerations

enum  twr_tag_barometer_event_t {
  TWR_TAG_BAROMETER_EVENT_ERROR = TWR_MPL3115A2_EVENT_ERROR,
  TWR_TAG_BAROMETER_EVENT_UPDATE = TWR_MPL3115A2_EVENT_UPDATE
}
 Callback events. More...
 

Functions

void twr_tag_barometer_init (twr_tag_barometer_t *self, twr_i2c_channel_t i2c_channel)
 Initialize HARDWARIO Barometer Module. More...
 
void twr_tag_barometer_set_event_handler (twr_tag_barometer_t *self, void(*event_handler)(twr_tag_barometer_t *, twr_tag_barometer_event_t, void *), void *event_param)
 Set callback function. More...
 
void twr_tag_barometer_set_update_interval (twr_tag_barometer_t *self, twr_tick_t interval)
 Set measurement interval. More...
 
bool twr_tag_barometer_measure (twr_tag_barometer_t *self)
 Start measurement manually. More...
 
bool twr_tag_barometer_get_altitude_meter (twr_tag_barometer_t *self, float *meter)
 Get measured altitude in meters. More...
 
bool twr_tag_barometer_get_pressure_pascal (twr_tag_barometer_t *self, float *pascal)
 Get measured pressure in Pascal. More...
 

Detailed Description

Driver for HARDWARIO Barometer Module.

Enumeration Type Documentation

◆ twr_tag_barometer_event_t

Callback events.

Enumerator
TWR_TAG_BAROMETER_EVENT_ERROR 

Error event.

TWR_TAG_BAROMETER_EVENT_UPDATE 

Update event.

Definition at line 12 of file twr_tag_barometer.h.

Function Documentation

◆ twr_tag_barometer_get_altitude_meter()

bool twr_tag_barometer_get_altitude_meter ( twr_tag_barometer_t self,
float *  meter 
)

Get measured altitude in meters.

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

Definition at line 23 of file twr_tag_barometer.c.

Here is the call graph for this function:

◆ twr_tag_barometer_get_pressure_pascal()

bool twr_tag_barometer_get_pressure_pascal ( twr_tag_barometer_t self,
float *  pascal 
)

Get measured pressure in Pascal.

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

Definition at line 28 of file twr_tag_barometer.c.

Here is the call graph for this function:

◆ twr_tag_barometer_init()

void twr_tag_barometer_init ( twr_tag_barometer_t self,
twr_i2c_channel_t  i2c_channel 
)

Initialize HARDWARIO Barometer Module.

Parameters
[in]selfInstance
[in]i2c_channelI2C channel

Definition at line 3 of file twr_tag_barometer.c.

Here is the call graph for this function:

◆ twr_tag_barometer_measure()

bool twr_tag_barometer_measure ( twr_tag_barometer_t self)

Start measurement manually.

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

Definition at line 18 of file twr_tag_barometer.c.

Here is the call graph for this function:

◆ twr_tag_barometer_set_event_handler()

void twr_tag_barometer_set_event_handler ( twr_tag_barometer_t self,
void(*)(twr_tag_barometer_t *, twr_tag_barometer_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 8 of file twr_tag_barometer.c.

Here is the call graph for this function:

◆ twr_tag_barometer_set_update_interval()

void twr_tag_barometer_set_update_interval ( twr_tag_barometer_t self,
twr_tick_t  interval 
)

Set measurement interval.

Parameters
[in]selfInstance
[in]intervalMeasurement interval

Definition at line 13 of file twr_tag_barometer.c.

Here is the call graph for this function: