dcmotor9.h File Reference

This file contains API for DC Motor 9 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	dcmotor9_t
	DC Motor 9 Click context object. More...
struct	dcmotor9_cfg_t
	DC Motor 9 Click configuration object. More...

Macros
#define	DCMOTOR9_DEF_FREQ   20000
	DC Motor 9 default PWM frequency.
#define	DCMOTOR9_DEF_VREF   3.3
#define	DCMOTOR9_PWM_DUTY_PERCENT_0   0.0
	DC Motor 9 PWM duty settings.
#define	DCMOTOR9_PWM_DUTY_PERCENT_10   0.1
#define	DCMOTOR9_PWM_DUTY_PERCENT_20   0.2
#define	DCMOTOR9_PWM_DUTY_PERCENT_30   0.3
#define	DCMOTOR9_PWM_DUTY_PERCENT_40   0.4
#define	DCMOTOR9_PWM_DUTY_PERCENT_50   0.5
#define	DCMOTOR9_PWM_DUTY_PERCENT_60   0.6
#define	DCMOTOR9_PWM_DUTY_PERCENT_70   0.7
#define	DCMOTOR9_PWM_DUTY_PERCENT_80   0.8
#define	DCMOTOR9_PWM_DUTY_PERCENT_90   0.9
#define	DCMOTOR9_PWM_DUTY_PERCENT_100   1.0
#define	DCMOTOR9_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

Enumerations
enum	dcmotor9_return_value_t { DCMOTOR9_OK = 0 , DCMOTOR9_ERROR = -1 }
	DC Motor 9 Click return value data. More...

Functions
void	dcmotor9_cfg_setup (dcmotor9_cfg_t *cfg)
	DC Motor 9 configuration object setup function.
err_t	dcmotor9_init (dcmotor9_t *ctx, dcmotor9_cfg_t *cfg)
	DC Motor 9 initialization function.
err_t	dcmotor9_default_cfg (dcmotor9_t *ctx)
	DC Motor 9 default configuration function.
err_t	dcmotor9_set_duty_cycle (dcmotor9_t *ctx, float duty_cycle)
	DC Motor 9 sets PWM duty cycle.
err_t	dcmotor9_pwm_stop (dcmotor9_t *ctx)
	DC Motor 9 stop PWM module.
err_t	dcmotor9_pwm_start (dcmotor9_t *ctx)
	DC Motor 9 start PWM module.
void	dcmotor9_enable (dcmotor9_t *ctx)
	DC Motor 9 Enable the engine function.
void	dcmotor9_standby (dcmotor9_t *ctx)
	DC Motor 9 Disable the engine function.
void	dcmotor9_counter_clockwise (dcmotor9_t *ctx)
	DC Motor 9 Set the counter clockwise direction of rotation function.
void	dcmotor9_clockwise (dcmotor9_t *ctx)
	DC Motor 9 Set the clockwise direction of rotation function.
void	dcmotor9_short_brake (dcmotor9_t *ctx)
	DC Motor 9 Brake the engine function.
void	dcmotor9_stop (dcmotor9_t *ctx)
	DC Motor 9 Stop the engine function.
err_t	dcmotor9_read_an_value (dcmotor9_t *ctx, uint16_t *data_out)
	DC Motor 9 AN Value Read function.
err_t	dcmotor9_read_an_voltage (dcmotor9_t *ctx, float *data_out)
	DC Motor 9 AN Voltage Read function.

Detailed Description

This file contains API for DC Motor 9 Click Driver.

Enumeration Type Documentation

dcmotor9_return_value_t

enum dcmotor9_return_value_t

DC Motor 9 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR9_OK
DCMOTOR9_ERROR