vacuum 2.0.0.0
Public function

Functions

void vacuum_cfg_setup (vacuum_cfg_t *cfg)
 Config Object Initialization function.
 
VACCUM_RETVAL vacuum_init (vacuum_t *ctx, vacuum_cfg_t *cfg)
 Initialization function.
 
void vacuum_default_cfg (vacuum_t *ctx)
 Click Default Configuration function.
 
uint16_t vacuum_read_data (vacuum_t *ctx)
 Function for reads 12 bit ADC data.
 
float vacuum_get_voltage (vacuum_t *ctx)
 Voltage reading function.
 
float vacuum_get_pressure (vacuum_t *ctx)
 Function for converting ADC value to pressure data.
 
float vacuum_get_percentage_of_vacuum (vacuum_t *ctx)
 Function for converting ADC value to percentage of Vacuum.
 
void vacuum_calibration (vacuum_t *ctx)
 Sensor calibration.
 

Detailed Description

Function Documentation

◆ vacuum_calibration()

void vacuum_calibration ( vacuum_t * ctx)

Sensor calibration.

Parameters
ctxClick object.

@description This function sensor calibration.

◆ vacuum_cfg_setup()

void vacuum_cfg_setup ( vacuum_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.

◆ vacuum_default_cfg()

void vacuum_default_cfg ( vacuum_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Vacuum click.

◆ vacuum_get_percentage_of_vacuum()

float vacuum_get_percentage_of_vacuum ( vacuum_t * ctx)

Function for converting ADC value to percentage of Vacuum.

Parameters
ctxClick object.

@description This function gets percentage of vacuum.

◆ vacuum_get_pressure()

float vacuum_get_pressure ( vacuum_t * ctx)

Function for converting ADC value to pressure data.

Parameters
ctxClick object.

@description This function gets pressure.

◆ vacuum_get_voltage()

float vacuum_get_voltage ( vacuum_t * ctx)

Voltage reading function.

Parameters
ctxClick object.

@description This function gets voltage.

◆ vacuum_init()

VACCUM_RETVAL vacuum_init ( vacuum_t * ctx,
vacuum_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ vacuum_read_data()

uint16_t vacuum_read_data ( vacuum_t * ctx)

Function for reads 12 bit ADC data.

Parameters
ctxClick object.

@description This function reads data.