linhall  2.0.0.0
Functions
Public function

Functions

void linhall_cfg_setup (linhall_cfg_t *cfg)
 Config Object Initialization function. More...
 
LINHALL_RETVAL linhall_init (linhall_t *ctx, linhall_cfg_t *cfg)
 Initialization function. More...
 
void linhall_generic_transfer (linhall_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
uint16_t linhall_read_data (linhall_t *ctx)
 Read 12-bit data function. More...
 

Detailed Description

Function Documentation

◆ linhall_cfg_setup()

void linhall_cfg_setup ( linhall_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.

◆ linhall_generic_transfer()

void linhall_generic_transfer ( linhall_t ctx,
uint8_t *  wr_buf,
uint16_t  wr_len,
uint8_t *  rd_buf,
uint16_t  rd_len 
)

Generic transfer function.

Parameters
ctxClick object.
wr_bufWrite data buffer
wr_lenNumber of byte in write data buffer
rd_bufRead data buffer
rd_lenNumber of byte in read data buffer

@description Generic SPI transfer, for sending and receiving packages

◆ linhall_init()

LINHALL_RETVAL linhall_init ( linhall_t ctx,
linhall_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ linhall_read_data()

uint16_t linhall_read_data ( linhall_t ctx)

Read 12-bit data function.

Parameters
ctxClick object.
Returns
12-bit ADC value.

@description Function read 12-bit ADC value from the MCP3201 chip.