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

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

Data Structures
struct	dcmotor15_t
	DC Motor 15 Click context object. More...

struct	dcmotor15_cfg_t
	DC Motor 15 Click configuration object. More...

Macros
#define	DCMOTOR15_RIPROP_OHM 1500
	DC Motor 15 IPROPI values.

#define	DCMOTOR15_AIPROP_AMP 0.000455

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

Enumerations
enum	dcmotor15_return_value_t { DCMOTOR15_OK = 0 , DCMOTOR15_ERROR = -1 }
	DC Motor 15 Click return value data. More...

enum	dcmotor15_pin_state_value_t { DCMOTOR15_LOW = 0 , DCMOTOR15_HIGH = 1 }
	DC Motor 15 Click pin state value data. More...

Functions
void	dcmotor15_cfg_setup (dcmotor15_cfg_t *cfg)
	DC Motor 15 configuration object setup function.

err_t	dcmotor15_init (dcmotor15_t ctx, dcmotor15_cfg_t cfg)
	DC Motor 15 initialization function.

void	dcmotor15_default_cfg (dcmotor15_t *ctx)
	DC Motor 15 default configuration function.

err_t	dcmotor15_read_an_pin_value (dcmotor15_t ctx, uint16_t data_out)
	DC Motor 15 read IPR pin value function.

err_t	dcmotor15_read_an_pin_voltage (dcmotor15_t ctx, float data_out)
	DC Motor 15 read IPR pin voltage level function.

void	dcmotor15_set_slp_pin_state (dcmotor15_t *ctx, uint8_t state)
	DC Motor 15 set SLP pin state function.

void	dcmotor15_set_in1_pin_state (dcmotor15_t *ctx, uint8_t state)
	DC Motor 15 set IN1 pin state function.

void	dcmotor15_set_in2_pin_state (dcmotor15_t *ctx, uint8_t state)
	DC Motor 15 set IN2 pin state function.

uint8_t	dcmotor15_fault_check (dcmotor15_t *ctx)
	DC Motor 15 get FLT pin state function.

void	dcmotor15_forward (dcmotor15_t *ctx)
	DC Motor 15 drive forward function.

void	dcmotor15_reverse (dcmotor15_t *ctx)
	DC Motor 15 drive reverse function.

void	dcmotor15_brake (dcmotor15_t *ctx)
	DC Motor 15 brake function.

void	dcmotor15_stop (dcmotor15_t *ctx)
	DC Motor 15 stop function.

float	dcmotor15_get_current (dcmotor15_t *ctx, uint16_t num_of_conv)
	DC Motor 15 get current function.

Detailed Description

This file contains API for DC Motor 15 Click Driver.

Enumeration Type Documentation

DC Motor 15 Click pin state value data.

Predefined enum values for driver pin state values.

Enumerator
DCMOTOR15_LOW
DCMOTOR15_HIGH

DC Motor 15 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR15_OK
DCMOTOR15_ERROR