HF-TMC9660 Driver 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC9660
Loading...
Searching...
No Matches
tmc9660::BootloaderReplyUART Struct Reference

Bootloader reply structure for UART (64-bit / 8-byte protocol). More...

#include <bootloader_protocol.hpp>

Public Member Functions

bool verifyCRC (const std::array< uint8_t, 8 > &in) const noexcept
 Verify CRC8 checksum.
 
bool isOK () const noexcept
 Check if reply indicates success.
 
BootloaderStatus getStatus () const noexcept
 Get status as enum.
 

Static Public Member Functions

static BootloaderReplyUART fromBuffer (const std::array< uint8_t, 8 > &in) noexcept
 Deserialize from 8-byte UART buffer.
 

Public Attributes

uint8_t hostAddr
 Host address.
 
uint8_t deviceAddr
 Device address.
 
uint8_t status
 Status byte.
 
uint32_t value
 32-bit data value
 

Detailed Description

Bootloader reply structure for UART (64-bit / 8-byte protocol).

Format: [HOST_ADDR] [DEVICE_ADDR] [STATUS] [VALUE(32 MSB first)] [CRC8]

Note: No SYNC byte in reply (unlike request which has 0x55 as first byte). CRC8 verification is automatically performed during deserialization.

Member Function Documentation

◆ fromBuffer()

static BootloaderReplyUART tmc9660::BootloaderReplyUART::fromBuffer ( const std::array< uint8_t, 8 > & in)
inlinestaticnoexcept

Deserialize from 8-byte UART buffer.

Here is the caller graph for this function:

◆ getStatus()

BootloaderStatus tmc9660::BootloaderReplyUART::getStatus ( ) const
inlinenoexcept

Get status as enum.

◆ isOK()

bool tmc9660::BootloaderReplyUART::isOK ( ) const
inlinenoexcept

Check if reply indicates success.

◆ verifyCRC()

bool tmc9660::BootloaderReplyUART::verifyCRC ( const std::array< uint8_t, 8 > & in) const
inlinenoexcept

Verify CRC8 checksum.

Here is the call graph for this function:

Member Data Documentation

◆ deviceAddr

uint8_t tmc9660::BootloaderReplyUART::deviceAddr

Device address.

◆ hostAddr

uint8_t tmc9660::BootloaderReplyUART::hostAddr

Host address.

◆ status

uint8_t tmc9660::BootloaderReplyUART::status

Status byte.

◆ value

uint32_t tmc9660::BootloaderReplyUART::value

32-bit data value


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