adc6  2.0.0.0
Functions
Public function

Functions

void adc6_cfg_setup (adc6_cfg_t *cfg)
 Config Object Initialization function. More...
 
ADC6_RETVAL adc6_init (adc6_t *ctx, adc6_cfg_t *cfg)
 Initialization function. More...
 
void adc6_default_cfg (adc6_t *ctx)
 Click Default Configuration function. More...
 
void adc6_reset_device (adc6_t *ctx)
 Reset device. More...
 
uint32_t adc6_get_adc_data (adc6_t *ctx, const uint8_t mode)
 Get data function. More...
 
uint32_t adc6_continuous_read_data (adc6_t *ctx)
 Continuous read function. More...
 
uint32_t adc6_read_reg (adc6_t *ctx, const uint8_t register_address)
 Generic read function. More...
 
void adc6_write_reg (adc6_t *ctx, const uint8_t register_address, const uint32_t transfer_data)
 Generic write function. More...
 

Detailed Description

Function Documentation

◆ adc6_cfg_setup()

void adc6_cfg_setup ( adc6_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.

◆ adc6_continuous_read_data()

uint32_t adc6_continuous_read_data ( adc6_t ctx)

Continuous read function.

Parameters
ctxClick object.
Returns
Data from Data register.

@description This function continuously reads data from Data register without writting anything on SPI.

◆ adc6_default_cfg()

void adc6_default_cfg ( adc6_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for ADC6 Click.

◆ adc6_get_adc_data()

uint32_t adc6_get_adc_data ( adc6_t ctx,
const uint8_t  mode 
)

Get data function.

Parameters
ctxClick object.
mode0 - single read mode, 1 - continuous read mode.
Returns
Data from Data register.

@description This function gets data from Data register in two possible modes. In single read mode first checks ready bit, and when conversion is done (data is ready) reads data from register. In continuous read mode only reads data without writting anything on SPI bus.

◆ adc6_init()

ADC6_RETVAL adc6_init ( adc6_t ctx,
adc6_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ adc6_read_reg()

uint32_t adc6_read_reg ( adc6_t ctx,
const uint8_t  register_address 
)

Generic read function.

Parameters
ctxClick object.
register_addressRegister address.
Returns
Data from determined register.

@description This function reads data from determined register.

◆ adc6_reset_device()

void adc6_reset_device ( adc6_t ctx)

Reset device.

Parameters
ctxClick object.

@description This function resets device and puts device back to normal operation mode.

◆ adc6_write_reg()

void adc6_write_reg ( adc6_t ctx,
const uint8_t  register_address,
const uint32_t  transfer_data 
)

Generic write function.

Parameters
ctxClick object.
register_addressRegister address.

@description This function writes data to determined register.