Class for getting voltage, current, temperature, power and energy from the CTRE Power Distribution Panel (PDP) or REV Power Distribution Hub (PDH). More...

#include <frc/PowerDistribution.h>

Inheritance diagram for frc::PowerDistribution:

Classes
struct	Faults

struct	StickyFaults

struct	Version

Public Types
enum class	ModuleType { kCTRE = 1 , kRev = 2 }
	Power distribution module type. More...

Public Member Functions
	PowerDistribution ()
	Constructs a PowerDistribution object. More...

	PowerDistribution (int module, ModuleType moduleType)
	Constructs a PowerDistribution object. More...

	~PowerDistribution () override

	PowerDistribution (PowerDistribution &&)=default

PowerDistribution &	operator= (PowerDistribution &&)=default

double	GetVoltage () const
	Query the input voltage of the PDP/PDH. More...

double	GetTemperature () const
	Query the temperature of the PDP. More...

double	GetCurrent (int channel) const
	Query the current of a single channel of the PDP/PDH. More...

double	GetTotalCurrent () const
	Query the total current of all monitored PDP/PDH channels. More...

double	GetTotalPower () const
	Query the total power drawn from all monitored PDP channels. More...

double	GetTotalEnergy () const
	Query the total energy drawn from the monitored PDP channels. More...

void	ResetTotalEnergy ()
	Reset the total energy drawn from the PDP. More...

void	ClearStickyFaults ()
	Remove all of the fault flags on the PDP/PDH. More...

int	GetModule () const
	Gets module number (CAN ID). More...

ModuleType	GetType () const
	Gets module type. More...

bool	GetSwitchableChannel () const
	Gets whether the PDH switchable channel is turned on or off. More...

void	SetSwitchableChannel (bool enabled)
	Sets the PDH switchable channel on or off. More...

Version	GetVersion () const

Faults	GetFaults () const
	Returns the power distribution faults. More...

StickyFaults	GetStickyFaults () const
	Returns the power distribution sticky faults. More...

void	InitSendable (wpi::SendableBuilder &builder) override
	Initializes this Sendable object. More...

Public Member Functions inherited from wpi::Sendable
virtual	~Sendable ()=default

virtual void	InitSendable (SendableBuilder &builder)=0
	Initializes this Sendable object. More...

Public Member Functions inherited from wpi::SendableHelper< PowerDistribution >
	SendableHelper (const SendableHelper &rhs)=default

	SendableHelper (SendableHelper &&rhs)

SendableHelper &	operator= (const SendableHelper &rhs)=default

SendableHelper &	operator= (SendableHelper &&rhs)

Static Public Attributes
static constexpr int	kDefaultModule = -1
	Default module number. More...

Additional Inherited Members
Protected Member Functions inherited from wpi::SendableHelper< PowerDistribution >
	SendableHelper ()=default

	~SendableHelper ()

Detailed Description

Class for getting voltage, current, temperature, power and energy from the CTRE Power Distribution Panel (PDP) or REV Power Distribution Hub (PDH).

Member Enumeration Documentation

◆ ModuleType

enum class frc::PowerDistribution::ModuleType

strong

Power distribution module type.

Enumerator
kCTRE	CTRE (Cross The Road Electronics) CTRE Power Distribution Panel (PDP).
kRev	REV Power Distribution Hub (PDH).

Constructor & Destructor Documentation

◆ PowerDistribution() [1/3]

frc::PowerDistribution::PowerDistribution ( )

Constructs a PowerDistribution object.

Detects the connected PDP/PDH using the default CAN ID (0 for CTRE and 1 for REV).

◆ PowerDistribution() [2/3]

frc::PowerDistribution::PowerDistribution	(	int	module,
		ModuleType	moduleType
	)

Constructs a PowerDistribution object.

Parameters

module	The CAN ID of the PDP/PDH
moduleType	The type of module

◆ ~PowerDistribution()

frc::PowerDistribution::~PowerDistribution ( )

override

◆ PowerDistribution() [3/3]

frc::PowerDistribution::PowerDistribution ( PowerDistribution && )

default

Member Function Documentation

◆ ClearStickyFaults()

void frc::PowerDistribution::ClearStickyFaults ( )

Remove all of the fault flags on the PDP/PDH.

◆ GetCurrent()

double frc::PowerDistribution::GetCurrent ( int channel ) const

Query the current of a single channel of the PDP/PDH.

Parameters

channel the channel to query (0-15 for PDP, 0-23 for PDH)

Returns: The current of the channel in Amperes

◆ GetFaults()

Faults frc::PowerDistribution::GetFaults ( ) const

Returns the power distribution faults.

Returns: The power distribution faults.

◆ GetModule()

int frc::PowerDistribution::GetModule ( ) const

Gets module number (CAN ID).

◆ GetStickyFaults()

StickyFaults frc::PowerDistribution::GetStickyFaults ( ) const

Returns the power distribution sticky faults.

Returns: The power distribution sticky faults.

◆ GetSwitchableChannel()

bool frc::PowerDistribution::GetSwitchableChannel ( ) const

Gets whether the PDH switchable channel is turned on or off.

Returns false with the CTRE PDP.

Returns: The output state of the PDH switchable channel

◆ GetTemperature()

double frc::PowerDistribution::GetTemperature ( ) const

Query the temperature of the PDP.

Not supported on the Rev PDH and returns 0.

Returns: The temperature in degrees Celsius

◆ GetTotalCurrent()

double frc::PowerDistribution::GetTotalCurrent ( ) const

Query the total current of all monitored PDP/PDH channels.

Returns: The total current drawn from all channels in Amperes

◆ GetTotalEnergy()

double frc::PowerDistribution::GetTotalEnergy ( ) const

Query the total energy drawn from the monitored PDP channels.

Not supported on the Rev PDH and returns 0.

Returns: The total energy drawn in Joules

◆ GetTotalPower()

double frc::PowerDistribution::GetTotalPower ( ) const

Query the total power drawn from all monitored PDP channels.

Not supported on the Rev PDH and returns 0.

Returns: The total power drawn in Watts

◆ GetType()

ModuleType frc::PowerDistribution::GetType ( ) const

Gets module type.

◆ GetVersion()

Version frc::PowerDistribution::GetVersion ( ) const

◆ GetVoltage()

double frc::PowerDistribution::GetVoltage ( ) const

Query the input voltage of the PDP/PDH.

Returns: The input voltage in volts

◆ InitSendable()

void frc::PowerDistribution::InitSendable ( wpi::SendableBuilder & builder )

overridevirtual

Initializes this Sendable object.

Parameters

builder sendable builder

Implements wpi::Sendable.

◆ operator=()

PowerDistribution & frc::PowerDistribution::operator= ( PowerDistribution && )

default

◆ ResetTotalEnergy()

void frc::PowerDistribution::ResetTotalEnergy ( )

Reset the total energy drawn from the PDP.

Not supported on the Rev PDH and does nothing.

See also: PowerDistribution::GetTotalEnergy

◆ SetSwitchableChannel()

void frc::PowerDistribution::SetSwitchableChannel ( bool enabled )

Sets the PDH switchable channel on or off.

Does nothing with the CTRE PDP.

Parameters

enabled Whether to turn the PDH switchable channel on or off

Member Data Documentation

◆ kDefaultModule

constexpr int frc::PowerDistribution::kDefaultModule = -1

staticconstexpr

Default module number.

The documentation for this class was generated from the following file:

frc/PowerDistribution.h

Classes

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ModuleType

Constructor & Destructor Documentation

◆ PowerDistribution() [1/3]

◆ PowerDistribution() [2/3]

◆ ~PowerDistribution()

◆ PowerDistribution() [3/3]

Member Function Documentation

◆ ClearStickyFaults()

◆ GetCurrent()

◆ GetFaults()

◆ GetModule()

◆ GetStickyFaults()

◆ GetSwitchableChannel()

◆ GetTemperature()

◆ GetTotalCurrent()

◆ GetTotalEnergy()

◆ GetTotalPower()

◆ GetType()

◆ GetVersion()

◆ GetVoltage()

◆ InitSendable()

◆ operator=()

◆ ResetTotalEnergy()

◆ SetSwitchableChannel()

Member Data Documentation

◆ kDefaultModule