Python

La documentation de référence de l’API Python de VEX AIR 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 AIR. 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 drone.take_off(…).
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 height = 500.
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 500 dans drone.take_off(climb_to=500).

Exemple de saisie de méthode

décoller

take_off : les hélices se mettent en marche et le drone décolle. Cette méthode doit être utilisée avant tout autre mouvement.

Usage:

drone.take_off(climb_to, units, wait)

Paramètres	Description
climb_to	La position Z vers laquelle le drone volera.
units	Unités de mesure : CM  - Centimètres MM  - Millimètres INCHES
wait	Optional. wait=True (default) - The drone waits until take_off is complete before executing the next line of code. wait=False - The drone starts the action and moves on to the next line of code right away, without waiting for take_off to finish.

# Fly for 1 second
drone.take_off(climb_to=500)
wait(1, SECONDS)
drone.land()