Enums

Analog Units

Name	Python Enum	Description
Percent	AnalogUnits.PCT	Expresses the value as a percentage ranging from 0 - 100.
Eightbit	AnalogUnits.EIGHTBIT	Encodes the value as an 8-bit integer from 0 - 255.
Tenbit	AnalogUnits.TENBIT	Encodes the value as a 10-bit integer from 0 - 1023.
Twelvebit	AnalogUnits.TWELVEBIT	Encodes the value as a 12-bit integer from 0 - 4095.
Millivolts	AnalogUnits.MV	Measures the value of the analog input in millivolts.

Axis Types

Name	Python Enum	Description
X-Axis	XAXIS or AxisType.XAXIS	Sets the command to generate values based on the X-Axis.
Y-Axis	YAXIS or AxisType.YAXIS	Sets the command to generate values based on the Y-Axis.
Z-Axis	ZAXIS or AxisType.ZAXIS	Sets the command to generate values based on the Z-Axis.

Brake Types

Name	Python Enum	Description
Coast	COAST or BrakeType.COAST	The COAST mode allows the motor to gradually come to a stop.
Brake	BRAKE or BrakeType.BRAKE	The BRAKE mode stops the motor immediately.
Hold	HOLD or BrakeType.HOLD	The HOLD mode stops the robot immediately and holds the motor in the stopped position.

Color Types

Name	Python Enum	Description
Red	RED	The predefined color constant for red as the RGB value: (255, 0, 0).
Green	GREEN	The predefined color constant for green as the RGB value: (0, 255, 0).
Blue	BLUE	The predefined color constant for blue as the RGB value: (0, 0, 255).
Yellow	YELLOW	The predefined color constant for yellow as the RGB value: (255, 255, 0).
Orange	ORANGE	The predefined color constant for orange as the RGB value: (255, 165, 0).
Purple	PURPLE	The predefined color constant for purple as the RGB value: (255, 0, 255).
Cyan	CYAN	The predefined color constant for cyan as the RGB value: (0, 255, 255).
Black	BLACK	The predefined color constant for black as the RGB value: (0, 0, 0).
White	WHITE	The predefined color constant for white as the RGB value: (255, 255, 255).

Controller Types

Name	Python Enum	Description
Primary	PRIMARY or ControllerType.PRIMARY	Sets a V5 controller as the primary controller when initializing a controller.
Partner	PARTNER or ControllerType.PARTNER	Sets a V5 controller as the partner controller when initializing a controller.

Direction Types

Name	Python Enum	Description
Forward	FORWARD or DirectionType.FORWARD	Sets the direction for a motor or drivetrain to move to forward.
Reverse	REVERSE or DirectionType.REVERSE	Sets the direction for a motor or drivetrain to move to reverse.

Distance Units

Name	Python Enum	Description
Millimeters	MM or DistanceUnits.MM	Measures the value of the distance in millimeters.
Inches	INCHES or DistanceUnits.IN	Measures the value of the distance in inches.

Font Types

Name	Python Enum	Description
Mono 12	MONO12	The predefined monotype font of size 12.
Mono 15	MONO15	The predefined monotype font of size 15.
Mono 20	MONO20	The predefined monotype font of size 20.
Mono 30	MONO30	The predefined monotype font of size 30.
Mono 40	MONO40	The predefined monotype font of size 40.
Mono 60	MONO60	The predefined monotype font of size 60.
Proportional 20	PROP20	The predefined proportional font of size 20.
Proportional 30	PROP30	The predefined proportional font of size 30.
Proportional 40	PROP40	The predefined proportional font of size 40.
Proportional 60	PROP60	The predefined proportional font of size 60.
CJK 16	CJK16	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	RATIO_36_1	The constant to represent a 36:1 gear ratio. A red gearbox for a V5 SmartMotor.
Ratio 18:1	RATIO_18_1	The constant to represent a 18:1 gear ratio. A green gearbox for a V5 SmartMotor.
Ratio 6:1	RATIO_6_1	The constant to represent a 6:1 gear ratio. A blue gearbox for a V5 SmartMotor.

LED State Types

Name	Python Enum	Description
On	LedStateType.ON	Sets the command to turn on the optical sensor’s LED.
Off	LedStateType.OFF	Sets the command to turn off the optical sensor’s LED.
Blink	LedStateType.BLINK	This command sets the optical sensor’s LED to blink on and off repeatedly.

Object Size Types

Name	Python Enum	Description
Small	ObjectSizeType.SMALL	Represents a small object size detected by the distance sensor.
Medium	ObjectSizeType.MEDIUM	Represents a medium object size detected by the distance sensor.
Large	ObjectSizeType.LARGE	Represents a large object size detected by the distance sensor.
None	ObjectSizeType.NONE	Represents when no object is detected by the distance sensor.

Orientation Types

Name	Python Enum	Description
Roll	ROLL or OrientationType.ROLL	Sets the command to generate values based on the roll.
Pitch	PITCH or OrientationType.PITCH	Sets the command to generate values based on the pitch.
Yaw	YAW or OrientationType.YAW	Sets the command to generate values based on the yaw.

Ports

Name	Python Enum	Description
Port 1	PORT1	Sets the port that device is connected to on the V5 Brain to port 1.
Port 2	PORT2	Sets the port that device is connected to on the V5 Brain to port 2.
Port 3	PORT3	Sets the port that device is connected to on the V5 Brain to port 3.
Port 4	PORT4	Sets the port that device is connected to on the V5 Brain to port 4.
Port 5	PORT5	Sets the port that device is connected to on the V5 Brain to port 5.
Port 6	PORT6	Sets the port that device is connected to on the V5 Brain to port 6.
Port 7	PORT7	Sets the port that device is connected to on the V5 Brain to port 7.
Port 8	PORT8	Sets the port that device is connected to on the V5 Brain to port 8.
Port 9	PORT9	Sets the port that device is connected to on the V5 Brain to port 9.
Port 10	PORT10	Sets the port that device is connected to on the V5 Brain to port 10.
Port 11	PORT11	Sets the port that device is connected to on the V5 Brain to port 11.
Port 12	PORT12	Sets the port that device is connected to on the V5 Brain to port 12.
Port 13	PORT13	Sets the port that device is connected to on the V5 Brain to port 13.
Port 14	PORT14	Sets the port that device is connected to on the V5 Brain to port 14.
Port 15	PORT15	Sets the port that device is connected to on the V5 Brain to port 15.
Port 16	PORT16	Sets the port that device is connected to on the V5 Brain to port 16.
Port 17	PORT17	Sets the port that device is connected to on the V5 Brain to port 17.
Port 18	PORT18	Sets the port that device is connected to on the V5 Brain to port 18.
Port 19	PORT19	Sets the port that device is connected to on the V5 Brain to port 19.
Port 20	PORT20	Sets the port that device is connected to on the V5 Brain to port 20.
Port 21	PORT21	Sets the port that device is connected to on the V5 Brain to port 21.

Rotation Units

Name	Python Enum	Description
Degrees	DEGREES or RotationUnits.DEG	Expresses the rotation value as a degree.
Revolutions	TURNS or RotationUnits.REV	Expresses the rotation value in revolutions.
Raw Data	RotationUnits.RAW	Expresses the rotation value as raw data.

Temperature Units

Name	Python Enum	Description
Celsius	TemperatureUnits.CELSIUS	Expresses the temperature value in degrees Celsius.
Fahrenheit	TemperatureUnits.FAHRENHEIT	Expresses the temperature value in degrees Fahrenheit.

Three Wire Types

Name	Python Enum	Description
Analog In	ThreeWireType.ANALOG_IN	Sets the three wire type to an analog input.
Analog Out	ThreeWireType.ANALOG_OUT	Sets the three wire type to an analog output.
Digital In	ThreeWireType.DIGITAL_IN	Sets the three wire type to a digital input.
Digital Out	ThreeWireType.DIGITAL_OUT	Sets the three wire type to a digital output.
Switch	ThreeWireType.SWITCH	Sets the three wire type to a switch.
Potentiometer	ThreeWireType.POTENTIOMETER	Sets the three wire type to a potentiometer.
Line Sensor	ThreeWireType.LINE_SENSOR	Sets the three wire type to a line sensor.
Light Sensor	ThreeWireType.LIGHT_SENSOR	Sets the three wire type to a light sensor.
Gyro	ThreeWireType.GYRO	Sets the three wire type to a gyro.
Accelerometer	ThreeWireType.ACCELEROMETER	Sets the three wire type to a accelerometer.
Motor	ThreeWireType.MOTOR	Sets the three wire type to a motor.
Servo	ThreeWireType.SERVO	Sets the three wire type to a servo.
Encoder	ThreeWireType.ENCODER	Sets the three wire type to an encoder.
Sonar	ThreeWireType.SONAR	Sets the three wire type to a sonar sensor.
Slew Motor	ThreeWireType.SLEW_MOTOR	Sets the three wire type to a slew motor.

Time Units

Name	Python Enum	Description
Seconds	SECONDS or TimeUnits.SECONDS	Counts the time value in seconds.
Milliseconds	MSEC or TimeUnits.MSEC	Counts the time value in milliseconds.

Torque Units

Name	Python Enum	Description
Newton Meters	TorqueUnits.NM	Expresses the torque value in newton meters.
Inch Pounds	TorqueUnits.INLB	Expresses the torque value in inch pounds.

Turn Types

Name	Python Enum	Description
Right	RIGHT or TurnType.RIGHT	Sets the command to turn to the right.
Left	LEFT or TurnType.LEFT	Sets the command to turn to the left.

Velocity Units

Name	Python Enum	Description
Percentage	VelocityUnits.PCT	Expresses the velocity value a percentage in the range 0 to 100.
Degrees per Second	DPS or VelocityUnits.DPS	Expresses the velocity value in degrees per second.
Rotations per Minute	RPM or VelocityUnits.RPM	Expresses the velocity value in rotations per minute.

VEXlink Types

Name	Python Enum	Description
Manager	VexlinkType.MANAGER	Sets the VEXlink type as a manager radio.
Worker	VexlinkType.WORKER	Sets the VEXlink type as a worker radio.
Generic	VexlinkType.GENERIC	Sets the VEXlink type as a raw unmanaged radio.

Voltage Units

Name	Python Enum	Description
Millivolts	MV or VoltageUnits.MV	Expresses the voltage value in millivolts.
Volts	VOLT or VoltageUnits.VOLT	Expresses the voltage value in volts.