diff --git a/wpilibc/wpilibC++Devices/include/PowerDistributionPanel.h b/wpilibc/wpilibC++Devices/include/PowerDistributionPanel.h index ef89b3fdfe..24f53e5f80 100644 --- a/wpilibc/wpilibC++Devices/include/PowerDistributionPanel.h +++ b/wpilibc/wpilibC++Devices/include/PowerDistributionPanel.h @@ -12,7 +12,8 @@ #include "LiveWindow/LiveWindowSendable.h" /** - * Class for getting voltage, current, and temperature from the CAN PDP + * Class for getting voltage, current, temperature, power and energy from the CAN PDP. + * The PDP must be at CAN Address 0. * @author Thomas Clark */ class PowerDistributionPanel : public SensorBase, public LiveWindowSendable { diff --git a/wpilibc/wpilibC++Devices/src/PowerDistributionPanel.cpp b/wpilibc/wpilibC++Devices/src/PowerDistributionPanel.cpp index 330e6954a6..2a961a0875 100644 --- a/wpilibc/wpilibC++Devices/src/PowerDistributionPanel.cpp +++ b/wpilibc/wpilibC++Devices/src/PowerDistributionPanel.cpp @@ -18,7 +18,7 @@ PowerDistributionPanel::PowerDistributionPanel() { /** * Query the input voltage of the PDP - * @return The voltage of the PDP + * @return The voltage of the PDP in volts */ double PowerDistributionPanel::GetVoltage() { @@ -93,7 +93,7 @@ PowerDistributionPanel::GetTotalCurrent() { /** * Query the total power drawn from the monitored PDP channels - * @return The the total power drawn from the PDP channels in Joules + * @return The the total power drawn from the PDP channels in Watts */ double PowerDistributionPanel::GetTotalPower() { @@ -110,7 +110,7 @@ PowerDistributionPanel::GetTotalPower() { /** * Query the total energy drawn from the monitored PDP channels - * @return The the total energy drawn from the PDP channels in Watts + * @return The the total energy drawn from the PDP channels in Joules */ double PowerDistributionPanel::GetTotalEnergy() { diff --git a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/PowerDistributionPanel.java b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/PowerDistributionPanel.java index a522c5368e..b265a82efc 100644 --- a/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/PowerDistributionPanel.java +++ b/wpilibj/wpilibJavaDevices/src/main/java/edu/wpi/first/wpilibj/PowerDistributionPanel.java @@ -17,7 +17,8 @@ import edu.wpi.first.wpilibj.livewindow.LiveWindowSendable; import edu.wpi.first.wpilibj.tables.ITable; /** - * Class for getting voltage, current, and temperature from the CAN PDP + * Class for getting voltage, current, temperature, power and energy from the CAN PDP. + * The PDP must be at CAN Address 0. * @author Thomas Clark */ public class PowerDistributionPanel extends SensorBase implements LiveWindowSendable { @@ -26,7 +27,7 @@ public class PowerDistributionPanel extends SensorBase implements LiveWindowSend /** * Query the input voltage of the PDP - * @return The voltage of the PDP + * @return The voltage of the PDP in volts */ public double getVoltage() { ByteBuffer status = ByteBuffer.allocateDirect(4); @@ -67,7 +68,7 @@ public class PowerDistributionPanel extends SensorBase implements LiveWindowSend /** * Query the current of all monitored PDP channels (0-15) - * @return The current of all the channels + * @return The current of all the channels in Amperes */ public double getTotalCurrent(){ ByteBuffer status = ByteBuffer.allocateDirect(4); @@ -80,7 +81,7 @@ public class PowerDistributionPanel extends SensorBase implements LiveWindowSend /** * Query the total power drawn from the monitored PDP channels - * @return the total power + * @return the total power in Watts */ public double getTotalPower(){ ByteBuffer status = ByteBuffer.allocateDirect(4); @@ -94,7 +95,7 @@ public class PowerDistributionPanel extends SensorBase implements LiveWindowSend /** * Query the total energy drawn from the monitored PDP channels - * @return the total power + * @return the total energy in Joules */ public double getTotalEnergy(){ ByteBuffer status = ByteBuffer.allocateDirect(4);