vtohz  2.0.0.0
Functions
Public function

Functions

void vtohz_cfg_setup (vtohz_cfg_t *cfg)
 Config Object Initialization function. More...
 
VTOHZ_RETVAL vtohz_init (vtohz_t *ctx, vtohz_cfg_t *cfg)
 Initialization function. More...
 
void vtohz_set_duty_cycle (vtohz_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void vtohz_pwm_stop (vtohz_t *ctx)
 Stop PWM module. More...
 
void vtohz_pwm_start (vtohz_t *ctx)
 Start PWM module. More...
 
void vtohz_enable (vtohz_t *ctx)
 Enable the click module. More...
 

Detailed Description

Function Documentation

◆ vtohz_cfg_setup()

void vtohz_cfg_setup ( vtohz_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.

◆ vtohz_enable()

void vtohz_enable ( vtohz_t ctx)

Enable the click module.

Parameters
ctxClick object.

@description This function enables the click module.

◆ vtohz_init()

VTOHZ_RETVAL vtohz_init ( vtohz_t ctx,
vtohz_cfg_t cfg 
)

Initialization function.

Parameters
vtohzClick object.
cfgClick configuration structure.

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

◆ vtohz_pwm_start()

void vtohz_pwm_start ( vtohz_t ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ vtohz_pwm_stop()

void vtohz_pwm_stop ( vtohz_t ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ vtohz_set_duty_cycle()

void vtohz_set_duty_cycle ( vtohz_t ctx,
float  duty_cycle 
)

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.