HardFOC Flux V1 HAL
Unified HAL API for the HardFOC Flux valve-control platform (ESP32-S3)
Loading...
Searching...
No Matches
Classes | Enumerations | Functions
flux::hal Namespace Reference

Classes

struct  HalResult
 Facade operation result. More...
 
struct  ValveBank
 Both valve banks, as one hardware-gated actuator group. More...
 

Enumerations

enum class  ManagerError : uint16_t {
  None = 0 , NotInitialized = 1 , BindFailed = 2 , HardwareFault = 3 ,
  InvalidArgument = 4 , Busy = 5 , Unsupported = 6 , DependencyNotReady = 7
}
 Lifecycle / bind failure catalog shared by every manager (GetManagerError()). More...
 

Functions

constexpr const char * ToString (ManagerError e) noexcept
 Short name of a ManagerError, for logs and diagnostics.
 

Enumeration Type Documentation

◆ ManagerError

enum class flux::hal::ManagerError : uint16_t
strong

Lifecycle / bind failure catalog shared by every manager (GetManagerError()).

Set by a manager when EnsureInitialized() fails (fail-closed: the manager then reports IsInitialized() == false) or when a later operation finds the hardware gone. None after a successful EnsureInitialized().

Enumerator
None 

No error recorded.

NotInitialized 

Manager not initialised (or shut down)

BindFailed 

A bus, pin or platform object could not be created.

HardwareFault 

A fitted chip did not come up or reported a fault.

InvalidArgument 

Caller passed an invalid argument.

Busy 

Manager busy / re-entrant call refused.

Unsupported 

Operation or part not supported on this build.

DependencyNotReady 

A manager this one needs is not initialised.

Function Documentation

◆ ToString()

constexpr const char * flux::hal::ToString ( ManagerError  e)
constexprnoexcept

Short name of a ManagerError, for logs and diagnostics.

Here is the caller graph for this function: