NHS31xx SW API

Detailed Description

The periodic measurements block shields the tmeas: Temperature measurement module module and the humid: Humidity sensor module module from the rest of the application. it also implements the callback TMEAS_CB as set in app_sel.h

Functions

void Periodics_ResetTemperature (void)
 
int Periodics_MeasureTemperature (TSEN_RESOLUTION_T resolution, bool requestedExternally)
 
int Periodics_GetTemperature (void)
 
unsigned int Periodics_MeasureHumidity (void)
 
unsigned int Periodics_GetHumidity (void)
 

Function Documentation

◆ Periodics_ResetTemperature()

void Periodics_ResetTemperature ( void  )

Sets the cached value to APP_MSG_TEMPERATURE_PLACEHOLDER_VALUE.

◆ Periodics_MeasureTemperature()

int Periodics_MeasureTemperature ( TSEN_RESOLUTION_T  resolution,
bool  requestedExternally 
)

Wrapper around TMeas_Measure.

Parameters
resolutionSee TMeas_Measure
requestedExternally
Returns
See TMeas_Measure

◆ Periodics_GetTemperature()

int Periodics_GetTemperature ( void  )
  • If a temperature measurement is ongoing: waits until the conversion is ready, and returns that last measured value.
  • Else: returns the last cached value: either a temperature value, or APP_MSG_TEMPERATURE_PLACEHOLDER_VALUE
Precondition
Periodics_MeasureTemperature has been called at least once.
Returns
the last measured temperature. Expressed in deci-celsius.

◆ Periodics_MeasureHumidity()

unsigned int Periodics_MeasureHumidity ( void  )

Starts up the humidity sensor, initiates a measurement, waits for its completion, and returns the measured result.

Warning
This call is blocking and takes a long time to complete: a little over 2 * HUMID_RESET_WAIT_TIME + HUMID_MEASURE_WAIT_TIME ms.
Returns
The measured humidity. Expressed in deci-percentage.

◆ Periodics_GetHumidity()

unsigned int Periodics_GetHumidity ( void  )

If Periodics_MeasureHumidity has been called beforehand: returns the last cached value. Else, returns 0.

Returns
The last measured humidity. Expressed in deci-percentage.