Uživatelská příručka VICON Tracker Python Api

VICON Tracker Python API

Specifikace

• Název produktu: Vicon Tracker Python API
• Kompatibilita: Tracker 4.0
• Podporované verze Pythonu: 2.7 a Python 3

Návod k použití produktu

Nainstalujte Tracker API

Chcete-li použít Tracker API s Pythonem, postupujte takto:

1. Zkontrolujte verzi Pythonu, abyste zajistili kompatibilitu.
2. Nainstalujte Python stažením z oficiálního webu webwebu a výběrem vhodné verze.
3. Vyhledejte a nainstalujte modul Tracker Python ze zadané složky.

Zkontrolujte verzi Pythonu

1. Otevřete příkazový řádek.
2. Napište „py“ a stiskněte Enter.
3. Pokud Python není nainstalován, přečtěte si pokyny k instalaci.

Nainstalujte Python

1. Přejít na Oficiální Python webmísto.
2. Stáhněte a nainstalujte Python a ujistěte se, že během instalace přidáte python.exe do PATH.

Nainstalujte modul Tracker Python:

1. Vyhledejte instalaci files v zadané složce.
2. Vyberte způsob instalace na základě vašeho nastavení.

Nainstalujte modul Python spuštěním dávky File:

1. Přejděte do instalační složky Pythonu: C: Program FilesViconTracker4.xSDKPython
2. Poklepáním na 'install_tracker_api.bat' zahájíte proces instalace.

Často kladené otázky (FAQ):

Otázka: Co mohu automatizovat pomocí Tracker API?

• A: Tracker API vám umožňuje automatizovat běžné funkce, jako je načítání, přehrávání, export dat, aktivace/deaktivace objektů a spouštění částí pracovního postupu.

Otázka: Které verze Pythonu jsou podporovány rozhraním Tracker API?

• A: Tracker API podporuje Python verze 2.7 a Python

O tomto průvodci

• Tracker API vám umožňuje ovládat určité funkce Trackeru prostřednictvím Python API.
• Rozhraní API vám umožňuje automatizovat některé běžné funkce Trackeru, jako je načítání, přehrávání a export dat, aktivace nebo deaktivace různých objektů nebo spouštění částí pracovního postupu.
• Tento dokument vám umožňuje začít s rozhraním Tracker API.

Nainstalujte Tracker API

• Chcete-li používat Tracker API s Pythonem, musíte se ujistit, že máte nainstalované obě.
• Tracker API poskytuje podporu pro Python 2.7 a Python 3. Vicon doporučuje, abyste používali nejnovější plnou verzi Pythonu 3, pokud váš projekt nevyžaduje použití konkrétní verze Pythonu.

Tyto postupy vás provedou procesem instalace:

• Zkontrolujte verzi Pythonu
• Instalace Pythonu na
• Instalace modulu Tracker Python na
• Zkontrolujte, zda je modul Python správně nainstalován

Zkontrolujte verzi Pythonu

• Pokud si nejste jisti, zda máte nainstalovaný Python nebo jakou verzi Pythonu používáte, můžete otevřít příkazový řádek a spustit příkaz py.

Napřampten:

Pokud nemáte nainstalovaný Python, přečtěte si téma Instalace Pythonu.

Nainstalujte Python Chcete-li nainstalovat Python 2 nebo 3:

1. Přejít na  https://www.python.org/downloads/
2. Najděte požadovanou verzi a nainstalujte Python a ujistěte se, že je vybrána možnost Přidat python.exe do PATH:

Na obrázku výše je ABC nahrazeno vaším uživatelským jménem pro instalační složku.

Instalace modulu Tracker Python Instalace modulu Tracker Python:

1. Vyhledejte instalaci files. Pokud jste Tracker nainstalovali do výchozího umístění, najdete je v této složce: C:\Program Files\Vicon\Tracker4.x\SDK\Python
   • Tyto filese zobrazují:
2. Nainstalujte modul Tracker Python jedním z následujících způsobů v závislosti na konkrétní instalaci:
   • Nejjednodušší způsob je spustit dávku file (install_tracker_api.bat), který je součástí instalace Trackeru (jak je znázorněno na obrázku výše).
   • To obvykle funguje dobře, pokud:
   • Python byl nainstalován do proměnné PATH; nebo
   • Je nainstalováno více verzí Pythonu, ale chcete nainstalovat API na nejnovější verzi, kterou jste nainstalovali; nebo
   • Je nainstalována pouze jedna verze Pythonu.
   • Pokud platí některá z těchto podmínek, přečtěte si téma Instalace modulu python spuštěním dávky file na.
   • Ve všech ostatních případech nainstalujte modul Python pomocí pip. To obvykle platí, pokud:
   • Je nainstalováno více verzí Pythonu, ale vy chcete nainstalovat konkrétní verzi; nebo
   • Je nainstalováno více různých verzí Pythonu a chcete nainstalovat do všech z nich (v tomto případě musíte nainstalovat modul pro každou verzi); nebo
   • Je nainstalována pouze jedna verze Pythonu, ale neinstalovali jste ji do PATH.
   • Pokud platí některá z těchto podmínek, přečtěte si téma Instalace modulu Python spuštěním pip on.

Nainstalujte modul Python spuštěním dávky file Postup:

1. Přejděte do instalační složky Pythonu: C:\Program Files\Vicon\Tracker4.x\SDK\Python
2. Poklepejte na soubor install_tracker_api.bat.
   • Proces instalace se inicializuje automaticky.

Nainstalujte modul Python spuštěním pip

1. Přejděte do složky Skripty pro Python, který chcete použít:
2. Pro Python 3 je výchozí instalační složka: C: \Users\ \AppData\Local\Programs\Python\Python \Sc ripy
   • Pro Python 2.7 je výchozí instalační složka: C:\Python27\Scripts
3. Otevřete příkazové okno nebo PowerShell v této složce.
4. Spusťte následující příkaz a nainstalujte Vicon Core API: C: \Uživatelé\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe nainstalovat „C:\Program Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api”
   • Spuštěním následujícího příkazu nainstalujte Tracker API C: \Uživatelé\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe nainstalovat „C:\Program Files\Vicon\Tracker 4.0\SDK\Python\tracker_api”

Poznámka Výše uvedený exampsoubory používají instalaci Pythonu 3.11 s Trackerem 4.0. Vaše cesta a příkazy se mohou mírně lišit.

Zkontrolujte, zda je modul Python správně nainstalován

• Zkontrolujte, zda byly nainstalovány následující moduly.
• vicon_core_api: Toto je základní API pro vzdálené ovládání a zahrnuje klienta pro komunikaci s terminálovým serverem.
• tracker_api: Services API pro přístup k funkcím aplikace specifické pro sledování.
• Chcete-li otestovat, zda je modul Tracker Python nainstalován správně, zkuste importovat jeden z modulů v Pythonu: >>> import vicon_core_api

Pokud výše uvedený proces nerozpozná modul, zkuste následující:

• Zkontrolujte složku site-packages v instalaci Pythonu, zda neobsahuje složku tracker_api nebo vicon_core_api. Pro Python 3.11 je umístění výchozí instalační složky:
  • C:\Users\ \AppData\Local\Programs\Python\Python311\Lib\site-packages
• Zkontrolujte systémové proměnné prostředí a ujistěte se, že složka skriptů pro instalaci Pythonu, kterou chcete použít, je v seznamu nejvýše. Pro Python 3.11 je výchozí umístění instalační složky:
  • C:\Users\ \AppData\Local\Programs\Python\Python311\Scripts
• Pokud některá ze složek modulů chybí a ověřili jste cestu, spusťte znovu instalační proces popsaný v části Instalace modulu Tracker Python.

Připojte se k terminálovému serveru

• Chcete-li se připojit k terminálovému serveru, nejprve importujte modul Vicon Core API: >>> import vicon_core_api
  • >>> z importu vicon_core_api
• Dále vytvořte klienta. Tím se automaticky pokusí připojit ke konkrétní adrese hostitele na výchozím portu (52800) >>> c = Client('localhost')
• Zkontrolujte, zda se klient úspěšně připojil k serveru: >>> print(c.connected) Pravda
• Pokud je odpověď False, před vytvořením nového klienta se ujistěte, že máte spuštěnou instanci nástroje Tracker na zadané adrese hostitele a že vaše brána firewall neblokuje provoz na portu 52800.
• Po úspěšném připojení můžete přistupovat ke službám poskytovaným terminálovým serverem Tracker.
• Tento example používá základní objektové služby: >>> import tracker_api >>> z tracker_api import BasicObjectServices >>> services = BasicObjectServices(c)
• Když je připojen, můžete volat metody na instanci Tracker.
  • NapřampChcete-li získat seznam objektů na panelu Sledování, použijte: >>> result, object_list = services.basic_object_list() >>> print(result)
  • dobře: funkce uspěla
  • >>> tisk (seznam_objektů)
  • ['Object1', 'Object2'…]
• Všechna volání API vracejí výsledný kód, který je popsán v vicon_core_api/result.py.
• Jedním z možných chybových kódů je Result.RPCNotConnected, který je přijat, pokud dojde ke ztrátě připojení k terminálovému serveru.
• Napřample: >>> result, object_list = services.basic_object_list() vicon_core_api.client.RPCError: RPCNotConnected: Připojení ke vzdálené funkci nebo zpětnému volání není otevřeno
• Chcete-li zobrazit seznam všech dostupných funkcí a dokumentace: >>> help( tracker_api)

Example skripty

• Můžete najít example skripty ukazující použití běžných funkcí API na C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
• Všechny skripty mají dokumentaci a používají volbu –help, která poskytuje podrobnosti o příslušných argumentech.
• Běžet jakoample script otevřete příkazové okno nebo power shell ve složce scripts výše. Můžete to udělat jedním ze dvou způsobů:
• Otevřete příkazový řádek a změňte svůj adresář na složku scripts: c:\> cd C:\Program Files\Vicon\Tracker
  • 4.0\SDK\Python\sample_scripts
• Podržte SHIFT+klikněte pravým tlačítkem do složky skriptů a vyberte Otevřít příkazové okno zde nebo Otevřít okno Powershell zde.
• Odtud můžete spustit example skript dle vašeho výběru.
• Následující exampsoubory používají příkazové okno.

camera_calibration_wave.py

• Tento skript ukazuje, jak používat funkce API k řízení procesu kalibrace spouštění a zastavování mávnutí hůlky.
  • C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py camera_calibration_wave.py
• V případě úspěchu se zobrazí ovládací prvky kalibrace

capture_control.py

• Tento skript ukazuje, jak zachytit živá data C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• Název zachycení je uveden před ovládacími prvky. Chcete-li změnit název zachycení, použijte capture_services a SetCaptureName.
• Máte-li dotazy ohledně používání rozhraní Tracker API, kontaktujte podporu Vicon1.
• 1 mailto:podpora@vicon.com
• Rychlý průvodce rozhraním Vicon Tracker Python API 31. května 2023, revize 1
• Pro použití s ​​Trackerem 4.0
• © Copyright 2020–2023 Vicon Motion Systems Limited. Všechna práva vyhrazena.
• Revize 1. Pro použití s ​​Trackerem 4.0
• Společnost Vicon Motion Systems Limited si vyhrazuje právo provádět změny informací nebo specifikací v tomto dokumentu bez předchozího upozornění.
• Společnosti, jména a údaje použité napřampsoubory jsou fiktivní, pokud není uvedeno jinak. Žádná část této publikace nesmí být reprodukována, ukládána do vyhledávacího systému nebo přenášena v jakékoli formě nebo jakýmikoli prostředky, elektronickými nebo mechanickými, fotokopírováním nebo nahráváním nebo jinak bez předchozího písemného povolení společnosti Vicon Motion Systems Ltd.
• Vicon® je registrovaná ochranná známka společnosti 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™ a Vicon Vue™ jsou ochranné známky společnosti Oxford Metrics plc.
• VESA® je registrovaná ochranná známka vlastněná společností VESA (www.vesa.org/about-vesa/). Ostatní názvy produktů a společností zde uvedené mohou být ochrannými známkami příslušných vlastníků.
• Pro úplné a aktuální uznání autorských práv a ochranných známek navštivte https://www.vicon.com/vicon/copyright-information.
• Vicon Motion Systems je společnost Oxford Metrics plc.
• E-mail: podpora@vicon.com Web: http://www.vicon.com