MAX22200 Driver
API reference
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
max22200::DriverStatistics Struct Reference

Driver runtime statistics. More...

#include <max22200_types.hpp>

Public Member Functions

 DriverStatistics ()
 
float getSuccessRate () const
 
bool hasFailures () const
 true if failed_transfers > 0
 
bool isHealthy () const
 true if failed_transfers == 0
 
uint32_t getTotalTransfers () const
 Total SPI transfer attempts.
 
uint32_t getFailedTransfers () const
 Failed SPI or validation operations.
 
uint32_t getFaultEvents () const
 Fault event counter (reserved, always 0 in current driver)
 
uint32_t getStateChanges () const
 State change counter (reserved, always 0 in current driver)
 
uint32_t getUptimeMs () const
 Uptime counter in ms (reserved, always 0 in current driver)
 

Public Attributes

uint32_t total_transfers
 Total SPI operations attempted.
 
uint32_t failed_transfers
 SPI or parameter failures counted by updateStatistics()
 
uint32_t fault_events
 Reserved (not incremented by current driver)
 
uint32_t state_changes
 Reserved (not incremented by current driver)
 
uint32_t uptime_ms
 Reserved (not incremented by current driver)
 

Detailed Description

Driver runtime statistics.

Counters updated by the driver during SPI operations. As of the current implementation, only total_transfers and failed_transfers are incremented; fault_events, state_changes, and uptime_ms remain at zero.

Constructor & Destructor Documentation

◆ DriverStatistics()

max22200::DriverStatistics::DriverStatistics ( )
inline

Member Function Documentation

◆ getFailedTransfers()

uint32_t max22200::DriverStatistics::getFailedTransfers ( ) const
inline

Failed SPI or validation operations.

◆ getFaultEvents()

uint32_t max22200::DriverStatistics::getFaultEvents ( ) const
inline

Fault event counter (reserved, always 0 in current driver)

◆ getStateChanges()

uint32_t max22200::DriverStatistics::getStateChanges ( ) const
inline

State change counter (reserved, always 0 in current driver)

◆ getSuccessRate()

float max22200::DriverStatistics::getSuccessRate ( ) const
inline

◆ getTotalTransfers()

uint32_t max22200::DriverStatistics::getTotalTransfers ( ) const
inline

Total SPI transfer attempts.

◆ getUptimeMs()

uint32_t max22200::DriverStatistics::getUptimeMs ( ) const
inline

Uptime counter in ms (reserved, always 0 in current driver)

◆ hasFailures()

bool max22200::DriverStatistics::hasFailures ( ) const
inline

true if failed_transfers > 0

◆ isHealthy()

bool max22200::DriverStatistics::isHealthy ( ) const
inline

true if failed_transfers == 0

Member Data Documentation

◆ failed_transfers

uint32_t max22200::DriverStatistics::failed_transfers

SPI or parameter failures counted by updateStatistics()

◆ fault_events

uint32_t max22200::DriverStatistics::fault_events

Reserved (not incremented by current driver)

◆ state_changes

uint32_t max22200::DriverStatistics::state_changes

Reserved (not incremented by current driver)

◆ total_transfers

uint32_t max22200::DriverStatistics::total_transfers

Total SPI operations attempted.

◆ uptime_ms

uint32_t max22200::DriverStatistics::uptime_ms

Reserved (not incremented by current driver)


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