dcmotor5  2.0.0.0
Data Structures | Macros | Functions
dcmotor5.h File Reference

This file contains API for DC MOTOR 5 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  dcmotor5_t
 Click ctx object definition. More...
 
struct  dcmotor5_cfg_t
 Click configuration structure definition. More...
 

Macros

#define DCMOTOR5_MAP_MIKROBUS(cfg, mikrobus)
 
#define DCMOTOR5_RETVAL   uint8_t
 
#define DCMOTOR5_OK   0x00
 
#define DCMOTOR5_INIT_ERROR   0xFF
 
#define DCMOTOR5_DEF_FREQ   20000
 

Functions

void dcmotor5_cfg_setup (dcmotor5_cfg_t *cfg)
 Config Object Initialization function. More...
 
DCMOTOR5_RETVAL dcmotor5_init (dcmotor5_t *ctx, dcmotor5_cfg_t *cfg)
 Initialization function. More...
 
void dcmotor5_set_duty_cycle (dcmotor5_t *ctx, float duty_cycle)
 Generic sets PWM duty cycle. More...
 
void dcmotor5_pwm_stop (dcmotor5_t *ctx)
 Stop PWM module. More...
 
void dcmotor5_pwm_start (dcmotor5_t *ctx)
 Start PWM module. More...
 
void dcmotor5_enable (dcmotor5_t *ctx)
 Enable the engine function. More...
 
void dcmotor5_standby (dcmotor5_t *ctx)
 Disable the engine function. More...
 
void dcmotor5_counter_clockwise (dcmotor5_t *ctx)
 Set the direction of rotation in the counter clockwise direction function. More...
 
void dcmotor5_clockwise (dcmotor5_t *ctx)
 Set the direction of rotation in the clockwise direction function. More...
 
void dcmotor5_short_brake (dcmotor5_t *ctx)
 Brake the engine function. More...
 
void dcmotor5_stop (dcmotor5_t *ctx)
 Stop the engine function. More...
 
uint8_t dcmotor5_get_fault_conditions (dcmotor5_t *ctx)
 Get fault conditions state function. More...
 
uint8_t dcmotor5_get_sense_comparator (dcmotor5_t *ctx)
 Get sense comparator state function. More...
 

Detailed Description

This file contains API for DC MOTOR 5 Click driver.