TMCLReply Struct Reference

Reply structure returned by sendCommand() More...

#include <TMC9660CommInterface.hpp>

Public Member Functions
bool	isOK () const noexcept

Static Public Member Functions
static bool	fromSpi (std::span< const uint8_t, 8 > in, TMCLReply &r) noexcept
	Decode reply from SPI datagram.
static bool	fromUart (std::span< const uint8_t, 9 > in, uint8_t addr, TMCLReply &r) noexcept
	Decode reply from UART datagram.

Public Attributes
SPIStatus	spiStatus = SPIStatus::OK
	SPI status byte.
uint8_t	status = 0
	TMCL status code (100=OK, 101=LOADED)
uint8_t	opcode = 0
	Echoed operation code.
uint32_t	value = 0
	Optional returned value.

Detailed Description

Reply structure returned by sendCommand()

Member Function Documentation

fromSpi()

static bool TMCLReply::fromSpi ( std::span< const uint8_t, 8 >  in, TMCLReply &  r  )

inlinestaticnoexcept

Decode reply from SPI datagram.

fromUart()

static bool TMCLReply::fromUart ( std::span< const uint8_t, 9 >  in, uint8_t  addr, TMCLReply &  r  )

inlinestaticnoexcept

Decode reply from UART datagram.

isOK()

bool TMCLReply::isOK ( ) const

inlinenoexcept

Member Data Documentation

opcode

uint8_t TMCLReply::opcode = 0

Echoed operation code.

spiStatus

SPIStatus TMCLReply::spiStatus = SPIStatus::OK

SPI status byte.

status

uint8_t TMCLReply::status = 0

TMCL status code (100=OK, 101=LOADED)

value

uint32_t TMCLReply::value = 0

Optional returned value.

---

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

• TMC9660CommInterface.hpp