Python#

This guide provides detailed information on how to use the Python commands in VEXcode VR. Here, you will learn how to read and understand each command, with comprehensive descriptions, parameters, and usage examples.

Understanding the Command Entries#

Each command entry in the API Reference includes the following components:

  • Command Name and Signature: This is the name of the command and its parameters.

  • Description: A brief explanation of what the command does.

  • Blocking/Non-Blocking: Indicates whether the command waits for completion before moving to the next command.

  • Parameters Table: Lists and describes the parameters that the command accepts.

  • Returns: Describes what the command returns, if applicable.

  • Example: Provides a sample code snippet demonstrating how to use the command.

Example Command Entry#

drivetrain.rotation()#

The drivetrain.rotation(units) command returns the Drivetrain’s angle of rotation. The numerical value (the DEGREES) will increase when rotating clockwise and decrease when rotating counter-clockwise.

This is a non-blocking command and allows any subsequent commands to execute without delay.

Parameters

Description

units

The unit of the returned value, DEGREES.

Returns: This returns a numerical value.

def main():
    # Turn to the right for 400 degrees.
    drivetrain.turn_for(RIGHT, 400, DEGREES)
    # Print the VR Robot's current angle of rotation.
    brain.print(drivetrain.rotation(DEGREES))

Commands in Subsections#

Some commands are found in specific subsections that pertain to their particular sensor or functionality. For example, commands related to Timers, Bumper Sensors, Optical Sensors, or etc. will be grouped accordingly. Refer to these subsections for detailed information on those commands.