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

[docs] Add docs for features not supported on PDH (NFC) (#6436)

Browse Source
This commit is contained in:
sciencewhiz
2024-03-11 20:22:33 -07:00
committed by GitHub
parent 11c60df3e0
commit f74f6f1d42
4 changed files with 49 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
wpilibj/src/main/java/edu/wpi/first/wpilibj/PowerDistribution.java
View File

@@ -93,7 +93,9 @@ public class PowerDistribution implements Sendable, AutoCloseable {
}
/**
* Query the temperature of the PDP/PDH.
* Query the temperature of the PDP.
*
* <p>Not supported on the Rev PDH and returns 0.
*
* @return The temperature in degrees Celsius
*/
@@ -121,7 +123,9 @@ public class PowerDistribution implements Sendable, AutoCloseable {
}
/**
* Query the total power drawn from the monitored channels.
* Query the total power drawn from the monitored channels of the PDP.
*
* <p>Not supported on the Rev PDH and returns 0.
*
* @return the total power in Watts
*/
@@ -130,7 +134,9 @@ public class PowerDistribution implements Sendable, AutoCloseable {
}
/**
* Query the total energy drawn from the monitored channels.
* Query the total energy drawn from the monitored channels of the PDP.
*
* <p>Not supported on the Rev PDH and returns 0.
*
* @return the total energy in Joules
*/
@@ -138,7 +144,11 @@ public class PowerDistribution implements Sendable, AutoCloseable {
return PowerDistributionJNI.getTotalEnergy(m_handle);
}
/** Reset the total energy to 0. */
/**
* Reset the total energy to 0 of the PDP.
*
* <p>Not supported on the Rev PDH and does nothing.
*/
public void resetTotalEnergy() {
PowerDistributionJNI.resetTotalEnergy(m_handle);
}