c2x30wamp 2.0.0.0

Functions

void c2x30wamp_cfg_setup (c2x30wamp_cfg_t *cfg)
 Config Object Initialization function.
 
C2X30WAMP_RETVAL c2x30wamp_init (c2x30wamp_t *ctx, c2x30wamp_cfg_t *cfg)
 Initialization function.
 
void c2x30wamp_enable (c2x30wamp_t *ctx, uint8_t state)
 Device Enable function.
 
void c2x30wamp_mute (c2x30wamp_t *ctx, uint8_t state)
 Device Mute function.
 
uint8_t c2x30wamp_check_diagnostic (c2x30wamp_t *ctx)
 Diagnostic Check function.
 

Detailed Description

Function Documentation

◆ c2x30wamp_cfg_setup()

void c2x30wamp_cfg_setup ( c2x30wamp_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.

◆ c2x30wamp_check_diagnostic()

uint8_t c2x30wamp_check_diagnostic ( c2x30wamp_t * ctx)

Diagnostic Check function.

Parameters
ctxClick object.
Returns
0 - Fault condition, 1 - Normal operation

@description Function checks is the device in fault condition or in normal operation state.

◆ c2x30wamp_enable()

void c2x30wamp_enable ( c2x30wamp_t * ctx,
uint8_t state )

Device Enable function.

Parameters
ctxClick object.
state0 - Disable, 1 - Enable

@description Function allows the device to be enabled or disabled.

◆ c2x30wamp_init()

C2X30WAMP_RETVAL c2x30wamp_init ( c2x30wamp_t * ctx,
c2x30wamp_cfg_t * cfg )

Initialization function.

Parameters
c2x30wampClick object.
cfgClick configuration structure.

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

◆ c2x30wamp_mute()

void c2x30wamp_mute ( c2x30wamp_t * ctx,
uint8_t state )

Device Mute function.

Parameters
ctxClick object.
state0 - Unmute, 1 - Mute

@description Function performs the mute or the unmute operation.