dcmotor20 2.0.0.0
dcmotor20.h File Reference

This file contains API for DC Motor 20 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  dcmotor20_t
 DC Motor 20 Click context object. More...
 
struct  dcmotor20_cfg_t
 DC Motor 20 Click configuration object. More...
 

Macros

#define DCMOTOR20_CHANNEL_1   0x01
 DC Motor 20 channel setting.
 
#define DCMOTOR20_CHANNEL_2   0x02
 
#define DCMOTOR20_MODE_STOP   0x00
 DC Motor 20 mode setting.
 
#define DCMOTOR20_MODE_FORWARD   0x01
 
#define DCMOTOR20_MODE_REVERSE   0x02
 
#define DCMOTOR20_SPEED_MAX   100
 DC Motor 20 speed and time setting.
 
#define DCMOTOR20_SPEED_DEFAULT   10
 
#define DCMOTOR20_SPEED_MIN   1
 
#define DCMOTOR20_MS_TIME_STEP   10
 
#define DCMOTOR20_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  dcmotor20_return_value_t { DCMOTOR20_OK = 0 , DCMOTOR20_ERROR = -1 }
 DC Motor 20 Click return value data. More...
 

Functions

void dcmotor20_cfg_setup (dcmotor20_cfg_t *cfg)
 DC Motor 20 configuration object setup function.
 
err_t dcmotor20_init (dcmotor20_t *ctx, dcmotor20_cfg_t *cfg)
 DC Motor 20 initialization function.
 
err_t dcmotor20_drive_motor (dcmotor20_t *ctx, uint8_t speed, uint32_t time_ms)
 DC Motor 20 drive motor function.
 
err_t dcmotor20_set_channel_mode (dcmotor20_t *ctx, uint8_t channel, uint8_t mode)
 DC Motor 20 set channel mode function.
 
void dcmotor20_set_standby_mode (dcmotor20_t *ctx)
 DC Motor 20 set standby mode function.
 

Detailed Description

This file contains API for DC Motor 20 Click Driver.

Enumeration Type Documentation

◆ dcmotor20_return_value_t

DC Motor 20 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR20_OK 
DCMOTOR20_ERROR