brushless.h File Reference

This file contains API for Brushless Click driver. More...

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

Go to the source code of this file.

Data Structures
struct	brushless_t
	Click ctx object definition. More...
struct	brushless_cfg_t
	Click configuration structure definition. More...

Macros
#define	BRUSHLESS_MAP_MIKROBUS(cfg, mikrobus)
#define	BRUSHLESS_RETVAL   uint8_t
#define	BRUSHLESS_OK   0x00
#define	BRUSHLESS_INIT_ERROR   0xFF
#define	BRUSHLESS_DEF_FREQ   5000

Typedefs
typedef uint16_t	brushless_data_t
	Analog data type.

Functions
void	brushless_cfg_setup (brushless_cfg_t *cfg)
	Config Object Initialization function.
BRUSHLESS_RETVAL	brushless_init (brushless_t *ctx, brushless_cfg_t *cfg)
	Initialization function.
void	brushless_set_duty_cycle (brushless_t *ctx, float duty_cycle)
	Generic sets PWM duty cycle.
void	brushless_pwm_stop (brushless_t *ctx)
	Stop PWM module.
void	brushless_pwm_start (brushless_t *ctx)
	Start PWM module.
brushless_data_t	brushless_generic_read (brushless_t *ctx)
	Generic read function.
void	brushless_spin_clockwise (brushless_t *ctx)
	Spin motor clockwise function.
void	brushless_spin_counter_clockwise (brushless_t *ctx)
	Spin motor counter clockwise function.
uint8_t	brushless_read_rotation_speed_sensor_output (brushless_t *ctx)
	Read rotation speed sensor output function.

Detailed Description

This file contains API for Brushless Click driver.