brushless24 2.1.0.0
brushless24.h File Reference

This file contains API for Brushless 24 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  brushless24_t
 Brushless 24 Click context object. More...
 
struct  brushless24_cfg_t
 Brushless 24 Click configuration object. More...
 

Macros

#define BRUSHLESS24_DEF_FREQ   25000
 Brushless 24 default PWM frequency.
 
#define BRUSHLESS24_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  brushless24_return_value_t { BRUSHLESS24_OK = 0 , BRUSHLESS24_ERROR = -1 }
 Brushless 24 Click return value data. More...
 

Functions

void brushless24_cfg_setup (brushless24_cfg_t *cfg)
 Brushless 24 configuration object setup function.
 
err_t brushless24_init (brushless24_t *ctx, brushless24_cfg_t *cfg)
 Brushless 24 initialization function.
 
err_t brushless24_default_cfg (brushless24_t *ctx)
 Brushless 24 default configuration function.
 
err_t brushless24_set_duty_cycle (brushless24_t *ctx, float duty_cycle)
 Brushless 24 sets PWM duty cycle.
 
err_t brushless24_pwm_stop (brushless24_t *ctx)
 Brushless 24 stop PWM module.
 
err_t brushless24_pwm_start (brushless24_t *ctx)
 Brushless 24 start PWM module.
 
uint8_t brushless24_get_int_state (brushless24_t *ctx)
 Brushless 24 get INT pin state.
 

Detailed Description

This file contains API for Brushless 24 Click Driver.

Enumeration Type Documentation

◆ brushless24_return_value_t

Brushless 24 Click return value data.

Predefined enum values for driver return values.

Enumerator
BRUSHLESS24_OK 
BRUSHLESS24_ERROR