force 2.0.0.0
Public function

Functions

void force_cfg_setup (force_cfg_t *cfg)
 Config Object Initialization function.
 
FORCE_RETVAL force_init (force_t *ctx, force_cfg_t *cfg)
 Initialization function.
 
force_data_t force_generic_read (force_t *ctx)
 Generic read function.
 
float force_get_correction_factor (float temperature, float humidity)
 Get correction factor function.
 
float force_get_resistance (uint32_t adc_value)
 Get resistance function.
 
float force_get_corrected_resistance (float temperature, float humidity, uint32_t adc_value)
 Get corrected resistance function.
 

Detailed Description

Function Documentation

◆ force_cfg_setup()

void force_cfg_setup ( force_cfg_t * cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

@description This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ force_generic_read()

force_data_t force_generic_read ( force_t * ctx)

Generic read function.

Parameters
ctxClick object.
Returns
ADC data

@description This function reads ADC data.

◆ force_get_corrected_resistance()

float force_get_corrected_resistance ( float temperature,
float humidity,
uint32_t adc_value )

Get corrected resistance function.

Parameters
temperatureTemperature value.
humidityHumidity value.
adc_valueADC value.

@description This function calculates corrected resistance data based on the ADC input.

◆ force_get_correction_factor()

float force_get_correction_factor ( float temperature,
float humidity )

Get correction factor function.

Parameters
temperatureTemperature value.
humidityHumidity value.

@description This function calculates the correction factor based on temperature and humidity data.

◆ force_get_resistance()

float force_get_resistance ( uint32_t adc_value)

Get resistance function.

Parameters
adc_valueADC value.

@description This function calculates resistance data based on the ADC input.

◆ force_init()

FORCE_RETVAL force_init ( force_t * ctx,
force_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

@description This function initializes all necessary pins and peripherals used for this click.