Python#

The VEX V5 Python API Reference explains what each command, method, and function does, what inputs it uses, what it returns, and how it can be used in a project.

Use this reference when you want to understand a command before adding it to a project, check what values it accepts or returns, or compare related commands in a category.

Python commands are used in VEXcode V5 Python projects. Blocks and C++ projects use the other API sections instead.

How to Read a Method Entry#

Most Python entries include the following parts:

Command name - The official name of the command, method, or function.
Description - Explains what the command does and when it is useful.
Usage - Shows the syntax used to write the command in code.
Parameters - Lists the inputs the command accepts and explains what each one does.
Return value - Explains what the command reports back, if it returns a value.
Example code - Shows one way the command can be used in a project.

Common Python API Elements#

Element	What it means
Method	A command called on an object such as `drivetrain.drive(…)`.
Function	A command called directly, such as `wait(…)` or `print(…)`.
Parameter	A value passed into a method or function to control what it does.
Optional parameter	A parameter that can be left out so the default behavior is used.
Return value	A value a command reports back, such as a number, text, or Boolean.

Basic Python Vocabulary#

Term	What it means
Variable	A name that stores a value, such as `speed = 50`.
String	Text inside quotes, such as `“Hello”`.
Integer	A positive or negative number, such as `90`.
Float	A number with a decimal, such as `25.5`.
Boolean	A value that is either `True` or `False`.
Argument	A value passed into a method or function call, such as `360.0` in `drivetrain.drive(FORWARD, 360.0, VelocityUnits.DPS)`.

Example Method Entry#

drive#

drive moves the robot forward or reverse forever. The robot will continue to move until it is given another action, like turning or stopping. For RPM or degrees per second, the limit is changed by the gear ratio of the drivetrain.

Usage:
drivetrain.drive(direction, velocity, units)

Parameters	Description
`direction`	The direction the robot moves: `FORWARD` or `REVERSE`.
`velocity`	Optional. The velocity to drive with from 0% to 100% when using `PERCENT`, from 0 to 600 rpm when using `RPM`, or from 0 to 3600 degrees per second when using `VelocityUnits.DPS`. This can be an `integer` or decimal (`float`). If no velocity is provided, the robot drives at the current drive velocity.
`units`	Optional. The velocity unit: `RPM` (rotations per minute, default), `PERCENT`, or `VelocityUnits.DPS` (degrees per second).

# Drive forward, then stop
drivetrain.drive(FORWARD)
wait(2, SECONDS)
drivetrain.stop()

# Drive forward at 360 degrees per second
drivetrain.drive(FORWARD, 360.0, VelocityUnits.DPS)