rmeter  2.0.0.0
Functions
Public function

Functions

void rmeter_cfg_setup (rmeter_cfg_t *cfg)
 Config Object Initialization function. More...
 
RMETER_RETVAL rmeter_init (rmeter_t *ctx, rmeter_cfg_t *cfg)
 Initialization function. More...
 
void rmeter_range_s1 (rmeter_t *ctx, uint8_t state)
 S1 defined range function. More...
 
void rmeter_range_s2 (rmeter_t *ctx, uint8_t state)
 S2 defined range function. More...
 
void rmeter_range_s3 (rmeter_t *ctx, uint8_t state)
 S3 defined range function. More...
 
uint16_t rmeter_read_data (rmeter_t *ctx)
 Data read function. More...
 
uint16_t rmeter_get_volage (rmeter_t *ctx)
 Get voltage function. More...
 
float rmeter_avg_volt (rmeter_t *ctx)
 Get average voltage function. More...
 
float rmeter_calc (rmeter_t *ctx, uint32_t resFilt)
 Calculations function. More...
 
float rmeter_get_ohms (rmeter_t *ctx)
 Get resistance in OHMs function. More...
 

Detailed Description

Function Documentation

◆ rmeter_avg_volt()

float rmeter_avg_volt ( rmeter_t ctx)

Get average voltage function.

Parameters
ctxClick object.
Returns
result value that represents average voltage value

Function is used to calculate average voltage.

Note
Function calculates average value from 10 sample values and holds small 100 miliseconds delay.

◆ rmeter_calc()

float rmeter_calc ( rmeter_t ctx,
uint32_t  resFilt 
)

Calculations function.

Parameters
ctxClick object.
resFiltcompensation needed to calculate resistance.
Returns
rsem float value that represents calculations.

Function is used to calculate raw resistance value based on constant current of 100mA and voltage that changes depending on resistance.

◆ rmeter_cfg_setup()

void rmeter_cfg_setup ( rmeter_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ rmeter_get_ohms()

float rmeter_get_ohms ( rmeter_t ctx)

Get resistance in OHMs function.

Parameters
ctxClick object.
Returns
result float value that represents resistance.

Function is used to measure resistance of a resistor conected to the click board.

◆ rmeter_get_volage()

uint16_t rmeter_get_volage ( rmeter_t ctx)

Get voltage function.

Parameters
ctxClick object.
Returns
result value that represents raw voltage value.

Function is used to read voltage.

◆ rmeter_init()

RMETER_RETVAL rmeter_init ( rmeter_t ctx,
rmeter_cfg_t cfg 
)

Initialization function.

Parameters
rmeterClick object.
cfgClick configuration structure.

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

◆ rmeter_range_s1()

void rmeter_range_s1 ( rmeter_t ctx,
uint8_t  state 
)

S1 defined range function.

Parameters
ctxClick object.
stateSelect or deselect value.

Function is used to set or clear s1 pin in order to select or deselect apropriate range of readings.

Note
Setting this pin defines range 0 - 1kOhm.

◆ rmeter_range_s2()

void rmeter_range_s2 ( rmeter_t ctx,
uint8_t  state 
)

S2 defined range function.

Parameters
ctxClick object.
stateSelect or deselect value.

Function is used to set or clear s2 pin in order to select or deselect apropriate range of readings.

Note
Setting this pin defines range 1kOhm - 100kOhm.

◆ rmeter_range_s3()

void rmeter_range_s3 ( rmeter_t ctx,
uint8_t  state 
)

S3 defined range function.

Parameters
ctxClick object.
stateSelect or deselect value.

Function is used to set or clear s3 pin in order to select or deselect apropriate range of readings.

Note
Setting this pin defines range 100kOhm - 1MOhm.

◆ rmeter_read_data()

uint16_t rmeter_read_data ( rmeter_t ctx)

Data read function.

Parameters
ctxClick object.
Returns
16-bit value that represents readings from output register.

Function is used to read raw data from output register.