Python

The VEX AIR 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 AIR Python projects. Blocks projects use the Blocks API section 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 drone.take_off(…).
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 height = 500.
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 500 in drone.take_off(climb_to=500).

Example Method Entry

take_off

take_off starts the propellers and lifts the drone into the air. This method must be used before other movements can be made.

Usage:

drone.take_off(climb_to, units, wait)

Parameters	Description
climb_to	The z position the drone will fly to.
units	The unit to use: CM - Centimeters MM - Millimeters INCHES
wait	Optional. wait=True (default) - The drone waits until take_off is complete before executing the next line of code. wait=False - The drone starts the action and moves on to the next line of code right away, without waiting for take_off to finish.

# Fly for 1 second
drone.take_off(climb_to=500)
wait(1, SECONDS)
drone.land()