Python#

A Referência da API Python do VEX CTE explica o que cada comando, método e função faz, que entradas utiliza, o que retorna e como pode ser utilizado num projeto.

Utilize esta referência quando pretende compreender um comando antes de o adicionar a um projeto, verificar que valores aceita ou devolve, ou comparar comandos relacionados numa categoria.

Os comandos Python são utilizados em projetos Python do VEXcode. Os projetos em blocos utilizam a secção API de Blocos.

Como ler uma entrada de método#

A maioria das entradas em Python inclui as seguintes partes:

Nome do comando - O nome oficial do comando, método ou função.
Descrição - Explica o que o comando faz e quando é útil.
Utilização - Mostra a sintaxe utilizada para escrever o comando no código.
Parâmetros - Lista as entradas que o comando aceita e explica o que cada uma faz.
Valor de retorno - Explica o que o comando retorna, caso devolva algum valor.
Código de exemplo - Mostra uma forma de utilizar o comando num projeto.

Elementos comuns da API do Python#

Elemento	O que significa
Método	Um comando chamado num objeto como `arm.move_inc(…)`.
Função	Um comando chamado directamente, como por exemplo `wait(…)` ou `print(…)`.
Parâmetro	Um valor passado para um método ou função para controlar o que faz.
Parâmetro opcional	Um parâmetro que pode ser omitido para que seja utilizado o comportamento padrão.
Valor de retorno	Um valor devolvido por um comando, como um número, texto ou valor booleano.

Vocabulário básico de Python#

Termo	O que significa
Variável	Um nome que armazena um valor, como por exemplo `x_target = 120`.
Fio	Texto entre aspas, como `“Hello”`.
Número inteiro	Um número positivo ou negativo, como por exemplo `90`.
Flutuar	Um número com decimais, como `25.5`.
Booleano	Um valor que pode ser `True` ou `False`.
Discussão	Um valor passado para uma chamada de método ou função, como por exemplo `100` em `arm.move_inc(0, 100, 0)`.

Exemplo de entrada de método#

mover_inc#

move_inc move o braço de 6 eixos por uma distância especificada ao longo dos eixos x, y e z.

Este método irá devolver um valor booleano indicando se o braço de 6 eixos atingiu a posição solicitada:

True - O braço de 6 eixos atingiu a posição solicitada.
False - O braço de 6 eixos não consegue atingir a posição solicitada.

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

Parâmetro	Descrição
x	A distância a percorrer ao longo do eixo x, em milímetros.
y	A distância a percorrer ao longo do eixo dos y, em milímetros.
z	A distância a percorrer ao longo do eixo z, em milímetros.
`wait`	Opcional. `wait=True` (default) - O projeto espera até que `move_inc` esteja concluído antes de executar a próxima linha de código. `wait=False` - O projeto inicia a ação e passa para a linha de código seguinte imediatamente, sem esperar que `move_inc` termine.

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