API Python du traqueur VICON

Caractéristiques

• Nom du produit: API Python du suivi Vicon
• Compatibilité: Traqueur 4.0
• Versions Python prises en charge : 2.7 et Python3

Instructions d'utilisation du produit

Installez l'API Tracker

Pour utiliser l'API Tracker avec Python, procédez comme suit :

1. Vérifiez la version Python pour garantir la compatibilité.
2. Installez Python en le téléchargeant depuis le site officiel website et en sélectionnant la version appropriée.
3. Localisez et installez le module Tracker Python à partir du dossier spécifié.

Vérifier la version de Python

1. Ouvrez une invite de commande.
2. Tapez « py » et appuyez sur Entrée.
3. Si Python n'est pas installé, reportez-vous aux instructions d'installation.

Installer Python

1. Aller à Officiel de Python website.
2. Téléchargez et installez Python, en veillant à ajouter python.exe à PATH lors de l'installation.

Installez le module Python Tracker :

1. Localiser l'installation files dans le dossier spécifié.
2. Choisissez la méthode d'installation en fonction de votre configuration.

Installez le module Python en exécutant le lot File:

1. Accédez au dossier d'installation de Python : C : Programme FilesViconTracker4.xSDKPython
2. Double-cliquez sur « install_tracker_api.bat » pour lancer le processus d'installation.

Foire aux questions (FAQ) :

Q : Que puis-je automatiser à l'aide de l'API Tracker ?

• A: L'API Tracker vous permet d'automatiser des fonctions courantes telles que le chargement, la lecture, l'exportation de données, l'activation/désactivation d'objets et le déclenchement de parties du flux de travail.

Q : Quelles versions de Python sont prises en charge par l'API Tracker ?

• A: L'API Tracker prend en charge les versions Python 2.7 et Python

À propos de ce guide

• L'API Tracker vous permet de contrôler certaines fonctionnalités de Tracker via une API Python.
• L'API vous permet d'automatiser certaines fonctions courantes de Tracker, telles que le chargement, la lecture et l'exportation de données, l'activation ou la désactivation de différents objets ou le déclenchement de parties du flux de travail.
• Ce document vous permet de démarrer avec l'API Tracker.

Installez l'API Tracker

• Pour utiliser l'API Tracker avec Python, vous devez vous assurer que les deux sont installés.
• L'API Tracker prend en charge Python 2.7 et Python 3. Vicon vous recommande d'utiliser la dernière version complète de Python 3, sauf si votre projet nécessite que vous utilisiez une version spécifique de Python.

Ces procédures vous guident tout au long du processus d'installation :

• Vérifiez la version Python sur
• Installer Python sur
• Installation du module Tracker Python sur
• Vérifiez que le module Python est correctement installé sur

Vérifier la version de Python

• Si vous ne savez pas si Python est installé ou quelle version de Python vous utilisez, vous pouvez ouvrir une invite de commande et exécuter la commande py.

Par exempleample:

Si Python n’est pas installé, consultez Installer Python.

Installer Python Pour installer Python 2 ou 3 :

1. Aller à  https://www.python.org/downloads/
2. Recherchez la version requise et installez Python, en vous assurant que Ajouter python.exe au PATH est sélectionné :

Dans l'image ci-dessus, ABC est remplacé par votre nom d'utilisateur pour le dossier d'installation.

Installer le module Tracker Python Pour installer le module Tracker Python :

1. Localiser l'installation files. Si vous avez installé Tracker à l'emplacement par défaut, ils se trouvent dans ce dossier : C:\Program Files\Vicon\Tracker4.x\SDK\Python
   • Ces files sont affichés :
2. Installez le module Tracker Python de l'une des manières suivantes, en fonction de votre installation particulière :
   • Le moyen le plus simple est d'exécuter le batch file (install_tracker_api.bat) inclus dans l'installation de Tracker (comme indiqué dans l'image ci-dessus).
   • Cela fonctionne généralement bien si :
   • Python a été installé sur la variable PATH ; ou
   • Plusieurs versions de Python sont installées, mais vous souhaitez installer l'API sur la dernière version que vous avez installée ; ou
   • Une seule version de Python est installée.
   • Si l'une de ces conditions s'applique, consultez Installer le module python en exécutant le batch file sur.
   • Dans tous les autres cas, installez le module Python en utilisant pip. Cela s'applique généralement si :
   • Plusieurs versions de Python sont installées, mais vous souhaitez installer une version spécifique ; ou
   • Plusieurs versions différentes de Python sont installées et vous souhaitez les installer toutes (dans ce cas, vous devez installer le module pour chaque version) ; ou
   • Une seule version de Python est installée, mais vous ne l'avez pas installée sur PATH.
   • Si l'une de ces conditions s'applique, consultez Installer le module Python en exécutant pip on.

Installez le module Python en exécutant le batch file Pour ce faire :

1. Accédez au dossier d'installation de Python : C:\Programme Files\Vicon\Tracker4.x\SDK\Python
2. Double-cliquez sur install_tracker_api.bat.
   • Le processus d'installation s'initialise automatiquement.

Installez le module Python en exécutant le pip

1. Accédez au dossier Scripts du Python que vous souhaitez utiliser :
2. Pour Python 3, le dossier d'installation par défaut est : C:\Users\ \AppData\Local\Programmes\Python\Python \Sc déchire
   • Pour Python 2.7, le dossier d'installation par défaut est : C:\Python27\Scripts
3. Ouvrez une fenêtre de commande ou PowerShell dans ce dossier.
4. Exécutez la commande suivante pour installer l'API Vicon Core : C : \Utilisateurs\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installe « C:\Program Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api »
   • Exécutez la commande suivante pour installer l'API C de Tracker : \Utilisateurs\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installe « C:\Program Files\Vicon\Tracker 4.0\SDK\Python\tracker_api »

Note L'exemple ci-dessusampLes fichiers utilisent une installation Python 3.11 avec Tracker 4.0. Votre chemin et vos commandes peuvent différer légèrement.

Vérifiez que le module Python est correctement installé

• Vérifiez que les modules suivants ont été installés.
• vicon_core_api : Il s'agit de l'API principale de contrôle à distance et comprend un client pour la communication avec le serveur de terminaux.
• tracker_api : API de services pour accéder aux fonctionnalités de l'application spécifique à Tracker.
• Pour tester que le module Tracker Python est correctement installé, essayez d'importer un des modules en Python : >>> import vicon_core_api

Si le processus ci-dessus ne parvient pas à reconnaître le module, essayez ce qui suit :

• Vérifiez le dossier site-packages dans l'installation Python pour le dossier tracker_api ou vicon_core_api. Pour Python 3.11, l'emplacement du dossier d'installation par défaut est :
  • C:\Utilisateurs\ \AppData\Local\Programs\Python\Python311\Lib\site-packages
• Vérifiez les variables d'environnement de votre système et assurez-vous que le dossier de scripts pour l'installation Python que vous souhaitez utiliser est le plus élevé de la liste. Pour Python 3.11, l'emplacement par défaut du dossier d'installation est :
  • C:\Utilisateurs\ \AppData\Local\Programmes\Python\Python311\Scripts
• Si l'un des dossiers des modules est manquant et que vous avez vérifié le chemin, réexécutez le processus d'installation décrit dans Installation du module Tracker Python sur.

Connectez-vous au serveur de terminaux

• Pour vous connecter au serveur de terminaux, importez d'abord le module API Vicon Core : >>> import vicon_core_api
  • >>> depuis l'importation vicon_core_api
• Ensuite, créez un client. Cela essaie automatiquement de se connecter à l'adresse d'hôte spécifique sur le port par défaut (52800) >>> c = Client('localhost')
• Vérifiez que le client s'est connecté avec succès au serveur : >>> print(c.connected) Vrai
• Si la réponse est False, assurez-vous qu'une instance de Tracker s'exécute sur l'adresse hôte spécifiée et que votre pare-feu ne bloque pas le trafic sur le port 52800, avant de créer un nouveau client.
• Une fois la connexion réussie, vous pouvez accéder aux services fournis par le serveur de terminaux Tracker.
• Cet example utilise des services objets de base : >>> importer tracker_api >>> depuis tracker_api importer BasicObjectServices >>> services = BasicObjectServices(c)
• Lorsqu'il est connecté, vous pouvez appeler des méthodes sur l'instance Tracker.
  • Par exempleample, pour obtenir une liste d'objets dans le panneau Tracking, utilisez : >>> result, object_list = services.basic_object_list() >>> print(result)
  • D'accord: la fonction a réussi
  • >>> imprimer (liste_objets)
  • ['Objet1', 'Objet2'…]
• Tous les appels d'API renvoient un code de résultat, décrit dans vicon_core_api/result.py.
• Un code d'échec possible est Result.RPCNotConnected, qui est reçu si la connexion au serveur de terminaux est perdue.
• Par exempleample : >>> résultat, object_list = services.basic_object_list() vicon_core_api.client.RPCError : RPCNotConnected : La connexion à la fonction distante ou au rappel n'est pas ouverte
• Pour afficher une liste de toutes les fonctions disponibles et la documentation : >>> help( tracker_api)

Examples scripts

• Vous pouvez trouver un examples scripts montrant l'utilisation des fonctions API courantes sur C:\Programme Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
• Tous les scripts ont une documentation et prennent une option –help qui donne des détails sur les arguments pertinents.
• Pour courir commeample script, ouvrez une fenêtre de commande ou Power Shell dans le dossier scripts ci-dessus. Vous pouvez le faire de deux manières :
• Ouvrez l'invite de commande et remplacez votre répertoire par le dossier scripts : c:\> cd C:\Programme Files\Vicon\Tracker
  • 4.0\SDK\Python\sample_scripts
• Maintenez MAJ + clic droit dans le dossier des scripts et sélectionnez Ouvrir la fenêtre de commande ici ou Ouvrir la fenêtre Powershell ici.
• De là, vous pouvez exécuter l'example script de votre choix.
• L'exemple suivantampNous utilisons la fenêtre de commande.

camera_calibration_wave.py

• Ce script montre comment utiliser les fonctions API pour contrôler le processus d'étalonnage de démarrage et d'arrêt de l'onde de la baguette.
  • C:\Programme Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts>py camera_calibration_wave.py
• En cas de succès, les contrôles d'étalonnage s'affichent

capture_control.py

• Ce script montre comment capturer des données en direct C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• Le nom de la capture est répertorié avant les contrôles. Pour modifier le nom de la capture, utilisez capture_services et SetCaptureName.
• Pour toute question sur l'utilisation de l'API Tracker, contactez le support Vicon1.
• 1 e-mail :support@vicon.com
• Guide de démarrage rapide de l'API Python Vicon Tracker 31 mai 2023, révision 1
• À utiliser avec Tracker 4.0
• © Copyright 2020–2023 Vicon Motion Systems Limited. Tous les droits sont réservés.
• Révision 1. À utiliser avec Tracker 4.0
• Vicon Motion Systems Limited se réserve le droit d'apporter des modifications aux informations ou spécifications contenues dans ce document sans préavis.
• Entreprises, noms et données utilisés dans exampLes fichiers sont fictifs sauf indication contraire. Aucune partie de cette publication ne peut être reproduite, stockée dans un système de récupération ou transmise sous quelque forme ou par quelque moyen que ce soit, électronique ou mécanique, par photocopie ou enregistrement, ou autrement sans l'autorisation écrite préalable de Vicon Motion Systems Ltd.
• Vicon® est une marque déposée d'Oxford Metrics plc. Vicon Control™, Vicon Lock™, Vicon Lock Lab™, Vicon Lock Studio™, Vicon Tracker™, Vicon Valkyrie™, Vicon Vantage™, Vicon Vero™, Vicon Viper™, Vicon ViperX™ et Vicon Vue™ sont des marques commerciales d'Oxford Metrics plc.
• VESA® est une marque déposée appartenant à VESA (www.vesa.org/about-vesa/). Les autres noms de produits et de sociétés cités dans le présent document peuvent être des marques déposées de leurs propriétaires respectifs.
• Pour obtenir des reconnaissances complètes et à jour des droits d'auteur et des marques, visitez https://www.vicon.com/vicon/copyright-information.
• Vicon Motion Systems est une société d'Oxford Metrics plc.
• E-mail: support@vicon.com Web: http://www.vicon.com

Documents / Ressources

API Python de suivi VICON [pdf] Guide de l'utilisateur API Python de suivi, Tracker, API Python, API

Références

• Manuel d'utilisation