vreg2  2.0.0.0
Functions
Public function

Functions

void vreg2_cfg_setup (vreg2_cfg_t *cfg)
 Config Object Initialization function. More...
 
VREG2_RETVAL vreg2_init (vreg2_t *ctx, vreg2_cfg_t *cfg)
 Initialization function. More...
 
void vreg2_default_cfg (vreg2_t *ctx)
 Click Default Configuration function. More...
 
void vreg2_set_duty_cycle (vreg2_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void vreg2_pwm_stop (vreg2_t *ctx)
 Stop PWM module. More...
 
void vreg2_pwm_start (vreg2_t *ctx)
 Start PWM module. More...
 

Detailed Description

Function Documentation

◆ vreg2_cfg_setup()

void vreg2_cfg_setup ( vreg2_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.

◆ vreg2_default_cfg()

void vreg2_default_cfg ( vreg2_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

This function executes default configuration for Vreg2 click.

◆ vreg2_init()

VREG2_RETVAL vreg2_init ( vreg2_t ctx,
vreg2_cfg_t cfg 
)

Initialization function.

Parameters
vreg2Click object.
cfgClick configuration structure.

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

◆ vreg2_pwm_start()

void vreg2_pwm_start ( vreg2_t ctx)

Start PWM module.

Parameters
ctxClick object.

This function starts PWM module.

◆ vreg2_pwm_stop()

void vreg2_pwm_stop ( vreg2_t ctx)

Stop PWM module.

Parameters
ctxClick object.

This function stops PWM module.

◆ vreg2_set_duty_cycle()

void vreg2_set_duty_cycle ( vreg2_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

This function sets the PWM duty cycle.