DRV8434S.h File Reference

#include <Arduino.h>
#include <SPI.h>

Go to the source code of this file.

Classes
class	DRV8434SSPI
class	DRV8434S

Enumerations
enum class	DRV8434SRegAddr : uint8_t {   FAULT = 0x00 , DIAG1 = 0x01 , DIAG2 = 0x02 , CTRL1 = 0x03 ,   CTRL2 = 0x04 , CTRL3 = 0x05 , CTRL4 = 0x06 , CTRL5 = 0x07 ,   CTRL6 = 0x08 , CTRL7 = 0x09 , CTRL8 = 0x0A , CTRL9 = 0x0B }
	Addresses of control and status registers. More...
enum class	DRV8434SFaultBit : uint8_t {   FAULT = 7 , SPI_ERROR = 6 , UVLO = 5 , CPUV = 4 ,   OCP = 3 , STL = 2 , TF = 1 , OL = 0 }
enum class	DRV8434SDiag1Bit : uint8_t {   OCP_LS2_B = 7 , OCP_HS2_B = 6 , OCP_LS1_B = 5 , OCP_HS1_B = 4 ,   OCP_LS2_A = 3 , OCP_HS2_A = 2 , OCP_LS1_A = 1 , OCP_HS1_A = 0 }
enum class	DRV8434SDiag2Bit : uint8_t {   OTW = 6 , OTS = 5 , STL_LRN_OK = 4 , STALL = 3 ,   OL_B = 1 , OL_A = 0 }
enum class	DRV8434SDecayMode : uint8_t {   Slow = 0b000 , IncSlowDecMixed30 = 0b001 , IncSlowDecMixed60 = 0b010 , IncSlowDecFast = 0b011 ,   Mixed30 = 0b100 , Mixed60 = 0b101 , SmartTuneDynamicDecay = 0b110 , SmartTuneRippleControl = 0b111 }
	Possible arguments to setDecayMode(). More...
enum class	DRV8434SStepMode : uint8_t {   MicroStep1_100 = 0b0000 , MicroStep1 = 0b0001 , MicroStep2_NC = 0b0010 , MicroStep2 = 0b0011 ,   MicroStep4 = 0b0100 , MicroStep8 = 0b0101 , MicroStep16 = 0b0110 , MicroStep32 = 0b0111 ,   MicroStep64 = 0b1000 , MicroStep128 = 0b1001 , MicroStep256 = 0b1010 }
	Possible arguments to setStepMode(). More...

Detailed Description

This is the main header file for the DRV8434S library, a library for controlling the DRV8434S stepper motor driver.

For more information about this library, see:

https://github.com/pololu/drv8434s-arduino

That is the main repository for this library.

Definition in file DRV8434S.h.

Enumeration Type Documentation

DRV8434SDecayMode

enum class DRV8434SDecayMode : uint8_t

strong

Possible arguments to setDecayMode().

Definition at line 220 of file DRV8434S.h.

DRV8434SDiag1Bit

enum class DRV8434SDiag1Bit : uint8_t

strong

Bits that are set in the return value of readDiag1() to indicate warning and fault conditions.

See the DRV8434S datasheet for detailed descriptions of these conditions.

Enumerator
OCP_LS2_B	Overcurrent fault on low-side FET of half bridge 2 in BOUT.
OCP_HS2_B	Overcurrent fault on high-side FET of half bridge 2 in BOUT.
OCP_LS1_B	Overcurrent fault on low-side FET of half bridge 1 in BOUT.
OCP_HS1_B	Overcurrent fault on high-side FET of half bridge 1 in BOUT.
OCP_LS2_A	Overcurrent fault on low-side FET of half bridge 2 in AOUT.
OCP_HS2_A	Overcurrent fault on high-side FET of half bridge 2 in AOUT.
OCP_LS1_A	Overcurrent fault on low-side FET of half bridge 1 in AOUT.
OCP_HS1_A	Overcurrent fault on high-side FET of half bridge 1 in AOUT.

Definition at line 167 of file DRV8434S.h.

DRV8434SDiag2Bit

enum class DRV8434SDiag2Bit : uint8_t

strong

Bits that are set in the return value of readDiag2() to indicate warning and fault conditions.

See the DRV8434S datasheet for detailed descriptions of these conditions.

Enumerator
OTW	Overtemperature warning.
OTS	Overtemperature shutdown.
STL_LRN_OK	Stall detection learning successful.
STALL	Motor stall condition.
OL_B	Open load on BOUT.
OL_A	Open load on AOUT.

Definition at line 198 of file DRV8434S.h.

DRV8434SFaultBit

enum class DRV8434SFaultBit : uint8_t

strong

Bits that are set in the return value of readFault() to indicate warning and fault conditions.

See the DRV8434S datasheet for detailed descriptions of these conditions.

Enumerator
FAULT	Fault indication (0 when nFAULT pin is high, 1 when nFAULT pin is low)
SPI_ERROR	SPI protocol error (latched)
UVLO	Supply undervoltage lockout fault.
CPUV	Charge pump undervoltage fault.
OCP	Overcurrent fault.
STL	Motor stall.
TF	Overtemperature warning or shutdown.
OL	Open load.

Definition at line 136 of file DRV8434S.h.

DRV8434SRegAddr

enum class DRV8434SRegAddr : uint8_t

strong

Addresses of control and status registers.

Definition at line 20 of file DRV8434S.h.

DRV8434SStepMode

enum class DRV8434SStepMode : uint8_t

strong

Possible arguments to setStepMode().

Enumerator
MicroStep1_100	Full step with 100% current.
MicroStep1	Full step with 71% current.
MicroStep2_NC	Non-circular 1/2 step.
MicroStep2	Circular 1/2 step.

Definition at line 233 of file DRV8434S.h.