HighPowerStepperDriver
Loading...
Searching...
No Matches
DRV8711SPI Class Reference

#include <HighPowerStepperDriver.h>

Public Member Functions

void setChipSelectPin (uint8_t pin)
uint16_t readReg (uint8_t address)
 Reads the register at the given address and returns its raw value.
uint16_t readReg (HPSDRegAddr address)
 Reads the register at the given address and returns its raw value.
void writeReg (uint8_t address, uint16_t value)
 Writes the specified value to a register.
void writeReg (HPSDRegAddr address, uint16_t value)
 Writes the specified value to a register.

Detailed Description

This class provides low-level functions for reading and writing from the SPI interface of a DRV8711 stepper motor controller IC.

Most users should use the HighPowerStepperDriver class, which provides a higher-level interface, instead of this class.

Definition at line 40 of file HighPowerStepperDriver.h.

Member Function Documentation

◆ readReg() [1/2]

uint16_t DRV8711SPI::readReg ( HPSDRegAddr address)
inline

Reads the register at the given address and returns its raw value.

Definition at line 67 of file HighPowerStepperDriver.h.

◆ readReg() [2/2]

uint16_t DRV8711SPI::readReg ( uint8_t address)
inline

Reads the register at the given address and returns its raw value.

Definition at line 54 of file HighPowerStepperDriver.h.

◆ setChipSelectPin()

void DRV8711SPI::setChipSelectPin ( uint8_t pin)
inline

Configures this object to use the specified pin as a chip select pin.

You must use a chip select pin; the DRV8711 requires it.

Definition at line 46 of file HighPowerStepperDriver.h.

◆ writeReg() [1/2]

void DRV8711SPI::writeReg ( HPSDRegAddr address,
uint16_t value )
inline

Writes the specified value to a register.

Definition at line 88 of file HighPowerStepperDriver.h.

◆ writeReg() [2/2]

void DRV8711SPI::writeReg ( uint8_t address,
uint16_t value )
inline

Writes the specified value to a register.

Definition at line 73 of file HighPowerStepperDriver.h.


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