accurrent  2.0.0.0
Functions

Functions

void accurrent_cfg_setup (accurrent_cfg_t *cfg)
 Config Object Initialization function. More...
 
ACCURRENT_RETVAL accurrent_init (accurrent_t *ctx, accurrent_cfg_t *cfg)
 Initialization function. More...
 
void accurrent_generic_transfer (accurrent_t *ctx, spi_master_transfer_data_t *block)
 Generic transfer function. More...
 
float accurrent_get_ma (accurrent_t *ctx)
 Gets current value of AC Current in mA. More...
 
float accurrent_get_a (accurrent_t *ctx)
 Gets current value of AC Current in A. More...
 

Detailed Description

Function Documentation

◆ accurrent_cfg_setup()

void accurrent_cfg_setup ( accurrent_cfg_t cfg)

Config Object Initialization function.

Parameters
cfgClick configuration structure.

This function initializes click configuration structure to init state.

Note
All used pins will be set to unconnected state.

◆ accurrent_generic_transfer()

void accurrent_generic_transfer ( accurrent_t ctx,
spi_master_transfer_data_t *  block 
)

Generic transfer function.

Parameters
ctxClick object.
blockTransfer block structure.

Generic SPI transfer, for sending and receiving packages

◆ accurrent_get_a()

float accurrent_get_a ( accurrent_t ctx)

Gets current value of AC Current in A.

Parameters
ctxClick object.

Returns float value of current in A.

◆ accurrent_get_ma()

float accurrent_get_ma ( accurrent_t ctx)

Gets current value of AC Current in mA.

Parameters
ctxClick object.

Returns float value of current in mA.

◆ accurrent_init()

ACCURRENT_RETVAL accurrent_init ( accurrent_t ctx,
accurrent_cfg_t cfg 
)

Initialization function.

Parameters
accurrentClick object.
cfgClick configuration structure.

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