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

…6436)

hal/src/main/java/edu/wpi/first/hal/PowerDistributionJNI.java

@@ -83,6 +83,8 @@ public class PowerDistributionJNI extends JNIWrapper {
   /**
    * Gets the temperature of the PowerDistribution.
    *
+   * <p>Not supported on the Rev PDH and returns 0.
+   *
    * @param handle the module handle
    * @return the module temperature (celsius)
    * @see "HAL_GetPowerDistributionTemperature"
@@ -129,7 +131,9 @@ public class PowerDistributionJNI extends JNIWrapper {
   public static native double getTotalCurrent(int handle);
 
   /**
-   * Gets the total power of the PowerDistribution.
+   * Gets the total power of the Power Distribution Panel.
+   *
+   * <p>Not supported on the Rev PDH and returns 0.
    *
    * @param handle the module handle
    * @return the total power (watts)
@@ -138,7 +142,9 @@ public class PowerDistributionJNI extends JNIWrapper {
   public static native double getTotalPower(int handle);
 
   /**
-   * Gets the total energy of the PowerDistribution.
+   * Gets the total energy of the Power Distribution Panel.
+   *
+   * <p>Not supported on the Rev PDH and does nothing.
    *
    * @param handle the module handle
    * @return the total energy (joules)
@@ -147,7 +153,9 @@ public class PowerDistributionJNI extends JNIWrapper {
   public static native double getTotalEnergy(int handle);
 
   /**
-   * Resets the PowerDistribution accumulated energy.
+   * Resets the Power Distribution Panel accumulated energy.
+   *
+   * <p>Not supported on the Rev PDH and returns 0.
    *
    * @param handle the module handle
    * @see "HAL_ClearPowerDistributionStickyFaults"

hal/src/main/native/include/hal/PowerDistribution.h

@@ -101,7 +101,9 @@ int32_t HAL_GetPowerDistributionNumChannels(HAL_PowerDistributionHandle handle,
                                             int32_t* status);
 
 /**
- * Gets the temperature of the PowerDistribution.
+ * Gets the temperature of the Power Distribution Panel.
+ *
+ * Not supported on the Rev PDH and returns 0.
  *
  * @param[in] handle the module handle
  * @param[out] status Error status variable. 0 on success.
@@ -156,7 +158,9 @@ double HAL_GetPowerDistributionTotalCurrent(HAL_PowerDistributionHandle handle,
                                             int32_t* status);
 
 /**
- * Gets the total power of the PowerDistribution.
+ * Gets the total power of the Power Distribution Panel.
+ *
+ * Not supported on the Rev PDH and returns 0.
  *
  * @param[in] handle the module handle
  * @param[out] status Error status variable. 0 on success.
@@ -166,7 +170,9 @@ double HAL_GetPowerDistributionTotalPower(HAL_PowerDistributionHandle handle,
                                           int32_t* status);
 
 /**
- * Gets the total energy of the PowerDistribution.
+ * Gets the total energy of the Power Distribution Panel.
+ *
+ * Not supported on the Rev PDH and returns 0.
  *
  * @param[in] handle the module handle
  * @param[out] status Error status variable. 0 on success.
@@ -178,6 +184,8 @@ double HAL_GetPowerDistributionTotalEnergy(HAL_PowerDistributionHandle handle,
 /**
  * Resets the PowerDistribution accumulated energy.
  *
+ * Not supported on the Rev PDH and does nothing.
+ *
  * @param[in] handle the module handle
  * @param[out] status Error status variable. 0 on success.
  */

wpilibc/src/main/native/include/frc/PowerDistribution.h

@@ -58,7 +58,10 @@ class PowerDistribution : public wpi::Sendable,
   double GetVoltage() const;
 
   /**
-   * Query the temperature of the PDP/PDH.
+   * Query the temperature of the PDP.
+   *
+   * Not supported on the Rev PDH and returns 0.
+   *
    *
    * @return The temperature in degrees Celsius
    */
@@ -80,21 +83,27 @@ class PowerDistribution : public wpi::Sendable,
   double GetTotalCurrent() const;
 
   /**
-   * Query the total power drawn from all monitored PDP/PDH channels.
+   * Query the total power drawn from all monitored PDP channels.
+   *
+   * Not supported on the Rev PDH and returns 0.
    *
    * @return The total power drawn in Watts
    */
   double GetTotalPower() const;
 
   /**
-   * Query the total energy drawn from the monitored PDP/PDH channels.
+   * Query the total energy drawn from the monitored PDP channels.
+   *
+   * Not supported on the Rev PDH and returns 0.
    *
    * @return The total energy drawn in Joules
    */
   double GetTotalEnergy() const;
 
   /**
-   * Reset the total energy drawn from the PDP/PDH.
+   * Reset the total energy drawn from the PDP.
+   *
+   * Not supported on the Rev PDH and does nothing.
    *
    * @see PowerDistribution#GetTotalEnergy
    */

wpilibj/src/main/java/edu/wpi/first/wpilibj/PowerDistribution.java

@@ -93,7 +93,9 @@ public double getVoltage() {
   }
 
   /**
-   * 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 double getTotalCurrent() {
   }
 
   /**
-   * 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,15 +134,21 @@ public double getTotalPower() {
   }
 
   /**
-   * 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
    */
   public double getTotalEnergy() {
     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);
   }