dcmotor25  2.1.0.0
Data Structures | Macros | Enumerations | Functions
dcmotor25.h File Reference

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

#include "drv_digital_out.h"
#include "drv_i2c_master.h"

Go to the source code of this file.

Data Structures

struct  dcmotor25_t
 DC Motor 25 Click context object. More...
 
struct  dcmotor25_cfg_t
 DC Motor 25 Click configuration object. More...
 

Macros

#define DCMOTOR25_WRITE_TO_RDAC   0x00
 DC Motor 25 description register. More...
 
#define DCMOTOR25_ONE_TIME_PROG   0x80
 
#define DCMOTOR25_OTP_V_READY   0x00
 DC Motor 25 description setting. More...
 
#define DCMOTOR25_OTP_V_TEST_OK   0x40
 
#define DCMOTOR25_OTP_V_ERROR   0x80
 
#define DCMOTOR25_OTP_V_PROG_SUCCESS   0xC0
 
#define DCMOTOR25_DEVICE_ADDRESS   0x2C
 DC Motor 25 device address setting. More...
 
#define DCMOTOR25_MAP_MIKROBUS(cfg, mikrobus)
 MikroBUS pin mapping. More...
 

Enumerations

enum  dcmotor25_return_value_t { DCMOTOR25_OK = 0, DCMOTOR25_ERROR = -1 }
 DC Motor 25 Click return value data. More...
 

Functions

void dcmotor25_cfg_setup (dcmotor25_cfg_t *cfg)
 DC Motor 25 configuration object setup function. More...
 
err_t dcmotor25_init (dcmotor25_t *ctx, dcmotor25_cfg_t *cfg)
 DC Motor 25 initialization function. More...
 
err_t dcmotor25_default_cfg (dcmotor25_t *ctx)
 DC Motor 25 default configuration function. More...
 
err_t dcmotor25_write_byte (dcmotor25_t *ctx, uint8_t inst, uint8_t data_in)
 DC Motor 25 I2C writing function. More...
 
err_t dcmotor25_read_byte (dcmotor25_t *ctx, uint8_t *data_out)
 DC Motor 25 I2C reading function. More...
 
err_t dcmotor25_write_rdac (dcmotor25_t *ctx, uint8_t rdac_data)
 DC Motor 25 write RDAC function. More...
 
err_t dcmotor25_read_rdac (dcmotor25_t *ctx, uint8_t *rdac_data)
 DC Motor 25 read RDAC function. More...
 
err_t dcmotor25_set_digi_pot (dcmotor25_t *ctx, uint8_t wiper_pos)
 DC Motor 25 set the digital potentiometer function. More...
 
err_t dcmotor25_set_resistance (dcmotor25_t *ctx, uint16_t res_ohm)
 DC Motor 25 set the resistance function. More...
 
void dcmotor25_standby (dcmotor25_t *ctx)
 DC Motor 25 set standby mode function. More...
 
void dcmotor25_reverse (dcmotor25_t *ctx)
 DC Motor 25 set reverse mode function. More...
 
void dcmotor25_forward (dcmotor25_t *ctx)
 DC Motor 25 set brake mode function. More...
 
void dcmotor25_brake (dcmotor25_t *ctx)
 DC Motor 25 set brake mode function. More...
 

Detailed Description

This file contains API for DC Motor 25 Click Driver.

Enumeration Type Documentation

◆ dcmotor25_return_value_t

DC Motor 25 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR25_OK 
DCMOTOR25_ERROR