pwmdriver  2.0.0.0
Functions

Functions

void pwmdriver_cfg_setup (pwmdriver_cfg_t *cfg)
 Config Object Initialization function. More...
 
PWMDRIVER_RETVAL pwmdriver_init (pwmdriver_t *ctx, pwmdriver_cfg_t *cfg)
 Initialization function. More...
 
void pwmdriver_default_cfg (pwmdriver_t *ctx)
 Click Default Configuration function. More...
 
void pwmdriver_set_duty_cycle (pwmdriver_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void pwmdriver_pwm_stop (pwmdriver_t *ctx)
 Stop PWM module. More...
 
void pwmdriver_pwm_start (pwmdriver_t *ctx)
 Start PWM module. More...
 

Detailed Description

Function Documentation

◆ pwmdriver_cfg_setup()

void pwmdriver_cfg_setup ( pwmdriver_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.

◆ pwmdriver_default_cfg()

void pwmdriver_default_cfg ( pwmdriver_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for PwmDriver click.

◆ pwmdriver_init()

PWMDRIVER_RETVAL pwmdriver_init ( pwmdriver_t ctx,
pwmdriver_cfg_t cfg 
)

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ pwmdriver_pwm_start()

void pwmdriver_pwm_start ( pwmdriver_t ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ pwmdriver_pwm_stop()

void pwmdriver_pwm_stop ( pwmdriver_t ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ pwmdriver_set_duty_cycle()

void pwmdriver_set_duty_cycle ( pwmdriver_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.