Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-23 01: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;
};

74
wpilibc/src/main/native/include/frc/PowerDistribution.h
View File

@@ -155,44 +155,82 @@ class PowerDistribution : public wpi::Sendable,
*/
void SetSwitchableChannel(bool enabled);
/** Version and device data received from a PowerDistribution device */
struct Version {
/** Firmware major version number. */
uint32_t FirmwareMajor;
/** Firmware minor version number. */
uint32_t FirmwareMinor;
/** Firmware fix version number. */
uint32_t FirmwareFix;
/** Hardware minor version number. */
uint32_t HardwareMinor;
/** Hardware major version number. */
uint32_t HardwareMajor;
/** Unique ID. */
uint32_t UniqueId;
};
Version GetVersion() const;
/**
* Faults for a PowerDistribution device. These faults are only active while
* the condition is active.
*/
struct Faults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 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;
/**
@@ -208,38 +246,72 @@ class PowerDistribution : public wpi::Sendable,
/**
* Returns the power distribution faults.
*
* On a CTRE PDP, this will return an object with no faults active.
*
* @return The power distribution faults.
*/
Faults GetFaults() const;
/**
* Sticky faults for a PowerDistribution device. These faults will remain
* active until they are reset by the user.
*/
struct StickyFaults {
/** Breaker fault on channel 0. */
uint32_t Channel0BreakerFault : 1;
/** Breaker fault on channel 1. */
uint32_t Channel1BreakerFault : 1;
/** Breaker fault on channel 2. */
uint32_t Channel2BreakerFault : 1;
/** Breaker fault on channel 3. */
uint32_t Channel3BreakerFault : 1;
/** Breaker fault on channel 4. */
uint32_t Channel4BreakerFault : 1;
/** Breaker fault on channel 5. */
uint32_t Channel5BreakerFault : 1;
/** Breaker fault on channel 6. */
uint32_t Channel6BreakerFault : 1;
/** Breaker fault on channel 7. */
uint32_t Channel7BreakerFault : 1;
/** Breaker fault on channel 8. */
uint32_t Channel8BreakerFault : 1;
/** Breaker fault on channel 9. */
uint32_t Channel9BreakerFault : 1;
/** Breaker fault on channel 10. */
uint32_t Channel10BreakerFault : 1;
/** Breaker fault on channel 12. */
uint32_t Channel11BreakerFault : 1;
/** Breaker fault on channel 13. */
uint32_t Channel12BreakerFault : 1;
/** Breaker fault on channel 14. */
uint32_t Channel13BreakerFault : 1;
/** Breaker fault on channel 15. */
uint32_t Channel14BreakerFault : 1;
/** Breaker fault on channel 16. */
uint32_t Channel15BreakerFault : 1;
/** Breaker fault on channel 17. */
uint32_t Channel16BreakerFault : 1;
/** Breaker fault on channel 18. */
uint32_t Channel17BreakerFault : 1;
/** Breaker fault on channel 19. */
uint32_t Channel18BreakerFault : 1;
/** Breaker fault on channel 20. */
uint32_t Channel19BreakerFault : 1;
/** Breaker fault on channel 21. */
uint32_t Channel20BreakerFault : 1;
/** Breaker fault on channel 22. */
uint32_t Channel21BreakerFault : 1;
/** Breaker fault on channel 23. */
uint32_t Channel22BreakerFault : 1;
/** Breaker fault on channel 24. */
uint32_t Channel23BreakerFault : 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;
/**
@@ -256,6 +328,8 @@ class PowerDistribution : public wpi::Sendable,
/**
* Returns the power distribution sticky faults.
*
* On a CTRE PDP, this will return an object with no faults active.
*
* @return The power distribution sticky faults.
*/
StickyFaults GetStickyFaults() const;