HighPowerStepperDriver
Classes | Enumerations
HighPowerStepperDriver.h File Reference
#include <Arduino.h>
#include <SPI.h>

Go to the source code of this file.

Classes

class  DRV8711SPI
 
class  HighPowerStepperDriver
 

Enumerations

enum  HPSDRegAddr : uint8_t {
  CTRL = 0x00, TORQUE = 0x01, OFF = 0x02, BLANK = 0x03,
  DECAY = 0x04, STALL = 0x05, DRIVE = 0x06, STATUS = 0x07
}
 Addresses of control and status registers.
 
enum  HPSDStepMode : uint16_t {
  MicroStep256 = 256, MicroStep128 = 128, MicroStep64 = 64, MicroStep32 = 32,
  MicroStep16 = 16, MicroStep8 = 8, MicroStep4 = 4, MicroStep2 = 2,
  MicroStep1 = 1
}
 Possible arguments to setStepMode().
 
enum  HPSDDecayMode : uint8_t {
  Slow = 0b000, SlowIncMixedDec = 0b001, Fast = 0b010, Mixed = 0b011,
  SlowIncAutoMixedDec = 0b100, AutoMixed = 0b101
}
 Possible arguments to setDecayMode().
 
enum  HPSDStatusBit : uint8_t {
  HPSDStatusBit::OTS = 0, HPSDStatusBit::AOCP = 1, HPSDStatusBit::BOCP = 2, HPSDStatusBit::APDF = 3,
  HPSDStatusBit::BPDF = 4, HPSDStatusBit::UVLO = 5, HPSDStatusBit::STD = 6, HPSDStatusBit::STDLAT = 7
}
 

Detailed Description

This is the main header file for the HighPowerStepperDriver library, a library for controlling Pololu's High-Power Stepper Motor Drivers that are based on the DRV8711.

For more information about this library, see:

https://github.com/pololu/high-power-stepper-driver-arduino

That is the main repository for this library.

Definition in file HighPowerStepperDriver.h.

Enumeration Type Documentation

◆ HPSDStatusBit

enum HPSDStatusBit : uint8_t
strong

Bits that are set in the return value of readStatus() to indicate status conditions.

See the DRV8711 datasheet for detailed descriptions of these status conditions.

Enumerator
OTS 

Overtemperature shutdown.

AOCP 

Channel A overcurrent shutdown.

BOCP 

Channel B overcurrent shutdown.

APDF 

Channel A predriver fault.

BPDF 

Channel B predriver fault.

UVLO 

Undervoltage lockout.

STD 

Stall detected.

STDLAT 

Latched stall detect.

Definition at line 148 of file HighPowerStepperDriver.h.