boostinv2 2.0.0.0
Public function

Functions

void boostinv2_cfg_setup (boostinv2_cfg_t *cfg)
 Config Object Initialization function.
 
BOOSTONV2_RETVAL boostinv2_init (boostinv2_t *ctx, boostinv2_cfg_t *cfg)
 Initialization function.
 
void boostinv2_default_cfg (boostinv2_t *ctx)
 Click Default Configuration function.
 
void boostinv2_generic_transfer (boostinv2_t *ctx, uint8_t *wr_buf, uint16_t wr_len, uint8_t *rd_buf, uint16_t rd_len)
 Generic transfer function.
 
void boostinv2_enable (boostinv2_t *ctx)
 Enable analog pin.
 
void boostinv2_set_positive_voltage (boostinv2_t *ctx, uint16_t voltage)
 Sets postive voltage.
 
void boostinv2_set_negative_voltage (boostinv2_t *ctx, uint16_t voltage)
 Sets negative voltage.
 
void boostinv2_set_psn (boostinv2_t *ctx, uint8_t state)
 Sets PSN depending on input state.
 

Detailed Description

Function Documentation

◆ boostinv2_cfg_setup()

void boostinv2_cfg_setup ( boostinv2_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.

◆ boostinv2_default_cfg()

void boostinv2_default_cfg ( boostinv2_t * ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for Boost-inv 2 click.

◆ boostinv2_enable()

void boostinv2_enable ( boostinv2_t * ctx)

Enable analog pin.

Parameters
ctxClick object.

@description Enables analog pin for 200ms.

◆ boostinv2_generic_transfer()

void boostinv2_generic_transfer ( boostinv2_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

◆ boostinv2_init()

BOOSTONV2_RETVAL boostinv2_init ( boostinv2_t * ctx,
boostinv2_cfg_t * cfg )

Initialization function.

Parameters
boostinv2Click object.
cfgClick configuration structure.

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

◆ boostinv2_set_negative_voltage()

void boostinv2_set_negative_voltage ( boostinv2_t * ctx,
uint16_t voltage )

Sets negative voltage.

Parameters
ctxClick object.
volatageuint16_t.

@description Sets negative voltage via SPI communication..

◆ boostinv2_set_positive_voltage()

void boostinv2_set_positive_voltage ( boostinv2_t * ctx,
uint16_t voltage )

Sets postive voltage.

Parameters
ctxClick object.
volatageuint16_t

@description Sets positive voltage via SPI communication..

◆ boostinv2_set_psn()

void boostinv2_set_psn ( boostinv2_t * ctx,
uint8_t state )

Sets PSN depending on input state.

Parameters
ctxClick object.
stateuint8_t.

@description Sets psn pin on high or low depending on input.