Referencia API VEX AIM

Bienvenido a la Referencia de API de VEX AIM. Este sitio explica los comandos Blocks y Python disponibles para el robot de codificación VEX AIM.

Utilice esta referencia para saber qué hace un comando, qué información necesita, qué informa o devuelve y cómo se puede utilizar en un proyecto.

Esta información de la API se aplica cuando se utiliza:

• VEXcode AIM de VEX ROBOTICS

• Visual Studio Code de Microsoft con la VEX Visual Studio Code Extension

• Integración de WebSocket a través del VEX AIM Websocket Python Client

  • Consulte las páginas de WebSocket para la configuración y el uso.

Secciones de la API

• Bloques: conoce los bloques disponibles en VEXcode AIM, incluyendo lo que hace cada bloque, lo que significan sus entradas y cómo se pueden usar en un proyecto.

• Python: conoce los métodos, funciones, parámetros, valores de retorno y ejemplos de Python utilizados con el robot de codificación VEX AIM. La información de la API de Python también puede admitir proyectos escritos en Visual Studio Code con la extensión VEX Visual Studio Code.

• WebSocket: aprende a conectarte y controlar un robot de codificación VEX AIM utilizando el cliente WebSocket Python.

• Tutoriales de VEXcode: encuentra tutoriales y recursos de apoyo para aprender a usar VEXcode AIM.

Cómo usar esta referencia

1. Elija la sección para el idioma de codificación o el recurso que está utilizando.

2. Usa la barra lateral o la barra de búsqueda para encontrar un dispositivo, una categoría, un bloque, un comando, un método o una clase.

3. Lea la descripción para comprender qué hace el comando y cuándo es útil.

4. Compruebe los parámetros para ver qué entradas se necesitan y qué opciones están disponibles.

5. Revise el ejemplo para ver una forma en que el comando se puede usar en un proyecto.

Para ver ejemplos de texto en Python, seleccione el botón Copiar para copiar el ejemplo y, a continuación, péguelo en su entorno de programación.

Navegación por la página

Este sitio incluye varias herramientas de navegación:

• Barra lateral de navegación: usa la barra lateral izquierda para moverte entre secciones, dispositivos, categorías y páginas de la API.

• Navegación de la plataforma: utiliza la navegación de la plataforma para cambiar a las referencias de la API para otras plataformas de VEX.

• Navegación por la página: utiliza la navegación por la página del lado derecho para ir a las secciones de la página actual.

Consejos para usar la API

• Comience con el dispositivo o la categoría con la que está trabajando, como Motion, AI Vision, Screen, Controller o Logic.

• Lea la descripción antes de copiar un ejemplo para que entienda lo que el comando está destinado a hacer.

• Compruebe cuidadosamente las tablas de parámetros. Los pequeños cambios en las entradas pueden cambiar el comportamiento del robot.

• Usa ejemplos como punto de partida, luego cambia los valores, las direcciones, los nombres o las opciones para que coincidan con tu propio proyecto.