HF-TMC9660 Driver 0.1.0-dev
Hardware Agnostic C++ Driver for the TMC9660
Loading...
Searching...
No Matches
tmc9660::TMC9660< CommType >::Heartbeat::HeartbeatConfig Struct Reference

Configuration structure for heartbeat auto-configuration. More...

#include <tmc9660.hpp>

Public Attributes

std::optional< boolenable
 Enable heartbeat monitoring (optional, default: false).
 
std::optional< uint32_ttimeoutMs
 Heartbeat timeout in milliseconds (optional, default: 1000ms).
 

Detailed Description

template<typename CommType>
struct tmc9660::TMC9660< CommType >::Heartbeat::HeartbeatConfig

Configuration structure for heartbeat auto-configuration.

Member Data Documentation

◆ enable

template<typename CommType >
std::optional<bool> tmc9660::TMC9660< CommType >::Heartbeat::HeartbeatConfig::enable

Enable heartbeat monitoring (optional, default: false).

When enabled, the TMC9660 monitors communication timeout and faults if no commands are received within the timeout period. Enable heartbeat monitoring (optional, default: false)

◆ timeoutMs

template<typename CommType >
std::optional<uint32_t> tmc9660::TMC9660< CommType >::Heartbeat::HeartbeatConfig::timeoutMs

Heartbeat timeout in milliseconds (optional, default: 1000ms).

Timeout period after which the chip faults if no communication occurs. Typical values: 500-5000ms (default: 1000ms) Heartbeat timeout [ms] (optional, default: 1000ms)


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