This file contains API for Brushless 17 Click Driver. More...

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

Data Structures
struct	brushless17_t
	Brushless 17 Click driver selector. More...

struct	brushless17_cfg_t
	Brushless 17 Click configuration object. More...

Macros
#define	BRUSHLESS17_DIR_CCW 0
	Brushless 17 direction setting.

#define	BRUSHLESS17_DIR_CW 1

#define	BRUSHLESS17_DEF_FREQ 5000
	Brushless 17 default PWM frequency.

#define	BRUSHLESS17_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	brushless17_return_value_t { BRUSHLESS17_OK = 0 , BRUSHLESS17_ERROR = -1 }
	Brushless 17 Click return value data. More...

Functions
void	brushless17_cfg_setup (brushless17_cfg_t *cfg)
	Brushless 17 configuration object setup function.

err_t	brushless17_init (brushless17_t ctx, brushless17_cfg_t cfg)
	Brushless 17 initialization function.

err_t	brushless17_default_cfg (brushless17_t *ctx)
	Brushless 17 default configuration function.

err_t	brushless17_set_duty_cycle (brushless17_t *ctx, float duty_cycle)
	Brushless 17 sets PWM duty cycle.

err_t	brushless17_pwm_stop (brushless17_t *ctx)
	Brushless 17 stop PWM module.

err_t	brushless17_pwm_start (brushless17_t *ctx)
	Brushless 17 start PWM module.

void	brushless17_enable_chip (brushless17_t *ctx)
	Brushless 17 enable chip function.

void	brushless17_disable_chip (brushless17_t *ctx)
	Brushless 17 disable chip function.

void	brushless17_set_direction (brushless17_t *ctx, uint8_t dir)
	Brushless 17 set direction function.

void	brushless17_switch_direction (brushless17_t *ctx)
	Brushless 17 switch direction function.

void	brushless17_pull_brake (brushless17_t *ctx)
	Brushless 17 pull brake function.

void	brushless17_release_brake (brushless17_t *ctx)
	Brushless 17 release brake function.

uint8_t	brushless17_get_diagnostic_pin (brushless17_t *ctx)
	Brushless 17 get diagnostic pin function.

Detailed Description

This file contains API for Brushless 17 Click Driver.

Enumeration Type Documentation

Brushless 17 Click return value data.

Predefined enum values for driver return values.

Enumerator
BRUSHLESS17_OK
BRUSHLESS17_ERROR