REVPH.h File Reference

#include <stdint.h>
#include "hal/Types.h"

Go to the source code of this file.

Classes
struct	HAL_REVPHVersion
	Storage for REV PH Version. More...
struct	HAL_REVPHCompressorConfig
	Storage for compressor config. More...
struct	HAL_REVPHFaults
	Storage for REV PH Faults. More...
struct	HAL_REVPHStickyFaults
	Storage for REV PH Sticky Faults. More...

Enumerations
enum	HAL_REVPHCompressorConfigType : int32_t { HAL_REVPHCompressorConfigType_kDisabled = 0 , HAL_REVPHCompressorConfigType_kDigital = 1 , HAL_REVPHCompressorConfigType_kAnalog = 2 , HAL_REVPHCompressorConfigType_kHybrid = 3 }
	The compressor configuration type. More...

Functions
HAL_REVPHHandle	HAL_InitializeREVPH (int32_t module, const char *allocationLocation, int32_t *status)
	Initializes a PH.
void	HAL_FreeREVPH (HAL_REVPHHandle handle)
	Frees a PH handle.
HAL_Bool	HAL_CheckREVPHSolenoidChannel (int32_t channel)
	Checks if a solenoid channel number is valid.
HAL_Bool	HAL_CheckREVPHModuleNumber (int32_t module)
	Checks if a PH module (CAN ID) is valid.
HAL_Bool	HAL_GetREVPHCompressor (HAL_REVPHHandle handle, int32_t *status)
	Get whether compressor is turned on.
void	HAL_SetREVPHCompressorConfig (HAL_REVPHHandle handle, const HAL_REVPHCompressorConfig *config, int32_t *status)
	Send compressor configuration to the PH.
void	HAL_SetREVPHClosedLoopControlDisabled (HAL_REVPHHandle handle, int32_t *status)
	Disable Compressor.
void	HAL_SetREVPHClosedLoopControlDigital (HAL_REVPHHandle handle, int32_t *status)
	Enables the compressor in digital mode using the digital pressure switch.
void	HAL_SetREVPHClosedLoopControlAnalog (HAL_REVPHHandle handle, double minAnalogVoltage, double maxAnalogVoltage, int32_t *status)
	Enables the compressor in analog mode.
void	HAL_SetREVPHClosedLoopControlHybrid (HAL_REVPHHandle handle, double minAnalogVoltage, double maxAnalogVoltage, int32_t *status)
	Enables the compressor in hybrid mode.
HAL_REVPHCompressorConfigType	HAL_GetREVPHCompressorConfig (HAL_REVPHHandle handle, int32_t *status)
	Get compressor configuration from the PH.
HAL_Bool	HAL_GetREVPHPressureSwitch (HAL_REVPHHandle handle, int32_t *status)
	Returns the state of the digital pressure switch.
double	HAL_GetREVPHCompressorCurrent (HAL_REVPHHandle handle, int32_t *status)
	Returns the current drawn by the compressor.
double	HAL_GetREVPHAnalogVoltage (HAL_REVPHHandle handle, int32_t channel, int32_t *status)
	Returns the raw voltage of the specified analog input channel.
double	HAL_GetREVPHVoltage (HAL_REVPHHandle handle, int32_t *status)
	Returns the current input voltage for the PH.
double	HAL_GetREVPH5VVoltage (HAL_REVPHHandle handle, int32_t *status)
	Returns the current voltage of the regulated 5v supply.
double	HAL_GetREVPHSolenoidCurrent (HAL_REVPHHandle handle, int32_t *status)
	Returns the total current drawn by all solenoids.
double	HAL_GetREVPHSolenoidVoltage (HAL_REVPHHandle handle, int32_t *status)
	Returns the current voltage of the solenoid power supply.
void	HAL_GetREVPHVersion (HAL_REVPHHandle handle, HAL_REVPHVersion *version, int32_t *status)
	Returns the hardware and firmware versions of the PH.
int32_t	HAL_GetREVPHSolenoids (HAL_REVPHHandle handle, int32_t *status)
	Gets a bitmask of solenoid values.
void	HAL_SetREVPHSolenoids (HAL_REVPHHandle handle, int32_t mask, int32_t values, int32_t *status)
	Sets solenoids on a PH.
void	HAL_FireREVPHOneShot (HAL_REVPHHandle handle, int32_t index, int32_t durMs, int32_t *status)
	Fire a single solenoid shot for the specified duration.
void	HAL_GetREVPHFaults (HAL_REVPHHandle handle, HAL_REVPHFaults *faults, int32_t *status)
	Returns the faults currently active on the PH.
void	HAL_GetREVPHStickyFaults (HAL_REVPHHandle handle, HAL_REVPHStickyFaults *stickyFaults, int32_t *status)
	Returns the sticky faults currently active on this device.
void	HAL_ClearREVPHStickyFaults (HAL_REVPHHandle handle, int32_t *status)
	Clears the sticky faults.
int32_t	HAL_GetREVPHSolenoidDisabledList (HAL_REVPHHandle handle, int32_t *status)
	Get a bitmask of disabled solenoids.