This file contains API for DC Motor 27 Click Driver. More...

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

Data Structures
struct	dcmotor27_t
	DC Motor 27 Click context object. More...

struct	dcmotor27_cfg_t
	DC Motor 27 Click configuration object. More...

Macros
#define	DCMOTOR27_DEF_FREQ 5000
	DC Motor 27 default PWM frequency.

#define	DCMOTOR27_SET_PIN_HIGH 0x01
	DC Motor 27 pin mode settings.

#define	DCMOTOR27_SET_PIN_LOW 0x00

#define	DCMOTOR27_SET_COAST_ON 0x01
	DC Motor 27 coast mode settings.

#define	DCMOTOR27_SET_COAST_OFF 0x00

#define	DCMOTOR27_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	dcmotor27_return_value_t { DCMOTOR27_OK = 0 , DCMOTOR27_ERROR = -1 }
	DC Motor 27 Click return value data. More...

Functions
void	dcmotor27_cfg_setup (dcmotor27_cfg_t *cfg)
	DC Motor 27 configuration object setup function.

err_t	dcmotor27_init (dcmotor27_t ctx, dcmotor27_cfg_t cfg)
	DC Motor 27 initialization function.

err_t	dcmotor27_default_cfg (dcmotor27_t *ctx)
	DC Motor 27 default configuration function.

err_t	dcmotor27_set_duty_cycle (dcmotor27_t *ctx, float duty_cycle)
	DC Motor 27 sets PWM duty cycle.

err_t	dcmotor27_pwm_stop (dcmotor27_t *ctx)
	DC Motor 27 stop PWM module.

err_t	dcmotor27_pwm_start (dcmotor27_t *ctx)
	DC Motor 27 start PWM module.

uint8_t	dcmotor27_get_flt_pin (dcmotor27_t *ctx)
	DC Motor 27 get flt pin state.

uint8_t	dcmotor27_get_ip_pin (dcmotor27_t *ctx)
	DC Motor 27 get ip pin state.

void	dcmotor27_set_rst_pin (dcmotor27_t *ctx, uint8_t pin_state)
	DC Motor 27 set RST pin state.

void	dcmotor27_set_cs_pin (dcmotor27_t *ctx, uint8_t pin_state)
	DC Motor 27 set CS pin state.

void	dcmotor27_set_coast (dcmotor27_t *ctx, uint8_t coast_state)
	DC Motor 27 set coast mode funtion.

Detailed Description

This file contains API for DC Motor 27 Click Driver.

Enumeration Type Documentation

DC Motor 27 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR27_OK
DCMOTOR27_ERROR