brushless18 2.1.0.0
Loading...
Searching...
No Matches
brushless18.h File Reference

This file contains API for Brushless 18 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  brushless18_t
 Brushless 18 Click context object. More...
 
struct  brushless18_cfg_t
 Brushless 18 Click configuration object. More...
 

Macros

#define BRUSHLESS18_DEF_FREQ   400
 Brushless 18 default PWM frequency.
 
#define BRUSHLESS18_DC_ZERO   0.0
 Brushless 18 duty cycle settings.
 
#define BRUSHLESS18_DC_1MS   ( BRUSHLESS18_DEF_FREQ / 1000.0 )
 
#define BRUSHLESS18_DC_MIN_THROTTLE   ( BRUSHLESS18_DC_1MS * 1.064 )
 
#define BRUSHLESS18_DC_IDLE   ( BRUSHLESS18_DC_1MS * 1.464 )
 
#define BRUSHLESS18_DC_MAX_THROTTLE   ( BRUSHLESS18_DC_1MS * 1.864 )
 
#define BRUSHLESS18_DC_1_PCT   ( ( BRUSHLESS18_DC_MAX_THROTTLE - BRUSHLESS18_DC_IDLE ) / 100.0 )
 
#define BRUSHLESS18_SPEED_MIN   0
 Brushless 18 speed and direction settings.
 
#define BRUSHLESS18_SPEED_MAX   100
 
#define BRUSHLESS18_DIRECTION_CW   0
 
#define BRUSHLESS18_DIRECTION_CCW   1
 
#define BRUSHLESS18_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  brushless18_return_value_t { BRUSHLESS18_OK = 0 , BRUSHLESS18_ERROR = -1 }
 Brushless 18 Click return value data. More...
 

Functions

void brushless18_cfg_setup (brushless18_cfg_t *cfg)
 Brushless 18 configuration object setup function.
 
err_t brushless18_init (brushless18_t *ctx, brushless18_cfg_t *cfg)
 Brushless 18 initialization function.
 
err_t brushless18_set_duty_cycle (brushless18_t *ctx, float duty_cycle)
 Brushless 18 sets PWM duty cycle.
 
err_t brushless18_pwm_stop (brushless18_t *ctx)
 Brushless 18 stop PWM module.
 
err_t brushless18_pwm_start (brushless18_t *ctx)
 Brushless 18 start PWM module.
 
err_t brushless18_throttle_calib (brushless18_t *ctx)
 Brushless 18 throttle calib module.
 
err_t brushless18_drive_motor (brushless18_t *ctx, uint8_t direction, uint8_t speed)
 Brushless 18 drive motor module.
 

Detailed Description

This file contains API for Brushless 18 Click Driver.

Enumeration Type Documentation

◆ brushless18_return_value_t

Brushless 18 Click return value data.

Predefined enum values for driver return values.

Enumerator
BRUSHLESS18_OK 
BRUSHLESS18_ERROR