HardFOC Flux V1 HAL
Unified HAL API for the HardFOC Flux valve-control platform (ESP32-S3)
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
flux::hal::ValveBank Struct Reference

Both valve banks, as one hardware-gated actuator group. More...

#include <flux_hal_valve.hpp>

Static Public Member Functions

static HalResult EnablePins (bool on) noexcept
 Drop (false) or re-arm (true) both valve-bank enable pins.
 
static bool EnablePinsHigh () noexcept
 Both enable pins are driven high (banks may be energised by channel commands).
 
static bool IsHeldOff () noexcept
 The pins were dropped and not re-armed since.
 

Detailed Description

Both valve banks, as one hardware-gated actuator group.

Member Function Documentation

◆ EnablePins()

HalResult flux::hal::ValveBank::EnablePins ( bool  on)
staticnoexcept

Drop (false) or re-arm (true) both valve-bank enable pins.

Parameters
onfalse: drive both enables low now, latch the drop, refuse channel energising calls. true: re-arm by re-running the valve bring-up, which raises both pins.
Returns
Ok, or Err(HardwareFault) when a pin could not be driven / bring-up failed, Err(NotInitialized) when no enable pin exists (GPIO manager down) on a drop.
Here is the call graph for this function:

◆ EnablePinsHigh()

bool flux::hal::ValveBank::EnablePinsHigh ( )
staticnoexcept

Both enable pins are driven high (banks may be energised by channel commands).

Here is the call graph for this function:

◆ IsHeldOff()

bool flux::hal::ValveBank::IsHeldOff ( )
staticnoexcept

The pins were dropped and not re-armed since.

Here is the call graph for this function:

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