uvclight 2.0.0.0
Public function

Functions

void uvclight_cfg_setup (uvclight_cfg_t *cfg)
 Config Object Initialization function.
 
UVCLIGHT_RETVAL uvclight_init (uvclight_t *ctx, uvclight_cfg_t *cfg)
 Initialization function.
 
void uvclight_set_duty_cycle (uvclight_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle.
 
void uvclight_pwm_stop (uvclight_t *ctx)
 Stop PWM module.
 
void uvclight_pwm_start (uvclight_t *ctx)
 Start PWM module.
 

Detailed Description

Function Documentation

◆ uvclight_cfg_setup()

void uvclight_cfg_setup ( uvclight_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.

◆ uvclight_init()

UVCLIGHT_RETVAL uvclight_init ( uvclight_t * ctx,
uvclight_cfg_t * cfg )

Initialization function.

Parameters
ctxClick object.
cfgClick configuration structure.

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

◆ uvclight_pwm_start()

void uvclight_pwm_start ( uvclight_t * ctx)

Start PWM module.

Parameters
ctxClick object.

@description This function starts PWM module.

◆ uvclight_pwm_stop()

void uvclight_pwm_stop ( uvclight_t * ctx)

Stop PWM module.

Parameters
ctxClick object.

@description This function stops PWM module.

◆ uvclight_set_duty_cycle()

void uvclight_set_duty_cycle ( uvclight_t * ctx,
float duty_cycle )

Generic sets PWM duty cycle.

Parameters
ctxClick object.
duty_cycleDuty cycle.

@description This function sets the PWM duty cycle.