DRV8706Q1_INSTANCE Struct Reference

Internal structure that represents a specific DRV8706-Q1. More...

#include <drv8706-q1.h>

Data Fields
ADC_CHANS	adcChan
_iq20	csaSF
GPIO_OUTPUT_PINS	nSleep
GPIO_OUTPUT_PINS	drvOff
GPIO_INPUT_PINS	nFault
GPIO_OUTPUT_PINS	nHiz1
GPIO_OUTPUT_PINS	nHiz2
PWM_CHANNELS	in1En
PWM_CHANNELS	in2Ph
SPI_CHANNELS	spiChan
SPI_CS	spiCS
_iq20	aRef_V
DRV8706Q1_CSA_GAINS	csaGain
DRV8706Q1_CSA_DIV	csaDiv
_iq20	shuntRes
DRV8706Q1_MODES	driveMode

Detailed Description

Internal structure that represents a specific DRV8706-Q1.

Field Documentation

adcChan

ADC_CHANS DRV8706Q1_INSTANCE::adcChan

HAL ADC channel used to read from the motor driver's CSA. ADC_CHANS

Referenced by DRV8706Q1_getCurrent().

csaSF

_iq20 DRV8706Q1_INSTANCE::csaSF

Scale factor used to cache values needed to calculate current from CSA output

Referenced by DRV8706Q1_getCurrent(), DRV8706Q1_init(), and DRV8706Q1_switchToSolenoidDrive().

nSleep

GPIO_OUTPUT_PINS DRV8706Q1_INSTANCE::nSleep

HAL output pin connected to the motor driver's nSleep pin. GPIO_OUTPUT_PINS

Referenced by DRV8706Q1_setNSleep().

drvOff

GPIO_OUTPUT_PINS DRV8706Q1_INSTANCE::drvOff

HAL output pin connected to the motor driver's drvOff pin. GPIO_OUTPUT_PINS

Referenced by DRV8706Q1_setDrvOff().

nFault

GPIO_INPUT_PINS DRV8706Q1_INSTANCE::nFault

HAL input pin connected to the motor driver's nFault pin. GPIO_OUTPUT_PINS

nHiz1

GPIO_OUTPUT_PINS DRV8706Q1_INSTANCE::nHiz1

HAL output pin connected to the motor driver's nHiz1 pin. GPIO_OUTPUT_PINS

Referenced by DRV8706Q1_changeHalfBridgeDrive(), DRV8706Q1_changeSolenoidDrive(), and DRV8706Q1_setNHiZ1().

nHiz2

GPIO_OUTPUT_PINS DRV8706Q1_INSTANCE::nHiz2

HAL output pin connected to the motor driver's nHiz2 pin. GPIO_OUTPUT_PINS

Referenced by DRV8706Q1_changeHalfBridgeDrive(), DRV8706Q1_changeSolenoidDrive(), and DRV8706Q1_setNHiZ2().

in1En

PWM_CHANNELS DRV8706Q1_INSTANCE::in1En

HAL PWM channel connected to the motor driver's IN1 pin PWM_CHANNELS

Referenced by DRV8706Q1_changeHalfBridgeDrive(), DRV8706Q1_changeHBridgeDrive(), DRV8706Q1_changePhaseDrive(), DRV8706Q1_changeSolenoidDrive(), and DRV8706Q1_init().

in2Ph

PWM_CHANNELS DRV8706Q1_INSTANCE::in2Ph

HAL PWM channel connected to the motor driver's IN2 pin PWM_CHANNELS

Referenced by DRV8706Q1_changeHalfBridgeDrive(), DRV8706Q1_changeHBridgeDrive(), DRV8706Q1_changePhaseDrive(), DRV8706Q1_changeSolenoidDrive(), and DRV8706Q1_init().

spiChan

SPI_CHANNELS DRV8706Q1_INSTANCE::spiChan

HAL SPI channel connected to the motor driver's spi pins SPI_CHANNELS

Referenced by DRV8706Q1_spiReadCmd(), and DRV8706Q1_spiWriteCmd().

spiCS

SPI_CS DRV8706Q1_INSTANCE::spiCS

HAL SPI CS connected to the motor driver's spi cs pin SPI_CS

Referenced by DRV8706Q1_spiReadCmd(), and DRV8706Q1_spiWriteCmd().

aRef_V

_iq20 DRV8706Q1_INSTANCE::aRef_V

Voltage connected to motor driver analog reference pin

Referenced by DRV8706Q1_getCurrent(), DRV8706Q1_init(), and DRV8706Q1_setAnalogReference().

csaGain

DRV8706Q1_CSA_GAINS DRV8706Q1_INSTANCE::csaGain

Motor driver current sense amplifier gain setting

Referenced by DRV8706Q1_powerOnResetVal(), DRV8706Q1_setCurrentSenseGain(), and DRV8706Q1_switchToSolenoidDrive().

csaDiv

DRV8706Q1_CSA_DIV DRV8706Q1_INSTANCE::csaDiv

Current shunt amplifier reference voltage divider

Referenced by DRV8706Q1_getCurrent(), DRV8706Q1_powerOnResetVal(), and DRV8706Q1_setAnalogReferenceDivider().

shuntRes

_iq20 DRV8706Q1_INSTANCE::shuntRes

Current shunt resistor value in mΩ

Referenced by DRV8706Q1_init(), DRV8706Q1_setCurrentShuntResistor(), and DRV8706Q1_switchToSolenoidDrive().

driveMode

DRV8706Q1_MODES DRV8706Q1_INSTANCE::driveMode

The current control mode the motor driver is configured to

Referenced by DRV8706Q1_powerOnResetVal(), DRV8706Q1_setDriveDutyCycle(), DRV8706Q1_setDrivePWMFreq(), DRV8706Q1_switchToHalfBridgeDrive(), DRV8706Q1_switchToHBridgeDrive(), DRV8706Q1_switchToPhaseDrive(), and DRV8706Q1_switchToSolenoidDrive().

---

The documentation for this struct was generated from the following file:

• drv8706-q1.h