Pneumatic#

Introduction#

The Pneumatics system uses an air pump and solenoid to control compressed air for moving cylinders. It can turn the pump on or off and extend or retract cylinders through code.

This page uses Pneumatic1 as the example Pneumatic System name. Replace it with your own configured name as needed.

Below is a list of available methods:

Actions – Compress or decompress air with an air pump.

  • extend – Extend a cylinder.

  • retract – Retract a cylinder.

  • pumpOn – Turn on the air pump.

  • pumpOff – Turn off the air pump.

  • pump – Set the on or off state of the air pump.

Getters – Check if the solenoid is connected.

  • installed – Returns whether or not a solenoid is connected to the Brain.

Constructors – Manually initialize and configure Pneumatics.

Actions#

extend#

extend extends a cylinder.

Usage:
Pneumatic1.extend(id);

Parameters

Description

id

The cylinder to extend:

  • cylinder1
  • cylinder2
  • cylinderALL – Both cylinders

retract#

retract retracts a cylinder.

Usage:
Pneumatic1.retract(id);

Parameters

Description

id

The cylinder to extend:

  • cylinder1
  • cylinder2
  • cylinderALL – Both cylinders

pumpOn#

pumpOn turns the air pump on.

Usage:
Pneumatic1.pumpOn();

Parameters

Description

This method has no parameters.

pumpOff#

pumpOff turns the air pump off.

Usage:
Pneumatic1.pumpOff();

Parameters

Description

This method has no parameters.

pump#

pump turns the air pump on or off.

Usage:
Pneumatic1.pump(state);

Parameters

Description

state

The air pump state:

  • true – Turn the air pump on.
  • false – Turn the air pump off.

Getters#

installed#

installed returns a Boolean indicating whether the solenoid is connected to the Brain.

  • 1 - The solenoid is connected to the Brain.

  • 0 - The solenoid is not connected to the Brain.

Usage:
Pneumatic1.installed()

Parameters

Description

This method has no parameters.

Constructors#

pneumatic#

pneumatic creates an object of the pneumatic Class in the specified port.

Default Usage:
pneumatic Pneumatic1 = pneumatic(smartport);

Overload Usages:
pneumatic Pneumatic1 = pneumatic(smartport, bPumpEnable);

Parameter

Description

smartport

The Smart Port that the Pneumatic Solenoid is connected to, written as PORTx where x is the number of the port.

bPumpEnable

A Boolean representing whether to enable or disable the air pump:

  • true – The air pump is set to on at the start of a project.
  • false – The air pump is set to off at the start of the project.
    int main() {
      // Initializing Robot Configuration. DO NOT REMOVE!
      vexcodeInit();
    
      // Create a Pneumatics object in Port 3
      pneumatic myPneumatic = pneumatic(PORT3);
    
      // Create another in Port 4 that starts with pump enabled
      pneumatic PumpOnPneumatic = pneumatic(PORT4, true);
    }