Package edu.wpi.first.wpilibj
Interface PneumaticsBase
- All Superinterfaces:
AutoCloseable
- All Known Implementing Classes:
PneumaticHub,PneumaticsControlModule
public interface PneumaticsBase extends AutoCloseable
-
Method Summary
Modifier and Type Method Description intcheckAndReserveSolenoids(int mask)Check to see if the masked solenoids can be reserved, and if not reserve them.booleancheckSolenoidChannel(int channel)Check if a solenoid channel is valid.voidclose()voiddisableCompressor()voidenableCompressorAnalog(double minPressure, double maxPressure)voidenableCompressorDigital()voidenableCompressorHybrid(double minPressure, double maxPressure)voidfireOneShot(int index)Fire a single solenoid shot.doublegetAnalogVoltage(int channel)booleangetCompressor()CompressorConfigTypegetCompressorConfigType()doublegetCompressorCurrent()static intgetDefaultForType(PneumaticsModuleType type)For internal use to get the default for a specific type.static PneumaticsBasegetForType(int module, PneumaticsModuleType type)For internal use to get a module for a specific type.intgetModuleNumber()Get module number for this module.doublegetPressure(int channel)booleangetPressureSwitch()intgetSolenoidDisabledList()Get the disabled solenoids.intgetSolenoids()Gets solenoid values.CompressormakeCompressor()DoubleSolenoidmakeDoubleSolenoid(int forwardChannel, int reverseChannel)SolenoidmakeSolenoid(int channel)booleanreserveCompressor()voidsetOneShotDuration(int index, int durMs)Set the duration for a single solenoid shot.voidsetSolenoids(int mask, int values)Sets solenoids on a pneumatics module.voidunreserveCompressor()voidunreserveSolenoids(int mask)Unreserve the masked solenoids.
-
Method Details
-
getForType
For internal use to get a module for a specific type.- Parameters:
module- module numbertype- module type- Returns:
- module
-
getDefaultForType
For internal use to get the default for a specific type.- Parameters:
type- module type- Returns:
- module default
-
setSolenoids
Sets solenoids on a pneumatics module.- Parameters:
mask- maskvalues- values
-
getSolenoids
int getSolenoids()Gets solenoid values.- Returns:
- values
-
getModuleNumber
int getModuleNumber()Get module number for this module.- Returns:
- module number
-
getSolenoidDisabledList
int getSolenoidDisabledList()Get the disabled solenoids.- Returns:
- disabled list
-
fireOneShot
Fire a single solenoid shot.- Parameters:
index- solenoid index
-
setOneShotDuration
Set the duration for a single solenoid shot.- Parameters:
index- solenoid indexdurMs- shot duration
-
getCompressor
boolean getCompressor() -
getPressureSwitch
boolean getPressureSwitch() -
getCompressorCurrent
double getCompressorCurrent() -
disableCompressor
void disableCompressor() -
enableCompressorDigital
void enableCompressorDigital() -
enableCompressorAnalog
-
enableCompressorHybrid
-
getAnalogVoltage
-
getPressure
-
getCompressorConfigType
-
checkSolenoidChannel
Check if a solenoid channel is valid.- Parameters:
channel- Channel to check- Returns:
- True if channel exists
-
checkAndReserveSolenoids
Check to see if the masked solenoids can be reserved, and if not reserve them.- Parameters:
mask- The solenoid mask to reserve- Returns:
- 0 if successful, mask of solenoids that couldn't be allocated otherwise
-
unreserveSolenoids
Unreserve the masked solenoids.- Parameters:
mask- The solenoid mask to unreserve
-
reserveCompressor
boolean reserveCompressor() -
unreserveCompressor
void unreserveCompressor() -
close
void close()- Specified by:
closein interfaceAutoCloseable
-
makeSolenoid
-
makeDoubleSolenoid
-
makeCompressor
-