digipot  2.0.0.0
Functions
Public function

Functions

void digipot_cfg_setup (digipot_cfg_t *cfg)
 Config Object Initialization function. More...
 
DIGIPOT_RETVAL digipot_init (digipot_t *ctx, digipot_cfg_t *cfg)
 Initialization function. More...
 
void digipot_generic_transfer (digipot_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function. More...
 
void digipot_set_wiper_positions (digipot_t *ctx, uint8_t wiper_pos)
 Set wiper position. More...
 
float digipot_convert_output (uint16_t adc_val, float v_ref)
 Convert ADC value to volatage. More...
 

Detailed Description

Function Documentation

◆ digipot_cfg_setup()

void digipot_cfg_setup ( digipot_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.

◆ digipot_convert_output()

float digipot_convert_output ( uint16_t  adc_val,
float  v_ref 
)

Convert ADC value to volatage.

Parameters
adc_val10-bit ADC value.
wiper_posfloat voltage reference: 3.3V or 5V.
Returns
float voltage ( 0V - 3.3V ) or ( 0V - 5.0V ).

@description The function convert 10-bit ADC value to volatage reference.

◆ digipot_generic_transfer()

void digipot_generic_transfer ( digipot_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

◆ digipot_init()

DIGIPOT_RETVAL digipot_init ( digipot_t ctx,
digipot_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ digipot_set_wiper_positions()

void digipot_set_wiper_positions ( digipot_t ctx,
uint8_t  wiper_pos 
)

Set wiper position.

Parameters
ctxClick object.
wiper_posuint8_t wiper positions data.

@description The function sets 8-bit wiper positions data.