HardFOC Vortex V1 HAL
Unified HAL API for the HardFOC Vortex motor-control platform (ESP32-C6, TMC9660)
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
ManagerHealthSnapshot Struct Reference

Aggregated health snapshot across all Vortex managers. More...

#include <Vortex.h>

Collaboration diagram for ManagerHealthSnapshot:
[legend]

Public Member Functions

 ManagerHealthSnapshot () noexcept
 

Public Attributes

ManagerHealthEntry entries [kMaxManagers]
 Per-manager entries.
 
size_t count
 Number of populated entries.
 
size_t managers_with_errors
 Count of managers reporting errors.
 
bool all_healthy
 True if no errors and all initialized.
 

Static Public Attributes

static constexpr size_t kMaxManagers = kVortexManagerCount
 

Detailed Description

Aggregated health snapshot across all Vortex managers.

Provides a unified view of errors across all component managers. Error codes are cast to uint8_t; interpretation requires knowledge of the originating manager's error enum.

Supported error sources per manager: NVS — hf_nvs_err_t via GetLastError() CommChannels — CommError via GetLastError() GPIO — hf_gpio_err_t via GetLastError() Motors — MotorError via GetLastError() ADC — hf_adc_err_t via GetLastError() IMU — ImuError via GetLastError() Encoders — EncoderError via GetLastError() LEDs — LedError via GetLastError() Temperature — hf_temp_err_t via GetLastError()

Constructor & Destructor Documentation

◆ ManagerHealthSnapshot()

ManagerHealthSnapshot::ManagerHealthSnapshot ( )
inlinenoexcept

Member Data Documentation

◆ all_healthy

bool ManagerHealthSnapshot::all_healthy

True if no errors and all initialized.

◆ count

size_t ManagerHealthSnapshot::count

Number of populated entries.

◆ entries

ManagerHealthEntry ManagerHealthSnapshot::entries[kMaxManagers]

Per-manager entries.

◆ kMaxManagers

constexpr size_t ManagerHealthSnapshot::kMaxManagers = kVortexManagerCount
staticconstexpr

◆ managers_with_errors

size_t ManagerHealthSnapshot::managers_with_errors

Count of managers reporting errors.


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