Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc] Add missing pneumatics docs (NFC) (#5389)

Browse Source 
Add missing HAL docs for PCM and PH
Fix references to PCM
Document different one shot durations for PCM and PH
This commit is contained in:
sciencewhiz
2023-06-15 08:14:35 -07:00
committed by GitHub
parent c3e04a6ea2
commit 5c2addda0f
9 changed files with 497 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
wpilibc/src/main/native/include/frc/PneumaticsControlModule.h
View File

@@ -118,7 +118,7 @@ class PneumaticsControlModule : public PneumaticsBase {
/**
* Returns whether the compressor has been disconnected since sticky faults
* were last cleared. This fault is persistent and can be cleared by
* ClearAllStickyFaults()}
* ClearAllStickyFaults()
*
* @return True if the compressor has been disconnected since sticky faults
* were last cleared, otherwise false.
@@ -126,7 +126,22 @@ class PneumaticsControlModule : public PneumaticsBase {
*/
bool GetCompressorNotConnectedStickyFault() const;
/**
* Returns whether the solenoid is currently reporting a voltage fault.
*
* @return True if solenoid is reporting a fault, otherwise false.
* @see GetSolenoidVoltageStickyFault()
*/
bool GetSolenoidVoltageFault() const;
/**
* Returns whether the solenoid has reported a voltage fault since sticky
* faults were last cleared. This fault is persistent and can be cleared by
* ClearAllStickyFaults()
*
* @return True if solenoid is reporting a fault, otherwise false.
* @see GetSolenoidVoltageFault()
*/
bool GetSolenoidVoltageStickyFault() const;
/** Clears all sticky faults on this device. */