vreg2.h File Reference

This file contains API for VREG 2 Click Driver. More...

#include "drv_digital_out.h"
#include "drv_digital_in.h"
#include "drv_pwm.h"

Go to the source code of this file.

Data Structures
struct	vreg2_t
	VREG 2 Click context object. More...
struct	vreg2_cfg_t
	VREG 2 Click configuration object. More...

Macros
#define	VREG2_DEF_FREQ   5000
	VREG 2 default PWM frequency.
#define	VREG2_MAP_MIKROBUS(cfg, mikrobus)    cfg.pwm = MIKROBUS( mikrobus, MIKROBUS_PWM );
	MikroBUS pin mapping.

Enumerations
enum	vreg2_return_value_t { VREG2_OK = 0 , VREG2_ERROR = -1 }
	VREG 2 Click return value data. More...

Functions
void	vreg2_cfg_setup (vreg2_cfg_t *cfg)
	VREG 2 configuration object setup function.
err_t	vreg2_init (vreg2_t *ctx, vreg2_cfg_t *cfg)
	VREG 2 initialization function.
err_t	vreg2_default_cfg (vreg2_t *ctx)
	VREG 2 default configuration function.
err_t	vreg2_set_duty_cycle (vreg2_t *ctx, float duty_cycle)
	VREG 2 sets PWM duty cycle.
err_t	vreg2_pwm_stop (vreg2_t *ctx)
	VREG 2 stop PWM module.
err_t	vreg2_pwm_start (vreg2_t *ctx)
	VREG 2 start PWM module.

Detailed Description

This file contains API for VREG 2 Click Driver.

Enumeration Type Documentation

vreg2_return_value_t

enum vreg2_return_value_t

VREG 2 Click return value data.

Predefined enum values for driver return values.

Enumerator
VREG2_OK
VREG2_ERROR