Module class for controlling a Cross The Road Electronics Pneumatics Control Module. More...

#include <wpi/hardware/pneumatic/PneumaticsControlModule.hpp>

Inheritance diagram for wpi::PneumaticsControlModule:

Public Member Functions
	PneumaticsControlModule (int busId)
	Constructs a PneumaticsControlModule with the default ID (0).
	PneumaticsControlModule (int busId, int module)
	Constructs a PneumaticsControlModule.
	~PneumaticsControlModule () override=default
bool	GetCompressor () const override
	Returns whether the compressor is active or not.
void	DisableCompressor () override
	Disables the compressor.
void	EnableCompressorDigital () override
	Enables the compressor in digital mode using the digital pressure switch.
void	EnableCompressorAnalog (wpi::units::pounds_per_square_inch_t minPressure, wpi::units::pounds_per_square_inch_t maxPressure) override
	Enables the compressor in digital mode.
void	EnableCompressorHybrid (wpi::units::pounds_per_square_inch_t minPressure, wpi::units::pounds_per_square_inch_t maxPressure) override
	Enables the compressor in digital mode.
CompressorConfigType	GetCompressorConfigType () const override
	Returns the active compressor configuration.
bool	GetPressureSwitch () const override
	Returns the state of the pressure switch.
wpi::units::ampere_t	GetCompressorCurrent () const override
	Returns the current drawn by the compressor.
bool	GetCompressorCurrentTooHighFault () const
	Return whether the compressor current is currently too high.
bool	GetCompressorCurrentTooHighStickyFault () const
	Returns whether the compressor current has been too high since sticky faults were last cleared.
bool	GetCompressorShortedFault () const
	Returns whether the compressor is currently shorted.
bool	GetCompressorShortedStickyFault () const
	Returns whether the compressor has been shorted since sticky faults were last cleared.
bool	GetCompressorNotConnectedFault () const
	Returns whether the compressor is currently disconnected.
bool	GetCompressorNotConnectedStickyFault () const
	Returns whether the compressor has been disconnected since sticky faults were last cleared.
bool	GetSolenoidVoltageFault () const
	Returns whether the solenoid is currently reporting a voltage fault.
bool	GetSolenoidVoltageStickyFault () const
	Returns whether the solenoid has reported a voltage fault since sticky faults were last cleared.
void	ClearAllStickyFaults ()
	Clears all sticky faults on this device.
void	SetSolenoids (int mask, int values) override
	Sets solenoids on a pneumatics module.
int	GetSolenoids () const override
	Gets a bitmask of solenoid values.
int	GetModuleNumber () const override
	Get module number for this module.
int	GetSolenoidDisabledList () const override
	Get a bitmask of disabled solenoids.
void	FireOneShot (int index) override
	Fire a single solenoid shot.
void	SetOneShotDuration (int index, wpi::units::second_t duration) override
	Set the duration for a single solenoid shot.
bool	CheckSolenoidChannel (int channel) const override
	Check if a solenoid channel is valid.
int	CheckAndReserveSolenoids (int mask) override
	Check to see if the solenoids marked in the bitmask can be reserved, and if so, reserve them.
void	UnreserveSolenoids (int mask) override
	Unreserve the solenoids marked in the bitmask.
bool	ReserveCompressor () override
	Reserve the compressor.
void	UnreserveCompressor () override
	Unreserve the compressor.
wpi::units::volt_t	GetAnalogVoltage (int channel) const override
	Unsupported by the CTRE PCM.
wpi::units::pounds_per_square_inch_t	GetPressure (int channel) const override
	Unsupported by the CTRE PCM.
Solenoid	MakeSolenoid (int channel) override
	Create a solenoid object for the specified channel.
DoubleSolenoid	MakeDoubleSolenoid (int forwardChannel, int reverseChannel) override
	Create a double solenoid object for the specified channels.
Compressor	MakeCompressor () override
	Create a compressor object.
void	ReportUsage (std::string_view device, std::string_view data) override
	Report usage.
Public Member Functions inherited from wpi::PneumaticsBase
virtual	~PneumaticsBase ()=default

Friends
class	DataStore
class	PneumaticsBase

Additional Inherited Members
Static Public Member Functions inherited from wpi::PneumaticsBase
static std::shared_ptr< PneumaticsBase >	GetForType (int busId, int module, PneumaticsModuleType moduleType)
	For internal use to get a module for a specific type.
static int	GetDefaultForType (PneumaticsModuleType moduleType)
	For internal use to get the default for a specific type.

Detailed Description

Module class for controlling a Cross The Road Electronics Pneumatics Control Module.

Constructor & Destructor Documentation

◆ PneumaticsControlModule() [1/2]

wpi::PneumaticsControlModule::PneumaticsControlModule ( int busId )

explicit

Constructs a PneumaticsControlModule with the default ID (0).

Parameters

busId The bus ID.

◆ PneumaticsControlModule() [2/2]

wpi::PneumaticsControlModule::PneumaticsControlModule	(	int	busId,
		int	module )

Constructs a PneumaticsControlModule.

Parameters

busId	The bus ID.
module	module number to construct

◆ ~PneumaticsControlModule()

wpi::PneumaticsControlModule::~PneumaticsControlModule ( )

overridedefault

Member Function Documentation

◆ CheckAndReserveSolenoids()

int wpi::PneumaticsControlModule::CheckAndReserveSolenoids ( int mask )

overridevirtual

Check to see if the solenoids marked in the bitmask can be reserved, and if so, reserve them.

Parameters

mask	The bitmask of solenoids to reserve. The LSB represents solenoid 0.

Returns: 0 if successful; mask of solenoids that couldn't be allocated otherwise

Implements wpi::PneumaticsBase.

◆ CheckSolenoidChannel()

bool wpi::PneumaticsControlModule::CheckSolenoidChannel ( int channel ) const

overridevirtual

Check if a solenoid channel is valid.

Parameters

channel Channel to check

Returns: True if channel exists

Implements wpi::PneumaticsBase.

◆ ClearAllStickyFaults()

void wpi::PneumaticsControlModule::ClearAllStickyFaults ( )

Clears all sticky faults on this device.

◆ DisableCompressor()

void wpi::PneumaticsControlModule::DisableCompressor ( )

overridevirtual

Disables the compressor.

The compressor will not turn on until EnableCompressorDigital() is called.

Implements wpi::PneumaticsBase.

◆ EnableCompressorAnalog()

void wpi::PneumaticsControlModule::EnableCompressorAnalog	(	wpi::units::pounds_per_square_inch_t	minPressure,
		wpi::units::pounds_per_square_inch_t	maxPressure )

overridevirtual

Enables the compressor in digital mode.

Analog mode is unsupported by the CTRE PCM.

Parameters

minPressure	Unsupported.
maxPressure	Unsupported.

See also: EnableCompressorDigital()

Implements wpi::PneumaticsBase.

◆ EnableCompressorDigital()

void wpi::PneumaticsControlModule::EnableCompressorDigital ( )

overridevirtual

Enables the compressor in digital mode using the digital pressure switch.

The compressor will turn on when the pressure switch indicates that the system is not full, and will turn off when the pressure switch indicates that the system is full.

Implements wpi::PneumaticsBase.

◆ EnableCompressorHybrid()

void wpi::PneumaticsControlModule::EnableCompressorHybrid	(	wpi::units::pounds_per_square_inch_t	minPressure,
		wpi::units::pounds_per_square_inch_t	maxPressure )

overridevirtual

Enables the compressor in digital mode.

Hybrid mode is unsupported by the CTRE PCM.

Parameters

minPressure	Unsupported.
maxPressure	Unsupported.

See also: EnableCompressorDigital()

Implements wpi::PneumaticsBase.

◆ FireOneShot()

void wpi::PneumaticsControlModule::FireOneShot ( int index )

overridevirtual

Fire a single solenoid shot.

Parameters

index solenoid index

Implements wpi::PneumaticsBase.

◆ GetAnalogVoltage()

wpi::units::volt_t wpi::PneumaticsControlModule::GetAnalogVoltage ( int channel ) const

overridevirtual

Unsupported by the CTRE PCM.

Parameters

channel Unsupported.

Returns: 0

Implements wpi::PneumaticsBase.

◆ GetCompressor()

bool wpi::PneumaticsControlModule::GetCompressor ( ) const

overridevirtual

Returns whether the compressor is active or not.

Returns: True if the compressor is on - otherwise false.

Implements wpi::PneumaticsBase.

◆ GetCompressorConfigType()

CompressorConfigType wpi::PneumaticsControlModule::GetCompressorConfigType ( ) const

overridevirtual

Returns the active compressor configuration.

Returns: The active compressor configuration.

Implements wpi::PneumaticsBase.

◆ GetCompressorCurrent()

wpi::units::ampere_t wpi::PneumaticsControlModule::GetCompressorCurrent ( ) const

overridevirtual

Returns the current drawn by the compressor.

Returns: The current drawn by the compressor.

Implements wpi::PneumaticsBase.

◆ GetCompressorCurrentTooHighFault()

bool wpi::PneumaticsControlModule::GetCompressorCurrentTooHighFault ( ) const

Return whether the compressor current is currently too high.

Returns: True if the compressor current is too high, otherwise false.

See also: GetCompressorCurrentTooHighStickyFault()

◆ GetCompressorCurrentTooHighStickyFault()

bool wpi::PneumaticsControlModule::GetCompressorCurrentTooHighStickyFault ( ) const

Returns whether the compressor current has been too high since sticky faults were last cleared.

This fault is persistent and can be cleared by ClearAllStickyFaults()

Returns: True if the compressor current has been too high since sticky faults were last cleared.

See also: GetCompressorCurrentTooHighFault()

◆ GetCompressorNotConnectedFault()

bool wpi::PneumaticsControlModule::GetCompressorNotConnectedFault ( ) const

Returns whether the compressor is currently disconnected.

Returns: True if compressor is currently disconnected, otherwise false.

See also: GetCompressorNotConnectedStickyFault()

◆ GetCompressorNotConnectedStickyFault()

bool wpi::PneumaticsControlModule::GetCompressorNotConnectedStickyFault ( ) const

Returns whether the compressor has been disconnected since sticky faults were last cleared.

This fault is persistent and can be cleared by ClearAllStickyFaults()

Returns: True if the compressor has been disconnected since sticky faults were last cleared, otherwise false.

See also: GetCompressorNotConnectedFault()

◆ GetCompressorShortedFault()

bool wpi::PneumaticsControlModule::GetCompressorShortedFault ( ) const

Returns whether the compressor is currently shorted.

Returns: True if the compressor is currently shorted, otherwise false.

See also: GetCompressorShortedStickyFault()

◆ GetCompressorShortedStickyFault()

bool wpi::PneumaticsControlModule::GetCompressorShortedStickyFault ( ) const

Returns whether the compressor has been shorted since sticky faults were last cleared.

This fault is persistent and can be cleared by ClearAllStickyFaults()

Returns: True if the compressor has been shorted since sticky faults were last cleared, otherwise false.

See also: GetCompressorShortedFault()

◆ GetModuleNumber()

int wpi::PneumaticsControlModule::GetModuleNumber ( ) const

overridevirtual

Get module number for this module.

Returns: module number

Implements wpi::PneumaticsBase.

◆ GetPressure()

wpi::units::pounds_per_square_inch_t wpi::PneumaticsControlModule::GetPressure ( int channel ) const

overridevirtual

Unsupported by the CTRE PCM.

Parameters

channel Unsupported.

Returns: 0

Implements wpi::PneumaticsBase.

◆ GetPressureSwitch()

bool wpi::PneumaticsControlModule::GetPressureSwitch ( ) const

overridevirtual

Returns the state of the pressure switch.

Returns: True if pressure switch indicates that the system is full, otherwise false.

Implements wpi::PneumaticsBase.

◆ GetSolenoidDisabledList()

int wpi::PneumaticsControlModule::GetSolenoidDisabledList ( ) const

overridevirtual

Get a bitmask of disabled solenoids.

Returns: Bitmask indicating disabled solenoids. The LSB represents solenoid 0.

Implements wpi::PneumaticsBase.

◆ GetSolenoids()

int wpi::PneumaticsControlModule::GetSolenoids ( ) const

overridevirtual

Gets a bitmask of solenoid values.

Returns: Bitmask containing the state of the solenoids. The LSB represents solenoid 0.

Implements wpi::PneumaticsBase.

◆ GetSolenoidVoltageFault()

bool wpi::PneumaticsControlModule::GetSolenoidVoltageFault ( ) const

Returns whether the solenoid is currently reporting a voltage fault.

Returns: True if solenoid is reporting a fault, otherwise false.

See also: GetSolenoidVoltageStickyFault()

◆ GetSolenoidVoltageStickyFault()

bool wpi::PneumaticsControlModule::GetSolenoidVoltageStickyFault ( ) const

Returns whether the solenoid has reported a voltage fault since sticky faults were last cleared.

This fault is persistent and can be cleared by ClearAllStickyFaults()

Returns: True if solenoid is reporting a fault, otherwise false.

See also: GetSolenoidVoltageFault()

◆ MakeCompressor()

Compressor wpi::PneumaticsControlModule::MakeCompressor ( )

overridevirtual

Create a compressor object.

Returns: Compressor object

Implements wpi::PneumaticsBase.

◆ MakeDoubleSolenoid()

DoubleSolenoid wpi::PneumaticsControlModule::MakeDoubleSolenoid	(	int	forwardChannel,
		int	reverseChannel )

overridevirtual

Create a double solenoid object for the specified channels.

Parameters

forwardChannel	solenoid channel for forward
reverseChannel	solenoid channel for reverse

Returns: DoubleSolenoid object

Implements wpi::PneumaticsBase.

◆ MakeSolenoid()

Solenoid wpi::PneumaticsControlModule::MakeSolenoid ( int channel )

overridevirtual

Create a solenoid object for the specified channel.

Parameters

channel solenoid channel

Returns: Solenoid object

Implements wpi::PneumaticsBase.

◆ ReportUsage()

void wpi::PneumaticsControlModule::ReportUsage	(	std::string_view	device,
		std::string_view	data )

overridevirtual

Report usage.

Parameters

device	device and channel as appropriate
data	arbitrary usage data

Implements wpi::PneumaticsBase.

◆ ReserveCompressor()

bool wpi::PneumaticsControlModule::ReserveCompressor ( )

overridevirtual

Reserve the compressor.

Returns: true if successful; false if compressor already reserved

Implements wpi::PneumaticsBase.

◆ SetOneShotDuration()

void wpi::PneumaticsControlModule::SetOneShotDuration	(	int	index,
		wpi::units::second_t	duration )

overridevirtual

Set the duration for a single solenoid shot.

Parameters

index	solenoid index
duration	shot duration

Implements wpi::PneumaticsBase.

◆ SetSolenoids()

void wpi::PneumaticsControlModule::SetSolenoids	(	int	mask,
		int	values )

overridevirtual

Sets solenoids on a pneumatics module.

Parameters

mask	Bitmask indicating which solenoids to set. The LSB represents solenoid 0.
values	Bitmask indicating the desired states of the solenoids. The LSB represents solenoid 0.

Implements wpi::PneumaticsBase.

◆ UnreserveCompressor()

void wpi::PneumaticsControlModule::UnreserveCompressor ( )

overridevirtual

Unreserve the compressor.

Implements wpi::PneumaticsBase.

◆ UnreserveSolenoids()

void wpi::PneumaticsControlModule::UnreserveSolenoids ( int mask )

overridevirtual

Unreserve the solenoids marked in the bitmask.

Parameters

mask	The bitmask of solenoids to unreserve. The LSB represents solenoid 0.

Implements wpi::PneumaticsBase.

◆ DataStore

friend class DataStore

friend

◆ PneumaticsBase

friend class PneumaticsBase

friend

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

wpi/hardware/pneumatic/PneumaticsControlModule.hpp

Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ PneumaticsControlModule() [1/2]

◆ PneumaticsControlModule() [2/2]

◆ ~PneumaticsControlModule()

Member Function Documentation

◆ CheckAndReserveSolenoids()

◆ CheckSolenoidChannel()

◆ ClearAllStickyFaults()

◆ DisableCompressor()

◆ EnableCompressorAnalog()

◆ EnableCompressorDigital()

◆ EnableCompressorHybrid()

◆ FireOneShot()

◆ GetAnalogVoltage()

◆ GetCompressor()

◆ GetCompressorConfigType()

◆ GetCompressorCurrent()

◆ GetCompressorCurrentTooHighFault()

◆ GetCompressorCurrentTooHighStickyFault()

◆ GetCompressorNotConnectedFault()

◆ GetCompressorNotConnectedStickyFault()

◆ GetCompressorShortedFault()

◆ GetCompressorShortedStickyFault()

◆ GetModuleNumber()

◆ GetPressure()

◆ GetPressureSwitch()

◆ GetSolenoidDisabledList()

◆ GetSolenoids()

◆ GetSolenoidVoltageFault()

◆ GetSolenoidVoltageStickyFault()

◆ MakeCompressor()

◆ MakeDoubleSolenoid()

◆ MakeSolenoid()

◆ ReportUsage()

◆ ReserveCompressor()

◆ SetOneShotDuration()

◆ SetSolenoids()

◆ UnreserveCompressor()

◆ UnreserveSolenoids()

Friends And Related Symbol Documentation

◆ DataStore

◆ PneumaticsBase