dcmotor19 2.0.0.0
dcmotor19.h File Reference

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

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

Go to the source code of this file.

Data Structures

struct  dcmotor19_t
 DC Motor 19 Click context object. More...
 
struct  dcmotor19_cfg_t
 DC Motor 19 Click configuration object. More...
 

Macros

#define DCMOTOR19_CHANNEL_1   0x01
 DC Motor 19 channel setting.
 
#define DCMOTOR19_CHANNEL_2   0x02
 
#define DCMOTOR19_MODE_STOP   0x00
 DC Motor 19 mode setting.
 
#define DCMOTOR19_MODE_FORWARD   0x01
 
#define DCMOTOR19_MODE_REVERSE   0x02
 
#define DCMOTOR19_MODE_SHORT_BRAKE   0x03
 
#define DCMOTOR19_SPEED_MAX   100
 DC Motor 19 speed and time setting.
 
#define DCMOTOR19_SPEED_DEFAULT   5
 
#define DCMOTOR19_SPEED_MIN   1
 
#define DCMOTOR19_MS_TIME_STEP   10
 
#define DCMOTOR19_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping.
 

Enumerations

enum  dcmotor19_return_value_t { DCMOTOR19_OK = 0 , DCMOTOR19_ERROR = -1 }
 DC Motor 19 Click return value data. More...
 

Functions

void dcmotor19_cfg_setup (dcmotor19_cfg_t *cfg)
 DC Motor 19 configuration object setup function.
 
err_t dcmotor19_init (dcmotor19_t *ctx, dcmotor19_cfg_t *cfg)
 DC Motor 19 initialization function.
 
err_t dcmotor19_drive_motor (dcmotor19_t *ctx, uint8_t speed, uint32_t time_ms)
 DC Motor 19 drive motor function.
 
err_t dcmotor19_set_channel_mode (dcmotor19_t *ctx, uint8_t channel, uint8_t mode)
 DC Motor 19 set channel mode function.
 
void dcmotor19_disable_standby_mode (dcmotor19_t *ctx)
 DC Motor 19 disable standby mode function.
 
void dcmotor19_enable_standby_mode (dcmotor19_t *ctx)
 DC Motor 19 enable standby mode function.
 

Detailed Description

This file contains API for DC Motor 19 Click Driver.

Enumeration Type Documentation

◆ dcmotor19_return_value_t

DC Motor 19 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR19_OK 
DCMOTOR19_ERROR