Enums#
Analog Units#
Name |
Python Enum |
Description |
---|---|---|
Percent |
|
Expresses the value as a percentage ranging from 0 - 100. |
Eightbit |
|
Encodes the value as an 8-bit integer from 0 - 255. |
Tenbit |
|
Encodes the value as a 10-bit integer from 0 - 1023. |
Twelvebit |
|
Encodes the value as a 12-bit integer from 0 - 4095. |
Millivolts |
|
Measures the value of the analog input in millivolts. |
Axis Types#
Name |
Python Enum |
Description |
---|---|---|
X-Axis |
|
Sets the command to generate values based on the X-Axis. |
Y-Axis |
|
Sets the command to generate values based on the Y-Axis. |
Z-Axis |
|
Sets the command to generate values based on the Z-Axis. |
Brake Types#
Name |
Python Enum |
Description |
---|---|---|
Coast |
|
The |
Brake |
|
The |
Hold |
|
The |
Color Types#
Name |
Python Enum |
Description |
---|---|---|
Red |
|
The predefined color constant for red as the RGB value: (255, 0, 0). |
Green |
|
The predefined color constant for green as the RGB value: (0, 255, 0). |
Blue |
|
The predefined color constant for blue as the RGB value: (0, 0, 255). |
Yellow |
|
The predefined color constant for yellow as the RGB value: (255, 255, 0). |
Orange |
|
The predefined color constant for orange as the RGB value: (255, 165, 0). |
Purple |
|
The predefined color constant for purple as the RGB value: (255, 0, 255). |
Cyan |
|
The predefined color constant for cyan as the RGB value: (0, 255, 255). |
Black |
|
The predefined color constant for black as the RGB value: (0, 0, 0). |
White |
|
The predefined color constant for white as the RGB value: (255, 255, 255). |
Transparent |
|
The predefined color constant for transparent. |
Controller Types#
The Controller type only needs to specified if using a VEX V5 Controller.
Name |
Python Enum |
Description |
---|---|---|
Primary |
|
Sets a V5 controller as the primary controller when initializing a controller. |
Partner |
|
Sets a V5 controller as the partner controller when initializing a controller. |
Cylinder Types#
Name |
Python Enum |
Description |
---|---|---|
Cylinder 1 |
|
The first pneumatic cylinder. |
Cylinder 2 |
|
The second pneumatic cylinder. |
Cylinder 3 |
|
The third pneumatic cylinder. |
Cylinder 4 |
|
The fourth pneumatic cylinder. |
All Cylinders |
|
All pneumatic cylinders. |
Direction Types#
Name |
Python Enum |
Description |
---|---|---|
Forward |
|
Sets the direction for a motor or drivetrain to move to forward. |
Reverse |
|
Sets the direction for a motor or drivetrain to move to reverse. |
Distance Units#
Name |
Python Enum |
Description |
---|---|---|
Millimeters |
|
Measures the value of the distance in millimeters. |
Inches |
|
Measures the value of the distance in inches. |
End Effector Types#
Name |
Python Enum |
Description |
---|---|---|
Magnet |
|
The magnet end effector for the 6-Axis CTE Arm. |
Pen |
|
The pen end effector for the 6-Axis CTE Arm. |
Font Types#
Name |
Python Enum |
Description |
---|---|---|
Mono 12 |
|
The predefined monotype font of size 12. |
Mono 15 |
|
The predefined monotype font of size 15. |
Mono 20 |
|
The predefined monotype font of size 20. |
Mono 30 |
|
The predefined monotype font of size 30. |
Mono 40 |
|
The predefined monotype font of size 40. |
Mono 60 |
|
The predefined monotype font of size 60. |
Proportional 20 |
|
The predefined proportional font of size 20. |
Proportional 30 |
|
The predefined proportional font of size 30. |
Proportional 40 |
|
The predefined proportional font of size 40. |
Proportional 60 |
|
The predefined proportional font of size 60. |
CJK 16 |
|
The predefined Chinese/Japanese/Korean font of size 16. |
Gear Setting#
The Gear setting only needs to specified if using a VEX V5 11 Watt SmartMotor.
Name |
Python Enum |
Description |
---|---|---|
Ratio 36:1 |
|
The constant to represent a 36:1 gear ratio. A red gearbox for a V5 SmartMotor. |
Ratio 18:1 |
|
The constant to represent a 18:1 gear ratio. A green gearbox for a V5 SmartMotor. |
Ratio 6:1 |
|
The constant to represent a 6:1 gear ratio. A blue gearbox for a V5 SmartMotor. |
Gesture Types#
Name |
Python Enum |
Description |
---|---|---|
Up |
|
Represents the up gesture recognized by the optical sensor. |
Down |
|
Represents the down gesture recognized by the optical sensor. |
Left |
|
Represents the left gesture recognized by the optical sensor. |
Right |
|
Represents the right gesture recognized by the optical sensor. |
LED State Types#
Name |
Python Enum |
Description |
---|---|---|
On |
|
Sets the command to turn on the optical sensor’s LED. |
Off |
|
Sets the command to turn off the optical sensor’s LED. |
Blink |
|
This command sets the optical sensor’s LED to blink on and off repeatedly. |
Object Size Types#
Name |
Python Enum |
Description |
---|---|---|
Small |
|
Represents a small object size detected by the distance sensor. |
Medium |
|
Represents a medium object size detected by the distance sensor. |
Large |
|
Represents a large object size detected by the distance sensor. |
None |
|
Represents when no object is detected by the distance sensor. |
Orientation Types#
Name |
Python Enum |
Description |
---|---|---|
Roll |
|
Sets the command to generate values based on the roll. |
Pitch |
|
Sets the command to generate values based on the pitch. |
Yaw |
|
Sets the command to generate values based on the yaw. |
Ports#
Name |
Python Enum |
Description |
---|---|---|
Port 1 |
|
Sets the port that device is connected to on the EXP Brain to port 1. |
Port 2 |
|
Sets the port that device is connected to on the EXP Brain to port 2. |
Port 3 |
|
Sets the port that device is connected to on the EXP Brain to port 3. |
Port 4 |
|
Sets the port that device is connected to on the EXP Brain to port 4. |
Port 5 |
|
Sets the port that device is connected to on the EXP Brain to port 5. |
Port 6 |
|
Sets the port that device is connected to on the EXP Brain to port 6. |
Port 7 |
|
Sets the port that device is connected to on the EXP Brain to port 7. |
Port 8 |
|
Sets the port that device is connected to on the EXP Brain to port 8. |
Port 9 |
|
Sets the port that device is connected to on the EXP Brain to port 9. |
Port 10 |
|
Sets the port that device is connected to on the EXP Brain to port 10. |
Rotation Units#
Name |
Python Enum |
Description |
---|---|---|
Degrees |
|
Expresses the rotation value as a degree. |
Revolutions |
|
Expresses the rotation value in revolutions. |
Raw Data |
|
Expresses the rotation value as raw data. |
Signal Tower Color Types#
Name |
Python Enum |
Description |
---|---|---|
All |
|
All LED lights in the Signal Tower. |
Red |
|
The red LED light in the Signal Tower. |
Green |
|
The green LED light in the Signal Tower. |
Blue |
|
The blue LED light in the Signal Tower. |
Yellow |
|
The yellow LED light in the Signal Tower. |
White |
|
The white LED light in the Signal Tower. |
Signal Tower State Types#
Name |
Python Enum |
Description |
---|---|---|
Off |
|
The state where an LED light on the signal tower is off. |
On |
|
The state where an LED light on the signal tower is on. |
Blink |
|
The state where an LED light on the signal tower is blinking on and off. |
Sound Types#
Name |
Python Enum |
Description |
---|---|---|
Siren |
|
Sets the sound that the EXP Brain will play to siren. |
Wrong Way |
|
Sets the sound that the EXP Brain will play to wrong way. |
Wrong Way Slow |
|
Sets the sound that the EXP Brain will play to wrong way slow. |
Fillup |
|
Sets the sound that the EXP Brain will play to fillup. |
Headlights On |
|
Sets the sound that the EXP Brain will play to headlights on. |
Headlights Off |
|
Sets the sound that the EXP Brain will play to headlights off. |
Tollbooth |
|
Sets the sound that the EXP Brain will play to tollbooth. |
Alarm |
|
Sets the sound that the EXP Brain will play to alarm. |
Tada |
|
Sets the sound that the EXP Brain will play to tada. |
Door Close |
|
Sets the sound that the EXP Brain will play to door close. |
Ratchet |
|
Sets the sound that the EXP Brain will play to ratchet. |
Wrench |
|
Sets the sound that the EXP Brain will play to wrench. |
Siren 2 |
|
Sets the sound that the EXP Brain will play to siren 2. |
Ratchet 2 |
|
Sets the sound that the EXP Brain will play to ratchet 2. |
Alarm 2 |
|
Sets the sound that the EXP Brain will play to alarm 2. |
Power Down |
|
Sets the sound that the EXP Brain will play to power down. |
Temperature Units#
Name |
Python Enum |
Description |
---|---|---|
Celsius |
|
Expresses the temperature value in degrees Celsius. |
Fahrenheit |
|
Expresses the temperature value in degrees Fahrenheit. |
Three Wire Types#
Name |
Python Enum |
Description |
---|---|---|
Analog In |
|
Sets the three wire type to an analog input. |
Analog Out |
|
Sets the three wire type to an analog output. |
Digital In |
|
Sets the three wire type to a digital input. |
Digital Out |
|
Sets the three wire type to a digital output. |
Switch |
|
Sets the three wire type to a switch. |
Potentiometer |
|
Sets the three wire type to a potentiometer. |
Line Sensor |
|
Sets the three wire type to a line sensor. |
Light Sensor |
|
Sets the three wire type to a light sensor. |
Gyro |
|
Sets the three wire type to a gyro. |
Accelerometer |
|
Sets the three wire type to a accelerometer. |
Motor |
|
Sets the three wire type to a motor. |
Servo |
|
Sets the three wire type to a servo. |
Encoder |
|
Sets the three wire type to an encoder. |
Sonar |
|
Sets the three wire type to a sonar sensor. |
Slew Motor |
|
Sets the three wire type to a slew motor. |
Time Units#
Name |
Python Enum |
Description |
---|---|---|
Seconds |
|
Counts the time value in seconds. |
Milliseconds |
|
Counts the time value in milliseconds. |
Torque Units#
Name |
Python Enum |
Description |
---|---|---|
Newton Meters |
|
Expresses the torque value in newton meters. |
Inch Pounds |
|
Expresses the torque value in inch pounds. |
Turn Types#
Name |
Python Enum |
Description |
---|---|---|
Right |
|
Sets the command to turn to the right. |
Left |
|
Sets the command to turn to the left. |
Velocity Units#
Name |
Python Enum |
Description |
---|---|---|
Percentage |
|
Expresses the velocity value a percentage in the range 0 to 100. |
Degrees per Second |
|
Expresses the velocity value in degrees per second. |
Rotations per Minute |
|
Expresses the velocity value in rotations per minute. |
VEXlink Types#
Name |
Python Enum |
Description |
---|---|---|
Manager |
|
Sets the VEXlink type as a manager radio. |
Worker |
|
Sets the VEXlink type as a worker radio. |
Generic |
|
Sets the VEXlink type as a raw unmanaged radio. |
Voltage Units#
Name |
Python Enum |
Description |
---|---|---|
Millivolts |
|
Expresses the voltage value in millivolts. |
Volts |
|
Expresses the voltage value in volts. |