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

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

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.

#define	DCMOTOR25_ONE_TIME_PROG 0x80

#define	DCMOTOR25_OTP_V_READY 0x00
	DC Motor 25 description setting.

#define	DCMOTOR25_OTP_V_TEST_OK 0x40

#define	DCMOTOR25_OTP_V_ERROR 0x80

#define	DCMOTOR25_OTP_V_PROG_SUCCESS 0xC0

#define	DCMOTOR25_RESISTANCE_MIN 17000
	DC Motor 25 description digital potentiometer wiper data.

#define	DCMOTOR25_RES_DEFAULT_20_kOhm 20000

#define	DCMOTOR25_FULL_SCALE_RES_50_kOhm 50000

#define	DCMOTOR25_WIPER_POS_MAX 0x3F

#define	DCMOTOR25_DEVICE_ADDRESS 0x2C
	DC Motor 25 device address setting.

#define	DCMOTOR25_MAP_MIKROBUS(cfg, mikrobus)
	MikroBUS pin mapping.

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.

err_t	dcmotor25_init (dcmotor25_t ctx, dcmotor25_cfg_t cfg)
	DC Motor 25 initialization function.

err_t	dcmotor25_default_cfg (dcmotor25_t *ctx)
	DC Motor 25 default configuration function.

err_t	dcmotor25_write_byte (dcmotor25_t *ctx, uint8_t inst, uint8_t data_in)
	DC Motor 25 I2C writing function.

err_t	dcmotor25_read_byte (dcmotor25_t ctx, uint8_t data_out)
	DC Motor 25 I2C reading function.

err_t	dcmotor25_write_rdac (dcmotor25_t *ctx, uint8_t rdac_data)
	DC Motor 25 write RDAC function.

err_t	dcmotor25_read_rdac (dcmotor25_t ctx, uint8_t rdac_data)
	DC Motor 25 read RDAC function.

err_t	dcmotor25_set_digi_pot (dcmotor25_t *ctx, uint8_t wiper_pos)
	DC Motor 25 set the digital potentiometer function.

err_t	dcmotor25_set_resistance (dcmotor25_t *ctx, uint16_t res_ohm)
	DC Motor 25 set the resistance function.

void	dcmotor25_standby (dcmotor25_t *ctx)
	DC Motor 25 set standby mode function.

void	dcmotor25_reverse (dcmotor25_t *ctx)
	DC Motor 25 set reverse mode function.

void	dcmotor25_forward (dcmotor25_t *ctx)
	DC Motor 25 set forward mode function.

void	dcmotor25_brake (dcmotor25_t *ctx)
	DC Motor 25 set brake mode function.

Detailed Description

This file contains API for DC Motor 25 Click Driver.

Enumeration Type Documentation

DC Motor 25 Click return value data.

Predefined enum values for driver return values.

Enumerator
DCMOTOR25_OK
DCMOTOR25_ERROR