Python#

La documentation de référence de l’API Python VEX CTE explique le rôle de chaque commande, méthode et fonction, les entrées qu’elle utilise, les valeurs qu’elle renvoie et comment elle peut être utilisée dans un projet.

Utilisez cette référence lorsque vous souhaitez comprendre une commande avant de l’ajouter à un projet, vérifier les valeurs qu’elle accepte ou renvoie, ou comparer des commandes apparentées dans une même catégorie.

Les commandes Python sont utilisées dans les projets Python de VEXcode. Les projets Blocks utilisent quant à eux la section API Blocks.

Comment lire une entrée de méthode#

La plupart des entrées Python comprennent les parties suivantes :

Nom de la commande - Le nom officiel de la commande, de la méthode ou de la fonction.
Description - Explique le rôle de la commande et son utilité dans certains cas.
Utilisation - Affiche la syntaxe utilisée pour écrire la commande en code.
Paramètres - Liste les entrées acceptées par la commande et explique le rôle de chacune.
Valeur de retour - Explique ce que la commande renvoie, si elle renvoie une valeur.
Exemple de code - Illustre une façon d’utiliser la commande dans un projet.

Éléments communs de l’API Python#

Élément	Ce que cela signifie
Méthode	Une commande appelée sur un objet tel que `arm.move_inc(…)`.
Fonction	Une commande appelée directement, telle que `wait(…)` ou `print(…)`.
Paramètre	Une valeur passée à une méthode ou une fonction pour contrôler son comportement.
Paramètre optionnel	Un paramètre qui peut être omis afin que le comportement par défaut soit utilisé.
Valeur de retour	Une valeur renvoyée par une commande, telle qu’un nombre, du texte ou une valeur booléenne.

Vocabulaire Python de base#

Terme	Ce que cela signifie
Variable	Un nom qui stocke une valeur, comme `x_target = 120`.
Chaîne	Texte entre guillemets, comme `“Hello”`.
Entier	Un nombre positif ou négatif, tel que `90`.
Flotter	Un nombre décimal, tel que `25.5`.
Booléen	Une valeur qui est soit `True` ou `False`.
Argument	Une valeur passée à un appel de méthode ou de fonction, telle que `100` dans `arm.move_inc(0, 100, 0)`.

Exemple de saisie de méthode#

déplacer_inc#

move_inc déplace le bras à 6 axes d’une distance spécifiée le long des axes x, y et z.

Cette méthode renverra une valeur booléenne indiquant si le bras à 6 axes a atteint la position demandée :

True - Le bras à 6 axes a atteint la position demandée.
False - Le bras à 6 axes ne peut pas atteindre la position demandée.

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

Paramètre	Description
x	Distance à parcourir le long de l’axe x en millimètres.
y	Distance à parcourir le long de l’axe y en millimètres.
z	Distance à parcourir le long de l’axe z en millimètres.
`wait`	Optionnel. `wait=True` (par défaut) - Le projet attend que `move_inc` soit terminé avant d’exécuter la ligne de code suivante. `wait=False` - Le projet démarre l’action et passe immédiatement à la ligne de code suivante, sans attendre que `move_inc` soit terminé.

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