VEX AIM API Reference

Welcome to the VEX AIM API Reference. This site explains the Blocks and Python commands available for the VEX AIM Coding Robot.

Use this reference to learn what a command does, what information it needs, what it reports or returns, and how it can be used in a project.

This API information applies when using:

• VEXcode AIM by VEX Robotics

• Visual Studio Code by Microsoft with the VEX Visual Studio Code Extension

• WebSocket integration through the VEX AIM Websocket Python Client

  • See the WebSocket pages for setup and usage.

API Sections

• Blocks - Learn about the blocks available in VEXcode AIM, including what each block does, what its inputs mean, and how it can be used in a project.

• Python - Learn about the Python methods, functions, parameters, return values, and examples used with the VEX AIM Coding Robot. Python API information can also support projects written in Visual Studio Code with the VEX Visual Studio Code Extension.

• WebSocket - Learn how to connect to and control a VEX AIM Coding Robot using the WebSocket Python client.

• VEXcode Tutorials - Find tutorials and supporting resources for learning how to use VEXcode AIM.

How to Use This Reference

1. Choose the section for the coding language or resource you are using.

2. Use the sidebar or search bar to find a device, category, block, command, method, or class.

3. Read the description to understand what the command does and when it is useful.

4. Check the parameters to see what inputs are needed and what options are available.

5. Review the example to see one way the command can be used in a project.

For text-based examples in Python, select the Copy button to copy the example, then paste it into your coding environment.

Page Navigation

This site includes several navigation tools:

• Sidebar navigation - Use the left sidebar to move between API sections, devices, categories, and pages.

• Platform navigation - Use the platform navigation to switch to API references for other VEX platforms.

• Page navigation - Use the right-side page navigation to jump to sections on the current page.

Tips for Using the API

• Start with the device or category you are working with, such as Motion, AI Vision, Screen, Controller, or Logic.

• Read the description before copying an example so you understand what the command is meant to do.

• Check parameter tables carefully. Small changes to inputs can change how the robot behaves.

• Use examples as a starting point, then change values, directions, names, or options to match your own project.