vacuum  2.0.0.0
Functions
Public function

Functions

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

Detailed Description

Function Documentation

◆ vacuum_calibration()

void vacuum_calibration ( vacuum_t ctx)

Sensor calibration.

Parameters
ctxClick object.

This function sensor calibration.

◆ vacuum_cfg_setup()

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

◆ vacuum_default_cfg()

void vacuum_default_cfg ( vacuum_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for Vacuum click.

◆ vacuum_generic_read()

void vacuum_generic_read ( vacuum_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
data_bufOutput data buf
lenNumber of the bytes to be read

This function reads data from the desired register.

◆ vacuum_generic_write()

void vacuum_generic_write ( vacuum_t ctx,
uint8_t  reg,
uint8_t *  data_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
data_bufData buf to be written.
lenNumber of the bytes in data buf.

This function writes data to the desired register.

◆ 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.

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.

This function gets pressure.

◆ vacuum_get_voltage()

float vacuum_get_voltage ( vacuum_t ctx)

Voltage reading function.

Parameters
ctxClick object.

This function gets voltage.

◆ vacuum_init()

VACCUM_RETVAL vacuum_init ( vacuum_t ctx,
vacuum_cfg_t cfg 
)

Initialization function.

Parameters
vacuumClick object.
cfgClick configuration structure.

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.

This function reads data.