Python#

La referencia de la API de Python de VEX CTE explica qué hace cada comando, método y función, qué entradas utiliza, qué devuelve y cómo se puede utilizar en un proyecto.

Utilice esta referencia cuando desee comprender un comando antes de agregarlo a un proyecto, comprobar qué valores acepta o devuelve, o comparar comandos relacionados en una categoría.

Los comandos de Python se utilizan en los proyectos de VEXcode Python. Los proyectos de Blocks utilizan la sección de la API de Blocks.

Cómo leer una entrada de método#

La mayoría de las entradas de Python incluyen las siguientes partes:

  • Nombre del comando - El nombre oficial del comando, método o función.

  • Descripción - Explica qué hace el comando y cuándo es útil.

  • Uso - Muestra la sintaxis utilizada para escribir el comando en código.

  • Parámetros - Enumera las entradas que acepta el comando y explica qué hace cada una.

  • Valor de retorno - Explica qué valor devuelve el comando, si es que devuelve alguno.

  • Código de ejemplo - Muestra una forma en que se puede utilizar el comando en un proyecto.

Elementos comunes de la API de Python#

Elemento

Qué significa

Método

Un comando llamado sobre un objeto como arm.move_inc(…).

Función

Un comando llamado directamente, como wait(…) o print(…).

Parámetro

Un valor que se pasa a un método o función para controlar lo que hace.

Parámetro opcional

Un parámetro que se puede omitir para que se utilice el comportamiento predeterminado.

Valor de retorno

Un valor que devuelve un comando, como un número, un texto o un valor booleano.

Vocabulario básico de Python#

Término

Qué significa

Variable

Un nombre que almacena un valor, como por ejemplo x_target = 120.

Cadena

Texto entre comillas, como por ejemplo “Hello”.

Entero

Un número positivo o negativo, como 90.

Flotar

Un número con decimales, como 25.5.

Booleano

Un valor que es True o False.

Argumento

Un valor pasado a una llamada a un método o función, como 100 en arm.move_inc(0, 100, 0).

Ejemplo de entrada de método#

move_inc#

move_inc mueve el brazo de 6 ejes una distancia especificada a lo largo de los ejes x, y y z.

Este método devolverá un valor booleano que indicará si el brazo de 6 ejes ha alcanzado la posición solicitada:

  • True - El brazo de 6 ejes ha alcanzado la posición solicitada.

  • False - El brazo de 6 ejes no puede alcanzar la posición solicitada.

Usage:
arm.move_inc(x, y, z, wait)

Parámetro

Descripción

incógnita

La distancia a recorrer a lo largo del eje x en milímetros.

y

La distancia a recorrer a lo largo del eje y en milímetros.

z

La distancia a recorrer a lo largo del eje z en milímetros.

wait

Opcional.

  • wait=True (predeterminado) - El proyecto espera hasta que move_inc se complete antes de ejecutar la siguiente línea de código.
  • wait=False - El proyecto inicia la acción y pasa a la siguiente línea de código inmediatamente, sin esperar a que move_inc termine.

# Move the Arm +100 millimeters on the y-axis
arm.move_inc(0, 100, 0)