brushless12.h File Reference

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

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

Go to the source code of this file.

Data Structures
struct	brushless12_t
	Brushless 12 Click context object. More...
struct	brushless12_cfg_t
	Brushless 12 Click configuration object. More...

Macros
#define	BRUSHLESS12_ENABLE   1
#define	BRUSHLESS12_DISABLE   0
#define	BRUSHLESS12_START   1
#define	BRUSHLESS12_BRAKE   0
#define	BRUSHLESS12_DIR_FORWARD   1
#define	BRUSHLESS12_DIR_REVERSE   0
#define	BRUSHLESS12_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	brushless12_return_value_t { BRUSHLESS12_OK = 0 , BRUSHLESS12_ERROR = -1 }
	Brushless 12 Click return value data. More...

Functions
void	brushless12_cfg_setup (brushless12_cfg_t *cfg)
	Brushless 12 configuration object setup function.
err_t	brushless12_init (brushless12_t *ctx, brushless12_cfg_t *cfg)
	Brushless 12 initialization function.
err_t	brushless12_default_cfg (brushless12_t *ctx)
	Brushless 12 default configuration function.
void	brushless12_set_brake (brushless12_t *ctx, uint8_t state)
	Brushless 12 set BRK pin state function.
void	brushless12_set_direction (brushless12_t *ctx, uint8_t state)
	Brushless 12 set F/R pin state function.
void	brushless12_set_enable (brushless12_t *ctx, uint8_t state)
	Brushless 12 set EN pin state function.

Detailed Description

This file contains API for Brushless 12 Click Driver.

Enumeration Type Documentation

brushless12_return_value_t

enum brushless12_return_value_t

Brushless 12 Click return value data.

Predefined enum values for driver return values.

Enumerator
BRUSHLESS12_OK
BRUSHLESS12_ERROR