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 pneumatic_1 as the example Pneumatic name. Replace it with your own configured name as needed.

Below is a list of all methods:

Actions — Compress or decompress air with an air pump.

• extend — Extend a cylinder.

• retract — Retract a cylinder.

Mutators — Change the state of the air pump.

• pump_on — Turn on the air pump.

• pump_off — 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.

• Pneumatic — Creates a Pneumatics object.

Actions

extend

extend extends a cylinder.

Usage:
pneumatic_1.extend(cylinder)

Parameters	Description
cylinder	The cylinder to extend: CYLINDER1 CYLINDER2 CYLINDERALL – Both cylinders

retract

retract retracts a cylinder.

Usage:
pneumatic_1.retract(cylinder)

Parameters	Description
cylinder	The cylinder to retract: CYLINDER1 CYLINDER2 CYLINDERALL – Both cylinders

Mutators

pump_on

pump_on turns the air pump on.

Usage:
pneumatic_1.pump_on()

Parameters	Description
	This method has no parameters.

pump_off

pump_off turns the air pump off.

Usage:
pneumatic_1.pump_off()

Parameters	Description
	This method has no parameters.

pump

pump turns the air pump on or off.

Usage:
pneumatic_1.pump(state)

Parameters	Description
state	The air compressor 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.

• True — The solenoid is connected to the Brain.

• False — The solenoid is not connected to the Brain.

Usage:
pneumatic_1.installed()

Parameters	Description
	This method has no parameters.

Constructors

Constructors are used to manually create Pneumatic objects, which are necessary for configuring Pneumatics outside of VEXcode.

Pneumatics

The Pneumatic constructor creates a Pneumatic object in the specified Smart Port.

Usage:
pneumatic_1 = Pneumatic(smartport)

Parameter	Description
smartport	The Smart Port that the solenoid is connected to, written as PORTx where x is the number of the port.

# Create a Pneumatic object in Port 1
pneumatic_1 = Pneumatic(Ports.PORT1)