HF-TMC51x0 Driver (TMC5130 & TMC5160) 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC51x0 (TMC5130 & TMC5160)
Loading...
Searching...
No Matches
tmc51x0::TMC51x0< CommType >::UartConfig Struct Reference

UART configuration subsystem. More...

#include <tmc51x0.hpp>

Collaboration diagram for tmc51x0::TMC51x0< CommType >::UartConfig:
[legend]

Public Member Functions

 UartConfig (TMC51x0 *driver) noexcept
 Construct UART configuration subsystem.
 
Result< void > ConfigureUartNodeAddress (uint8_t node_address, uint8_t send_delay) noexcept
 Configure UART node address and send delay (for sequential programming)
 

Public Attributes

TMC51x0driver_
 Pointer to parent driver instance.
 

Detailed Description

template<typename CommType>
struct tmc51x0::TMC51x0< CommType >::UartConfig

UART configuration subsystem.

Provides methods for configuring UART node addressing for multi-node operation.

Constructor & Destructor Documentation

◆ UartConfig()

template<typename CommType >
tmc51x0::TMC51x0< CommType >::UartConfig::UartConfig ( TMC51x0 * driver)
inlineexplicitnoexcept

Construct UART configuration subsystem.

Parameters
driverPointer to parent TMC51x0 driver instance

Member Function Documentation

◆ ConfigureUartNodeAddress()

template<typename CommType >
Result< void > tmc51x0::TMC51x0< CommType >::UartConfig::ConfigureUartNodeAddress ( uint8_t node_address,
uint8_t send_delay )
noexcept

Configure UART node address and send delay (for sequential programming)

Parameters
node_addressUART node address (0-254)
send_delayNumber of bit times before replying (0-15)
Returns
Result<void> indicating success or error

Writes to NODECONF register using address 0 (for sequential programming via NAI/NAO pins). This is used during sequential programming when devices are accessible at address 0.

Note
For normal operation, use communication.ConfigureUartNodeAddress() instead.
Per datasheet, devices are typically programmed backwards from address 254 (254, 253, 252, ...).

Member Data Documentation

◆ driver_

template<typename CommType >
TMC51x0* tmc51x0::TMC51x0< CommType >::UartConfig::driver_

Pointer to parent driver instance.


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