Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-07-05 03:21:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

[docs] Add documentation for various HAL/wpilib items (NFC) (#6898)

Browse Source
This commit is contained in:
Ryan Blue
2024-08-01 19:45:20 -04:00
committed by GitHub
parent 244be83d5d
commit ddd64aa70c
37 changed files with 599 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
wpilibc/src/main/native/include/frc/PneumaticHub.h
View File

@@ -119,12 +119,19 @@ class PneumaticHub : public PneumaticsBase {
int reverseChannel) override;
Compressor MakeCompressor() override;
/** Version and device data received from a REV PH. */
struct Version {
/** The firmware major version. */
uint32_t FirmwareMajor;
/** The firmware minor version. */
uint32_t FirmwareMinor;
/** The firmware fix version. */
uint32_t FirmwareFix;
/** The hardware minor version. */
uint32_t HardwareMinor;
/** The hardware major version. */
uint32_t HardwareMajor;
/** The device's unique ID. */
uint32_t UniqueId;
};
@@ -135,28 +142,54 @@ class PneumaticHub : public PneumaticsBase {
*/
Version GetVersion() const;
/**
* Faults for a REV PH. These faults are only active while the condition is
* active.
*/
struct Faults {
/** Fault on channel 0. */
uint32_t Channel0Fault : 1;
/** Fault on channel 1. */
uint32_t Channel1Fault : 1;
/** Fault on channel 2. */
uint32_t Channel2Fault : 1;
/** Fault on channel 3. */
uint32_t Channel3Fault : 1;
/** Fault on channel 4. */
uint32_t Channel4Fault : 1;
/** Fault on channel 5. */
uint32_t Channel5Fault : 1;
/** Fault on channel 6. */
uint32_t Channel6Fault : 1;
/** Fault on channel 7. */
uint32_t Channel7Fault : 1;
/** Fault on channel 8. */
uint32_t Channel8Fault : 1;
/** Fault on channel 9. */
uint32_t Channel9Fault : 1;
/** Fault on channel 10. */
uint32_t Channel10Fault : 1;
/** Fault on channel 11. */
uint32_t Channel11Fault : 1;
/** Fault on channel 12. */
uint32_t Channel12Fault : 1;
/** Fault on channel 13. */
uint32_t Channel13Fault : 1;
/** Fault on channel 14. */
uint32_t Channel14Fault : 1;
/** Fault on channel 15. */
uint32_t Channel15Fault : 1;
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
/** An overcurrent event occurred on a solenoid ouput. */
uint32_t SolenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
/** The hardware on the device has malfunctioned. */
uint32_t HardwareFault : 1;
/**
@@ -176,13 +209,24 @@ class PneumaticHub : public PneumaticsBase {
*/
Faults GetFaults() const;
/**
* Sticky faults for a REV PH. These faults will remain active until they
* are reset by the user.
*/
struct StickyFaults {
/** An overcurrent event occurred on the compressor output. */
uint32_t CompressorOverCurrent : 1;
/** The compressor output has an open circuit. */
uint32_t CompressorOpen : 1;
/** An overcurrent event occurred on a solenoid ouput. */
uint32_t SolenoidOverCurrent : 1;
/** The input voltage is below the minimum voltage. */
uint32_t Brownout : 1;
/** A warning was raised by the device's CAN controller. */
uint32_t CanWarning : 1;
/** The device's CAN controller experienced a "Bus Off" event. */
uint32_t CanBusOff : 1;
/** The device has rebooted. */
uint32_t HasReset : 1;
};