Functions to control Power Distribution devices. More...

Classes
struct	HAL_PowerDistributionVersion
	Power distribution version. More...

struct	HAL_PowerDistributionFaults

struct	HAL_PowerDistributionStickyFaults
	Storage for REV PDH Sticky Faults. More...

struct	HAL_PowerDistributionChannelData

Macros
#define	HAL_DEFAULT_POWER_DISTRIBUTION_MODULE -1
	Use the default module number for the selected module type.

Typedefs
typedef struct HAL_PowerDistributionChannelData	HAL_PowerDistributionChannelData

Enumerations
enum	HAL_PowerDistributionType : int32_t { HAL_PowerDistributionType_kAutomatic = 0 , HAL_PowerDistributionType_kCTRE = 1 , HAL_PowerDistributionType_kRev = 2 }
	The types of power distribution devices. More...

Functions
HAL_PowerDistributionHandle	HAL_InitializePowerDistribution (int32_t moduleNumber, HAL_PowerDistributionType type, const char allocationLocation, int32_t status)
	Initializes a Power Distribution Panel.

int32_t	HAL_GetPowerDistributionModuleNumber (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the module number for a specific handle.

void	HAL_CleanPowerDistribution (HAL_PowerDistributionHandle handle)
	Cleans a PowerDistribution module.

HAL_Bool	HAL_CheckPowerDistributionChannel (HAL_PowerDistributionHandle handle, int32_t channel)
	Checks if a PowerDistribution channel is valid.

HAL_Bool	HAL_CheckPowerDistributionModule (int32_t module, HAL_PowerDistributionType type)
	Checks if a PowerDistribution module is valid.

HAL_PowerDistributionType	HAL_GetPowerDistributionType (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the type of PowerDistribution module.

int32_t	HAL_GetPowerDistributionNumChannels (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the number of channels for this handle.

double	HAL_GetPowerDistributionTemperature (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the temperature of the Power Distribution Panel.

double	HAL_GetPowerDistributionVoltage (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the PowerDistribution input voltage.

double	HAL_GetPowerDistributionChannelCurrent (HAL_PowerDistributionHandle handle, int32_t channel, int32_t *status)
	Gets the current of a specific PowerDistribution channel.

void	HAL_GetPowerDistributionAllChannelCurrents (HAL_PowerDistributionHandle handle, double currents, int32_t currentsLength, int32_t status)
	Gets the current of all channels on the PowerDistribution.

double	HAL_GetPowerDistributionTotalCurrent (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the total current of the PowerDistribution.

double	HAL_GetPowerDistributionTotalPower (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the total power of the Power Distribution Panel.

double	HAL_GetPowerDistributionTotalEnergy (HAL_PowerDistributionHandle handle, int32_t *status)
	Gets the total energy of the Power Distribution Panel.

void	HAL_ResetPowerDistributionTotalEnergy (HAL_PowerDistributionHandle handle, int32_t *status)
	Resets the PowerDistribution accumulated energy.

void	HAL_ClearPowerDistributionStickyFaults (HAL_PowerDistributionHandle handle, int32_t *status)
	Clears any PowerDistribution sticky faults.

void	HAL_SetPowerDistributionSwitchableChannel (HAL_PowerDistributionHandle handle, HAL_Bool enabled, int32_t *status)
	Power on/off switchable channel.

HAL_Bool	HAL_GetPowerDistributionSwitchableChannel (HAL_PowerDistributionHandle handle, int32_t *status)
	Returns true if switchable channel is powered on.

void	HAL_GetPowerDistributionVersion (HAL_PowerDistributionHandle handle, HAL_PowerDistributionVersion version, int32_t status)
	Get the version of the PowerDistribution.

void	HAL_GetPowerDistributionFaults (HAL_PowerDistributionHandle handle, HAL_PowerDistributionFaults faults, int32_t status)
	Get the current faults of the PowerDistribution.

void	HAL_GetPowerDistributionStickyFaults (HAL_PowerDistributionHandle handle, HAL_PowerDistributionStickyFaults stickyFaults, int32_t status)
	Gets the sticky faults of the PowerDistribution.

void	HAL_StartPowerDistributionStream (HAL_PowerDistributionHandle handle, int32_t *status)

HAL_PowerDistributionChannelData *	HAL_GetPowerDistributionStreamData (HAL_PowerDistributionHandle handle, int32_t count, int32_t status)

void	HAL_FreePowerDistributionStreamData (HAL_PowerDistributionChannelData *data, int32_t count)

void	HAL_StopPowerDistributionStream (HAL_PowerDistributionHandle handle, int32_t *status)

Detailed Description

Functions to control Power Distribution devices.

Macro Definition Documentation

◆ HAL_DEFAULT_POWER_DISTRIBUTION_MODULE

#define HAL_DEFAULT_POWER_DISTRIBUTION_MODULE -1

Use the default module number for the selected module type.

Typedef Documentation

◆ HAL_PowerDistributionChannelData

typedef struct HAL_PowerDistributionChannelData HAL_PowerDistributionChannelData

Enumeration Type Documentation

◆ HAL_PowerDistributionType

enum HAL_PowerDistributionType : int32_t

The types of power distribution devices.

Enumerator
HAL_PowerDistributionType_kAutomatic	Automatically determines the module type.
HAL_PowerDistributionType_kCTRE	CTRE (Cross The Road Electronics) Power Distribution Panel (PDP).
HAL_PowerDistributionType_kRev	REV Power Distribution Hub (PDH).

Function Documentation

◆ HAL_CheckPowerDistributionChannel()

HAL_Bool HAL_CheckPowerDistributionChannel	(	HAL_PowerDistributionHandle	handle,
		int32_t	channel )

Checks if a PowerDistribution channel is valid.

Parameters

handle	the module handle
channel	the channel to check

Returns: true if the channel is valid, otherwise false

◆ HAL_CheckPowerDistributionModule()

HAL_Bool HAL_CheckPowerDistributionModule	(	int32_t	module,
		HAL_PowerDistributionType	type )

Checks if a PowerDistribution module is valid.

Parameters

module	the module to check
type	the type of module

Returns: true if the module is valid, otherwise false

◆ HAL_CleanPowerDistribution()

void HAL_CleanPowerDistribution ( HAL_PowerDistributionHandle handle )

Cleans a PowerDistribution module.

Parameters

handle the module handle

◆ HAL_ClearPowerDistributionStickyFaults()

void HAL_ClearPowerDistributionStickyFaults	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Clears any PowerDistribution sticky faults.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

◆ HAL_FreePowerDistributionStreamData()

void HAL_FreePowerDistributionStreamData	(	HAL_PowerDistributionChannelData *	data,
		int32_t	count )

◆ HAL_GetPowerDistributionAllChannelCurrents()

void HAL_GetPowerDistributionAllChannelCurrents	(	HAL_PowerDistributionHandle	handle,
		double *	currents,
		int32_t	currentsLength,
		int32_t *	status )

Gets the current of all channels on the PowerDistribution.

The array must be large enough to hold all channels.

Parameters

[in]	handle	the module handle
[out]	currents	the currents
[in]	currentsLength	the length of the currents array
[out]	status	Error status variable. 0 on success.

◆ HAL_GetPowerDistributionChannelCurrent()

double HAL_GetPowerDistributionChannelCurrent	(	HAL_PowerDistributionHandle	handle,
		int32_t	channel,
		int32_t *	status )

Gets the current of a specific PowerDistribution channel.

Parameters

[in]	handle	the module handle
[in]	channel	the channel
[out]	status	Error status variable. 0 on success.

Returns: the channel current (amps)

◆ HAL_GetPowerDistributionFaults()

void HAL_GetPowerDistributionFaults	(	HAL_PowerDistributionHandle	handle,
		HAL_PowerDistributionFaults *	faults,
		int32_t *	status )

Get the current faults of the PowerDistribution.

On a CTRE PDP, this will return an object with no faults active.

Parameters

[in]	handle	the module handle
[out]	faults	the HAL_PowerDistributionFaults to populate
[out]	status	Error status variable. 0 on success.

◆ HAL_GetPowerDistributionModuleNumber()

int32_t HAL_GetPowerDistributionModuleNumber	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the module number for a specific handle.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the module number

◆ HAL_GetPowerDistributionNumChannels()

int32_t HAL_GetPowerDistributionNumChannels	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the number of channels for this handle.

Parameters

[in]	handle	the handle
[out]	status	Error status variable. 0 on success.

Returns: number of channels

◆ HAL_GetPowerDistributionStickyFaults()

void HAL_GetPowerDistributionStickyFaults	(	HAL_PowerDistributionHandle	handle,
		HAL_PowerDistributionStickyFaults *	stickyFaults,
		int32_t *	status )

Gets the sticky faults of the PowerDistribution.

On a CTRE PDP, this will return an object with no faults active.

Parameters

[in]	handle	the module handle
[out]	stickyFaults	the HAL_PowerDistributionStickyFaults to populate
[out]	status	Error status variable. 0 on success.

◆ HAL_GetPowerDistributionStreamData()

HAL_PowerDistributionChannelData * HAL_GetPowerDistributionStreamData	(	HAL_PowerDistributionHandle	handle,
		int32_t *	count,
		int32_t *	status )

◆ HAL_GetPowerDistributionSwitchableChannel()

HAL_Bool HAL_GetPowerDistributionSwitchableChannel	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Returns true if switchable channel is powered on.

This is a REV PDH-specific function. This function will no-op on CTRE PDP.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the state of the switchable channel

◆ HAL_GetPowerDistributionTemperature()

double HAL_GetPowerDistributionTemperature	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the temperature of the Power Distribution Panel.

Not supported on the Rev PDH and returns 0.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the module temperature (celsius)

◆ HAL_GetPowerDistributionTotalCurrent()

double HAL_GetPowerDistributionTotalCurrent	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the total current of the PowerDistribution.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the total current (amps)

◆ HAL_GetPowerDistributionTotalEnergy()

double HAL_GetPowerDistributionTotalEnergy	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the total energy of the Power Distribution Panel.

Not supported on the Rev PDH and returns 0.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the total energy (joules)

◆ HAL_GetPowerDistributionTotalPower()

double HAL_GetPowerDistributionTotalPower	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the total power of the Power Distribution Panel.

Not supported on the Rev PDH and returns 0.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the total power (watts)

◆ HAL_GetPowerDistributionType()

HAL_PowerDistributionType HAL_GetPowerDistributionType	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the type of PowerDistribution module.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the type of module

◆ HAL_GetPowerDistributionVersion()

void HAL_GetPowerDistributionVersion	(	HAL_PowerDistributionHandle	handle,
		HAL_PowerDistributionVersion *	version,
		int32_t *	status )

Get the version of the PowerDistribution.

Parameters

[in]	handle	the module handle
[out]	version	the HAL_PowerDistributionVersion to populate
[out]	status	Error status variable. 0 on success.

◆ HAL_GetPowerDistributionVoltage()

double HAL_GetPowerDistributionVoltage	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Gets the PowerDistribution input voltage.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

Returns: the input voltage (volts)

◆ HAL_InitializePowerDistribution()

HAL_PowerDistributionHandle HAL_InitializePowerDistribution	(	int32_t	moduleNumber,
		HAL_PowerDistributionType	type,
		const char *	allocationLocation,
		int32_t *	status )

Initializes a Power Distribution Panel.

Parameters

[in]	moduleNumber	the module number to initialize
[in]	type	the type of module to initialize
[in]	allocationLocation	the location where the allocation is occurring
[out]	status	Error status variable. 0 on success.

Returns: the created PowerDistribution handle

◆ HAL_ResetPowerDistributionTotalEnergy()

void HAL_ResetPowerDistributionTotalEnergy	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Resets the PowerDistribution accumulated energy.

Not supported on the Rev PDH and does nothing.

Parameters

[in]	handle	the module handle
[out]	status	Error status variable. 0 on success.

◆ HAL_SetPowerDistributionSwitchableChannel()

void HAL_SetPowerDistributionSwitchableChannel	(	HAL_PowerDistributionHandle	handle,
		HAL_Bool	enabled,
		int32_t *	status )

Power on/off switchable channel.

This is a REV PDH-specific function. This function will no-op on CTRE PDP.

Parameters

[in]	handle	the module handle
[in]	enabled	true to turn on switchable channel
[out]	status	Error status variable. 0 on success.

◆ HAL_StartPowerDistributionStream()

void HAL_StartPowerDistributionStream	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

◆ HAL_StopPowerDistributionStream()

void HAL_StopPowerDistributionStream	(	HAL_PowerDistributionHandle	handle,
		int32_t *	status )

Classes

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ HAL_DEFAULT_POWER_DISTRIBUTION_MODULE

Typedef Documentation

◆ HAL_PowerDistributionChannelData

Enumeration Type Documentation

◆ HAL_PowerDistributionType

Function Documentation

◆ HAL_CheckPowerDistributionChannel()

◆ HAL_CheckPowerDistributionModule()

◆ HAL_CleanPowerDistribution()

◆ HAL_ClearPowerDistributionStickyFaults()

◆ HAL_FreePowerDistributionStreamData()

◆ HAL_GetPowerDistributionAllChannelCurrents()

◆ HAL_GetPowerDistributionChannelCurrent()

◆ HAL_GetPowerDistributionFaults()

◆ HAL_GetPowerDistributionModuleNumber()

◆ HAL_GetPowerDistributionNumChannels()

◆ HAL_GetPowerDistributionStickyFaults()

◆ HAL_GetPowerDistributionStreamData()

◆ HAL_GetPowerDistributionSwitchableChannel()

◆ HAL_GetPowerDistributionTemperature()

◆ HAL_GetPowerDistributionTotalCurrent()

◆ HAL_GetPowerDistributionTotalEnergy()

◆ HAL_GetPowerDistributionTotalPower()

◆ HAL_GetPowerDistributionType()

◆ HAL_GetPowerDistributionVersion()

◆ HAL_GetPowerDistributionVoltage()

◆ HAL_InitializePowerDistribution()

◆ HAL_ResetPowerDistributionTotalEnergy()

◆ HAL_SetPowerDistributionSwitchableChannel()

◆ HAL_StartPowerDistributionStream()

◆ HAL_StopPowerDistributionStream()