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

A command called on an object such as arm.move_inc(…).

Función

A command called directly, such as wait(…) or 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

A name that stores a value, such as x_target = 120.

Cadena

Text inside quotes, such as “Hello”.

Entero

A positive or negative number, such as 90.

Flotar

A number with a decimal, such as 25.5.

Booleano

A value that is either True or False.

Argumento

A value passed into a method or function call, such as 100 in arm.move_inc(0, 100, 0).

Ejemplo de entrada de método#

move_inc#

move_inc moves the 6-Axis Arm by a specified distance along the x, y, and z axes.

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

  • True - The 6-Axis Arm has reached the requested position.

  • False - The 6-Axis Arm cannot reach the requested position.

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

Optional.

  • wait=True (default) - The project waits until move_inc is complete before executing the next line of code.
  • wait=False - The project starts the action and moves on to the next line of code right away, without waiting for move_inc to finish.

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