digipot2  2.0.0.0
Functions

Functions

void digipot2_cfg_setup (digipot2_cfg_t *cfg)
 Config Object Initialization function. More...
 
DIGIPOT2_RETVAL digipot2_init (digipot2_t *ctx, digipot2_cfg_t *cfg)
 Initialization function. More...
 
void digipot2_generic_transfer (digipot2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void digipot2_write_byte (digipot2_t *ctx, uint8_t command, uint8_t write_data)
 Generic write 8-bit data function. More...
 
void digipot2_set_wiper_positions (digipot2_t *ctx, uint8_t wiper_positions)
 Set 8-bit wiper positions. More...
 
float digipot2_convert_output (digipot2_t *ctx, uint16_t value_adc, float v_ref)
 Convert ADC value to volatage. More...
 

Detailed Description

Function Documentation

◆ digipot2_cfg_setup()

void digipot2_cfg_setup ( digipot2_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.

◆ digipot2_convert_output()

float digipot2_convert_output ( digipot2_t ctx,
uint16_t  value_adc,
float  v_ref 
)

Convert ADC value to volatage.

Parameters
ctxClick object.
value_adc10-bit ADC value.
v_refVoltage Reference 3.3V or 5V.
Returns
float voltage ( 0V - 3.3V ) or ( 0V - 5.0V ).

@description Convert 10-bit ADC value to volatage.

◆ digipot2_generic_transfer()

void digipot2_generic_transfer ( digipot2_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

◆ digipot2_init()

DIGIPOT2_RETVAL digipot2_init ( digipot2_t ctx,
digipot2_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ digipot2_set_wiper_positions()

void digipot2_set_wiper_positions ( digipot2_t ctx,
uint8_t  wiper_positions 
)

Set 8-bit wiper positions.

Parameters
ctxClick object.
wiper_positions8-bit wiper positions data.

@description Function set 8-bit wiper positions data via SPI on the TPL0501 chip register.

◆ digipot2_write_byte()

void digipot2_write_byte ( digipot2_t ctx,
uint8_t  command,
uint8_t  write_data 
)

Generic write 8-bit data function.

Parameters
ctxClick object.
command8-bit data address command.
write_data8-bit data to write.

@description Function write 8-bit data via SPI on the TPL0501 chip register.