vibromotor  2.0.0.0
Functions

Functions

void vibromotor_cfg_setup (vibromotor_cfg_t *cfg)
 Config Object Initialization function. More...
 
VIBROMOTOR_RETVAL vibromotor_init (vibromotor_t *ctx, vibromotor_cfg_t *cfg)
 Initialization function. More...
 
void vibromotor_default_cfg (vibromotor_t *ctx)
 Click Default Configuration function. More...
 
void vibromotor_set_duty_cycle (vibromotor_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void vibromotor_pwm_stop (vibromotor_t *ctx)
 Stop PWM module. More...
 
void vibromotor_pwm_start (vibromotor_t *ctx)
 Start PWM module. More...
 

Detailed Description

Function Documentation

◆ vibromotor_cfg_setup()

void vibromotor_cfg_setup ( vibromotor_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.

◆ vibromotor_default_cfg()

void vibromotor_default_cfg ( vibromotor_t ctx)

Click Default Configuration function.

Parameters
ctxClick object.

@description This function executes default configuration for VibroMotor click.

◆ vibromotor_init()

VIBROMOTOR_RETVAL vibromotor_init ( vibromotor_t ctx,
vibromotor_cfg_t cfg 
)

Initialization function.

Parameters
vibromotorClick object.
cfgClick configuration structure.

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

◆ vibromotor_pwm_start()

void vibromotor_pwm_start ( vibromotor_t ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ vibromotor_pwm_stop()

void vibromotor_pwm_stop ( vibromotor_t ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ vibromotor_set_duty_cycle()

void vibromotor_set_duty_cycle ( vibromotor_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.