brushless31  2.1.0.0
Data Structures | Macros | Enumerations | Functions
brushless31.h File Reference

This file contains API for Brushless 31 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  brushless31_t
 Brushless 31 Click context object. More...
 
struct  brushless31_cfg_t
 Brushless 31 Click configuration object. More...
 

Macros

#define BRUSHLESS31_DIR_CW   0
 Brushless 31 direction settings. More...
 
#define BRUSHLESS31_DIR_CCW   1
 
#define BRUSHLESS31_DEF_FREQ   20000
 Brushless 31 default PWM frequency. More...
 
#define BRUSHLESS31_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  brushless31_return_value_t { BRUSHLESS31_OK = 0, BRUSHLESS31_ERROR = -1 }
 Brushless 31 Click return value data. More...
 

Functions

void brushless31_cfg_setup (brushless31_cfg_t *cfg)
 Brushless 31 configuration object setup function. More...
 
err_t brushless31_init (brushless31_t *ctx, brushless31_cfg_t *cfg)
 Brushless 31 initialization function. More...
 
err_t brushless31_default_cfg (brushless31_t *ctx)
 Brushless 31 default configuration function. More...
 
err_t brushless31_set_duty_cycle (brushless31_t *ctx, float duty_cycle)
 Brushless 31 sets PWM duty cycle. More...
 
err_t brushless31_pwm_stop (brushless31_t *ctx)
 Brushless 31 stop PWM module. More...
 
err_t brushless31_pwm_start (brushless31_t *ctx)
 Brushless 31 start PWM module. More...
 
void brushless31_set_direction (brushless31_t *ctx, uint8_t dir)
 Brushless 31 set direction function. More...
 
void brushless31_switch_direction (brushless31_t *ctx)
 Brushless 31 switch direction function. More...
 
void brushless31_pull_brake (brushless31_t *ctx)
 Brushless 31 pull brake function. More...
 
void brushless31_release_brake (brushless31_t *ctx)
 Brushless 31 release brake function. More...
 
void brushless31_start (brushless31_t *ctx)
 Brushless 31 start function. More...
 
void brushless31_stop (brushless31_t *ctx)
 Brushless 31 stop function. More...
 
uint8_t brushless31_get_hp_pin (brushless31_t *ctx)
 Brushless 31 get hp pin function. More...
 

Detailed Description

This file contains API for Brushless 31 Click Driver.

Enumeration Type Documentation

◆ brushless31_return_value_t

Brushless 31 Click return value data.

Predefined enum values for driver return values.

Enumerator
BRUSHLESS31_OK 
BRUSHLESS31_ERROR