waveform 2.0.0.0
Public function

Functions

void waveform_cfg_setup (waveform_cfg_t *cfg)
 Config Object Initialization function.
 
err_t waveform_init (waveform_t *ctx, waveform_cfg_t *cfg)
 Initialization function.
 
void waveform_digipot_dec (waveform_t *ctx)
 Decrement function.
 
void waveform_digipot_inc (waveform_t *ctx)
 Increment function.
 
void waveform_write_reg (waveform_t *ctx, uint16_t reg_setting)
 Registry function.
 
void waveform_write_frequency (waveform_t *ctx, uint32_t freq)
 Frequency function.
 
void waveform_sine_output (waveform_t *ctx, uint32_t freq)
 Sinusoide output function.
 
void waveform_triangle_output (waveform_t *ctx, uint32_t freq)
 Triangle output function.
 
void waveform_square_output (waveform_t *ctx, uint32_t freq)
 Square output function.
 

Detailed Description

Function Documentation

◆ waveform_cfg_setup()

void waveform_cfg_setup ( waveform_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.

◆ waveform_digipot_dec()

void waveform_digipot_dec ( waveform_t * ctx)

Decrement function.

Parameters
ctxClick object.

This function decreases amplitude.

◆ waveform_digipot_inc()

void waveform_digipot_inc ( waveform_t * ctx)

Increment function.

Parameters
ctxClick object.

This function increases amplitude.

◆ waveform_init()

err_t waveform_init ( waveform_t * ctx,
waveform_cfg_t * cfg )

Initialization function.

Parameters
waveformClick object.
cfgClick configuration structure.

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

◆ waveform_sine_output()

void waveform_sine_output ( waveform_t * ctx,
uint32_t freq )

Sinusoide output function.

Parameters
ctxClick object.
freqSet the frequency by passing the raw 24bit value.

This function outputs sinusoide signal.

◆ waveform_square_output()

void waveform_square_output ( waveform_t * ctx,
uint32_t freq )

Square output function.

Parameters
ctxClick object.
freqSet the frequency by passing the raw 24bit value.

This function outputs square signal.

◆ waveform_triangle_output()

void waveform_triangle_output ( waveform_t * ctx,
uint32_t freq )

Triangle output function.

Parameters
ctxClick object.
freqSet the frequency by passing the raw 24bit value.

This function outputs triangle signal.

◆ waveform_write_frequency()

void waveform_write_frequency ( waveform_t * ctx,
uint32_t freq )

Frequency function.

Parameters
ctxClick object.
freqSet the frequency by passing the raw 24bit value.

This function sets frequency.

◆ waveform_write_reg()

void waveform_write_reg ( waveform_t * ctx,
uint16_t reg_setting )

Registry function.

Parameters
ctxClick object.
reg_settingGeneric SPI function for writing 16bit values to the waveform generating chip.