dcmotor24 2.1.0.0
DC Motor 24 Settings

Settings of DC Motor 24 Click driver. More...

Macros

#define DCMOTOR24_CFG_DR   0x0002u
 DC Motor 24 configuration protocol (CFG_REG) setting.
 
#define DCMOTOR24_CFG_CL_2p5A   0x0000u
 
#define DCMOTOR24_CFG_CL_4A   0x0004u
 
#define DCMOTOR24_CFG_CL_6p6A   0x0008u
 
#define DCMOTOR24_CFG_CL_8p6A   0x000Cu
 
#define DCMOTOR24_CFG_CL_MASK   0x000Cu
 
#define DCMOTOR24_CFG_VSR   0x0100u
 
#define DCMOTOR24_CFG_ISR   0x0200u
 
#define DCMOTOR24_CFG_ISR_DIS   0x0400u
 
#define DCMOTOR24_CFG_OL_ON   0x0800u
 
#define DCMOTOR24_DIA_OL_OFF   0x0001u
 DC Motor 24 diagnostics protocol (DIA_REG) setting.
 
#define DCMOTOR24_DIA_OL_ON   0x0002u
 
#define DCMOTOR24_DIA_VS_UV   0x0004u
 
#define DCMOTOR24_DIA_VDD_OV   0x0008u
 
#define DCMOTOR24_DIA_ILIM   0x0010u
 
#define DCMOTOR24_DIA_TWARN   0x0020u
 
#define DCMOTOR24_DIA_TSD   0x0040u
 
#define DCMOTOR24_DIA_ACT   0x0080u
 
#define DCMOTOR24_DIA_OC_LS1   0x0100u
 
#define DCMOTOR24_DIA_OC_LS2   0x0200u
 
#define DCMOTOR24_DIA_OC_HS1   0x0400u
 
#define DCMOTOR24_DIA_OC_HS2   0x0800u
 
#define DCMOTOR24_DIA_SGND_OFF   0x4000u
 
#define DCMOTOR24_DIA_SBAT_OFF   0x8000u
 
#define DCMOTOR24_DIR_REVERSE   0
 DC Motor 24 direction setting.
 
#define DCMOTOR24_DIR_FORWARD   1
 
#define DCMOTOR24_DEF_FREQ   5000
 DC Motor 24 default PWM frequency.
 
#define DCMOTOR24_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE
 Data sample selection.
 
#define DCMOTOR24_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE
 

Detailed Description

Settings of DC Motor 24 Click driver.

Macro Definition Documentation

◆ DCMOTOR24_CFG_CL_2p5A

#define DCMOTOR24_CFG_CL_2p5A   0x0000u

◆ DCMOTOR24_CFG_CL_4A

#define DCMOTOR24_CFG_CL_4A   0x0004u

◆ DCMOTOR24_CFG_CL_6p6A

#define DCMOTOR24_CFG_CL_6p6A   0x0008u

◆ DCMOTOR24_CFG_CL_8p6A

#define DCMOTOR24_CFG_CL_8p6A   0x000Cu

◆ DCMOTOR24_CFG_CL_MASK

#define DCMOTOR24_CFG_CL_MASK   0x000Cu

◆ DCMOTOR24_CFG_DR

#define DCMOTOR24_CFG_DR   0x0002u

DC Motor 24 configuration protocol (CFG_REG) setting.

Specified setting for configuration protocol (CFG_REG) of DC Motor 24 Click driver.

◆ DCMOTOR24_CFG_ISR

#define DCMOTOR24_CFG_ISR   0x0200u

◆ DCMOTOR24_CFG_ISR_DIS

#define DCMOTOR24_CFG_ISR_DIS   0x0400u

◆ DCMOTOR24_CFG_OL_ON

#define DCMOTOR24_CFG_OL_ON   0x0800u

◆ DCMOTOR24_CFG_VSR

#define DCMOTOR24_CFG_VSR   0x0100u

◆ DCMOTOR24_DEF_FREQ

#define DCMOTOR24_DEF_FREQ   5000

DC Motor 24 default PWM frequency.

Specified setting for default PWM frequency of DC Motor 24 Click driver.

◆ DCMOTOR24_DIA_ACT

#define DCMOTOR24_DIA_ACT   0x0080u

◆ DCMOTOR24_DIA_ILIM

#define DCMOTOR24_DIA_ILIM   0x0010u

◆ DCMOTOR24_DIA_OC_HS1

#define DCMOTOR24_DIA_OC_HS1   0x0400u

◆ DCMOTOR24_DIA_OC_HS2

#define DCMOTOR24_DIA_OC_HS2   0x0800u

◆ DCMOTOR24_DIA_OC_LS1

#define DCMOTOR24_DIA_OC_LS1   0x0100u

◆ DCMOTOR24_DIA_OC_LS2

#define DCMOTOR24_DIA_OC_LS2   0x0200u

◆ DCMOTOR24_DIA_OL_OFF

#define DCMOTOR24_DIA_OL_OFF   0x0001u

DC Motor 24 diagnostics protocol (DIA_REG) setting.

Specified setting for diagnostics protocol (DIA_REG) of DC Motor 24 Click driver.

◆ DCMOTOR24_DIA_OL_ON

#define DCMOTOR24_DIA_OL_ON   0x0002u

◆ DCMOTOR24_DIA_SBAT_OFF

#define DCMOTOR24_DIA_SBAT_OFF   0x8000u

◆ DCMOTOR24_DIA_SGND_OFF

#define DCMOTOR24_DIA_SGND_OFF   0x4000u

◆ DCMOTOR24_DIA_TSD

#define DCMOTOR24_DIA_TSD   0x0040u

◆ DCMOTOR24_DIA_TWARN

#define DCMOTOR24_DIA_TWARN   0x0020u

◆ DCMOTOR24_DIA_VDD_OV

#define DCMOTOR24_DIA_VDD_OV   0x0008u

◆ DCMOTOR24_DIA_VS_UV

#define DCMOTOR24_DIA_VS_UV   0x0004u

◆ DCMOTOR24_DIR_FORWARD

#define DCMOTOR24_DIR_FORWARD   1

◆ DCMOTOR24_DIR_REVERSE

#define DCMOTOR24_DIR_REVERSE   0

DC Motor 24 direction setting.

Specified setting for direction of DC Motor 24 Click driver.

◆ DCMOTOR24_SET_DATA_SAMPLE_EDGE

#define DCMOTOR24_SET_DATA_SAMPLE_EDGE   SET_SPI_DATA_SAMPLE_EDGE

Data sample selection.

This macro sets data samples for SPI modules.

Note
Available only on Microchip PIC family devices. This macro will set data sampling for all SPI modules on MCU. Can be overwritten with dcmotor24_init which will set SET_SPI_DATA_SAMPLE_MIDDLE by default on the mapped mikrobus.

◆ DCMOTOR24_SET_DATA_SAMPLE_MIDDLE

#define DCMOTOR24_SET_DATA_SAMPLE_MIDDLE   SET_SPI_DATA_SAMPLE_MIDDLE