altitude4  2.0.0.0
Functions

Functions

void altitude4_cfg_setup (altitude4_cfg_t *cfg)
 Config Object Initialization function. More...
 
ALTITUDE4_RETVAL altitude4_init (altitude4_t *ctx, altitude4_cfg_t *cfg)
 Initialization function. More...
 
void altitude4_generic_read (altitude4_t *ctx, uint8_t reg, uint8_t *r_buf, uint8_t len)
 Generic read function. More...
 
void altitude4_generic_write (altitude4_t *ctx, uint8_t reg, uint8_t *w_buf, uint8_t len)
 Generic write function. More...
 
uint8_t altitude4_read_sensor (altitude4_t *ctx, altitude4_sensor_t *sens_data)
 Read sensor function. More...
 

Detailed Description

Function Documentation

◆ altitude4_cfg_setup()

void altitude4_cfg_setup ( altitude4_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.

◆ altitude4_generic_read()

void altitude4_generic_read ( altitude4_t ctx,
uint8_t  reg,
uint8_t *  r_buf,
uint8_t  len 
)

Generic read function.

Parameters
ctxClick object.
regRegister address.
r_bufRead buffer.
lenRead data size.

@description This function stores the len amount of data into the r_buf. The data is read from the address reg.

◆ altitude4_generic_write()

void altitude4_generic_write ( altitude4_t ctx,
uint8_t  reg,
uint8_t *  w_buf,
uint8_t  len 
)

Generic write function.

Parameters
ctxClick object.
regRegister address.
w_bufWrite buffer.
lenRead data size.

@description This function writes the len amount of data from the w_buf to the address reg.

◆ altitude4_init()

ALTITUDE4_RETVAL altitude4_init ( altitude4_t ctx,
altitude4_cfg_t cfg 
)

Initialization function.

Parameters
altitude4Click object.
cfgClick configuration structure.

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

◆ altitude4_read_sensor()

uint8_t altitude4_read_sensor ( altitude4_t ctx,
altitude4_sensor_t sens_data 
)

Read sensor function.

Parameters
ctxClick object.
sens_dataSensor data object.

@description This function acquires sensor data from the Click module and stores it in the sensor data object.