Référence de l’API VEX CTE#

Bienvenue dans la documentation de référence de l’API VEX CTE. Ce site explique les blocs et les commandes Python disponibles dans VEXcode.

Utilisez ce guide pour découvrir le rôle d’une commande, les informations dont elle a besoin, ce qu’elle affiche ou renvoie, et comment elle peut être utilisée dans un projet.

Ces informations sur l’API s’appliquent lors de l’utilisation de :

Sections API#

  • Blocs - Découvrez les blocs disponibles dans VEXcode, notamment leur fonction, la signification de leurs entrées et comment les utiliser dans un projet.

  • Python - Découvrez les méthodes, fonctions, paramètres, valeurs de retour et exemples Python utilisés dans VEXcode. Les informations sur l’API Python peuvent également être utiles pour les projets écrits dans Visual Studio Code avec l’extension VEX pour Visual Studio Code.

  • Tutoriels VEXcode - Trouvez des tutoriels et des ressources d’aide pour apprendre à utiliser VEXcode.

Comment utiliser cette référence#

  1. Choisissez la section correspondant au langage de programmation ou à la ressource que vous utilisez.

  2. Utilisez la barre latérale ou la barre de recherche pour trouver un périphérique, une catégorie, un bloc, une commande, une méthode ou une classe.

  3. Lisez la description pour comprendre le rôle de la commande et son utilité.

  4. Vérifiez les paramètres pour voir quelles entrées sont nécessaires et quelles options sont disponibles.

  5. Consultez l’exemple pour voir comment cette commande peut être utilisée dans un projet.

Pour les exemples textuels en Python, sélectionnez le bouton Copier pour copier l’exemple, puis collez-le dans votre environnement de programmation.

Conseils pour l’utilisation de l’API#

  • Commencez par l’appareil ou la catégorie avec laquelle vous travaillez, comme Arm, Signal Tower, Console ou Logic.

  • Lisez la description avant de copier un exemple afin de comprendre le rôle de la commande.

  • Vérifiez attentivement les tableaux de paramètres. De petites modifications des entrées peuvent modifier le comportement du bras à 6 axes.

  • Utilisez les exemples comme point de départ, puis modifiez les valeurs, les positions, les unités ou les noms pour les adapter à votre propre projet.