VICON Tracker Python Api brugervejledning

VICON Tracker Python API

Specifikationer

• Produktnavn: Vicon Tracker Python API
• Kompatibilitet: Tracker 4.0
• Understøttede Python-versioner: 2.7 og Python 3

Produktbrugsvejledning

Installer Tracker API

Følg disse trin for at bruge Tracker API med Python:

1. Tjek Python-versionen for at sikre kompatibilitet.
2. Installer Python ved at downloade det fra den officielle webwebsted og vælge den relevante version.
3. Find og installer Tracker Python-modulet fra den angivne mappe.

Tjek Python-versionen

1. Åbn en kommandoprompt.
2. Skriv 'py' og tryk på Enter.
3. Hvis Python ikke er installeret, se installationsvejledningen.

Installer Python

1. Gå til Pythons embedsmand webwebsted.
2. Download og installer Python, og sørg for at tilføje python.exe til PATH under installationen.

Installer Tracker Python-modulet:

1. Find installationen files i den angivne mappe.
2. Vælg installationsmetode baseret på din opsætning.

Installer Python-modulet ved at køre batchen File:

1. Naviger til Python installationsmappen: C: Program FilesViconTracker4.xSDKPython
2. Dobbeltklik på 'install_tracker_api.bat' for at starte installationsprocessen.

Ofte stillede spørgsmål (FAQ):

Q: Hvad kan jeg automatisere ved hjælp af Tracker API?

• A: Tracker API giver dig mulighed for at automatisere almindelige funktioner såsom indlæsning, afspilning, eksport af data, aktivering/deaktivering af objekter og udløsning af arbejdsprocesdele.

Sp: Hvilke Python-versioner understøttes af Tracker API?

• A: Tracker API understøtter Python version 2.7 og Python

Om denne guide

• Tracker API lader dig kontrollere visse funktioner i Tracker via en Python API.
• API'en giver dig mulighed for at automatisere nogle almindelige funktioner i Tracker, såsom indlæsning, afspilning og eksport af data, aktivering eller deaktivering af forskellige objekter eller udløsning af dele af arbejdsgangen.
• Dette dokument giver dig mulighed for at komme i gang med Tracker API.

Installer Tracker API

• For at bruge Tracker API med Python skal du sikre dig, at du har begge installeret.
• Tracker API'en understøtter Python 2.7 og Python 3. Vicon anbefaler, at du bruger den seneste fulde udgivelse af Python 3, medmindre dit projekt kræver, at du bruger en specifik version af Python.

Disse procedurer guider dig gennem installationsprocessen:

• Tjek Python-versionen til
• Installerer Python på
• Installation af Tracker Python-modulet på
• Kontroller, at Python-modulet er installeret korrekt på

Tjek Python-versionen

• Hvis du ikke er sikker på, om du har Python installeret, eller hvilken version af Python du bruger, kan du åbne en kommandoprompt og køre py-kommandoen.

F.eksampdet:

Hvis du ikke har Python installeret, se Installer Python.

Installer Python Sådan installerer du Python 2 eller 3:

1. Gå til  https://www.python.org/downloads/
2. Find den påkrævede version og installer Python, og sørg for, at Tilføj python.exe til PATH er valgt:

I ovenstående billede er ABC erstattet med dit brugernavn til installationsmappen.

Installer Tracker Python-modulet Sådan installeres Tracker Python-modulet:

1. Find installationen files. Hvis du har installeret Tracker på standardplaceringen, findes de i denne mappe: C:\Program Files\Vicon\Tracker4.x\SDK\Python
   • Disse files vises:
2. Installer Tracker Python-modulet på en af ​​følgende måder, afhængigt af din specifikke installation:
   • Den enkleste måde er at køre batchen file (install_tracker_api.bat), der er inkluderet i Tracker-installationen (som vist på billedet ovenfor).
   • Dette fungerer normalt godt, hvis:
   • Python blev installeret til PATH-variablen; eller
   • Flere versioner af Python er installeret, men du vil installere API'et til den seneste version, som du har installeret; eller
   • Kun en enkelt version af Python er installeret.
   • Hvis nogen af ​​disse betingelser gælder, se Installer python-modulet ved at køre batchen file på.
   • I alle andre tilfælde skal du installere Python-modulet ved at bruge pip. Dette gælder normalt hvis:
   • Flere versioner af Python er installeret, men du vil installere til en bestemt version; eller
   • Flere forskellige versioner af Python er installeret, og du vil installere til dem alle (i dette tilfælde skal du installere modulet for hver version); eller
   • Kun en enkelt version af Python er installeret, men du har ikke installeret til PATH.
   • Hvis nogen af ​​disse betingelser gælder, se Installer Python-modulet ved at køre pip on.

Installer Python-modulet ved at køre batchen file Sådan gør du:

1. Naviger til Python installationsmappen: C:\Program Files\Vicon\Tracker4.x\SDK\Python
2. Dobbeltklik på install_tracker_api.bat.
   • Installationsprocessen initialiseres automatisk.

Installer Python-modulet ved at køre pip

1. Naviger til mappen Scripts for den Python, du vil bruge:
2. For Python 3 er standardinstallationsmappen: C: \Users\ \AppData\Local\Programs\Python\Python \Sc river
   • For Python 2.7 er standardinstallationsmappen: C:\Python27\Scripts
3. Åbn et kommandovindue eller PowerShell i den mappe.
4. Kør følgende kommando for at installere Vicon Core API: C: \Brugere\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installer “C:\Program Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api"
   • Kør følgende kommando for at installere Tracker API C: \Brugere\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installer “C:\Program Files\Vicon\Tracker 4.0\SDK\Python\tracker_api"

Note Ovenstående examples bruger en Python 3.11 installation med Tracker 4.0. Din sti og dine kommandoer kan variere lidt.

Kontroller, at Python-modulet er installeret korrekt

• Kontroller, at følgende moduler er installeret.
• vicon_core_api: Dette er den centrale fjernstyrings-API og inkluderer en klient til kommunikation med terminalserveren.
• tracker_api: Services API til at få adgang til Tracker-specifik applikationsfunktionalitet.
• For at teste, at Tracker Python-modulet er installeret korrekt, prøv at importere et af modulerne i Python: >>> import vicon_core_api

Hvis ovenstående proces ikke genkender modulet, kan du prøve følgende:

• Tjek mappen site-packages i Python-installationen for mappen tracker_api eller vicon_core_api. For Python 3.11 er placeringen af ​​standardinstallationsmappen:
  • C:\Brugere\ \AppData\Local\Programs\Python\Python311\Lib\site-pakker
• Tjek dine systemmiljøvariabler og sørg for, at scriptmappen for den Python-installation, du vil bruge, er den højeste på listen. For Python 3.11 er standardplaceringen af ​​installationsmappen:
  • C:\Brugere\ \AppData\Local\Programs\Python\Python311\Scripts
• Hvis en af ​​modulernes mapper mangler, og du har bekræftet stien, skal du gentage installationsprocessen, der er beskrevet i Installation af Tracker Python-modulet på.

Opret forbindelse til terminalserveren

• For at oprette forbindelse til terminalserveren skal du først importere Vicon Core API-modulet: >>> import vicon_core_api
  • >>> fra vicon_core_api import
• Opret derefter en klient. Dette forsøger automatisk at oprette forbindelse til den specifikke værtsadresse på standardporten (52800) >>> c = Client('localhost')
• Kontroller, at klienten har oprettet forbindelse til serveren: >>> print(c.connected) Sandt
• Hvis svaret er falsk, skal du sikre dig, at du har en forekomst af Tracker, der kører på den angivne værtsadresse, og din firewall ikke blokerer trafik på port 52800, før du opretter en ny klient.
• Når du har oprettet forbindelse, kan du få adgang til de tjenester, der leveres af Tracker-terminalserveren.
• Denne example bruger grundlæggende objekttjenester: >>> import tracker_api >>> fra tracker_api import BasicObjectServices >>> services = BasicObjectServices(c)
• Når den er tilsluttet, kan du kalde metoder på Tracker-forekomsten.
  • F.eksample, for at få en liste over objekter i sporingspanelet, brug: >>> result, object_list = services.basic_object_list() >>> print(result)
  • Ok: funktionen lykkedes
  • >>> print(objektliste)
  • ['Objekt1', 'Objekt2'...]
• Alle API-kald returnerer en resultatkode, som er beskrevet i vicon_core_api/result.py.
• En mulig fejlkode er Result.RPCNotConnected, som modtages, hvis forbindelsen til terminalserveren mistes.
• F.eksample: >>> resultat, object_list = services.basic_object_list() vicon_core_api.client.RPCError: RPCNotConnected: Forbindelsen til fjernfunktionen eller tilbagekald er ikke åben
• For at vise en liste over alle tilgængelige funktioner og dokumentation: >>> help(tracker_api)

Example scripts

• Du kan finde example scripts, der viser brugen af ​​almindelige API-funktioner på C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
• Alle scripts har dokumentation og har en -hjælp mulighed, der giver detaljer om de relevante argumenter.
• At løbe somample script, skal du åbne et kommandovindue eller power shell i scriptmappen ovenfor. Du kan gøre dette på en af ​​to måder:
• Åbn kommandoprompten og skift din mappe til mappen scripts: c:\> cd C:\Program Files\Vicon\Tracker
  • 4.0\SDK\Python\sample_scripts
• Hold SHIFT+højreklik i scriptmappen og vælg Åbn kommandovindue her eller Åbn Powershell-vindue her.
• Herfra kan du køre exampet script efter eget valg.
• Følgende examples brug kommandovinduet.

camera_calibration_wave.py

• Dette script demonstrerer, hvordan man bruger API-funktioner til at styre kalibreringsprocessen for at starte og stoppe stavbølgen.
  • C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py camera_calibration_wave.py
• Hvis det lykkes, vises kalibreringskontrollerne

capture_control.py

• Dette script viser, hvordan man fanger live data C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• Capture-navnet er angivet før kontrollerne. For at ændre optagelsesnavnet skal du bruge capture_services og SetCaptureName.
• For spørgsmål om brug af Tracker API, kontakt Vicon Support1.
• 1 mail til:support@vicon.com
• Vicon Tracker Python API Quick Start Guide 31. maj 2023, Revision 1
• Til brug med Tracker 4.0
• © Copyright 2020–2023 Vicon Motion Systems Limited. Alle rettigheder forbeholdes.
• Revision 1. Til brug med Tracker 4.0
• Vicon Motion Systems Limited forbeholder sig retten til at foretage ændringer af oplysninger eller specifikationer i dette dokument uden varsel.
• Virksomheder, navne og data brugt i f.eksamples er fiktive, medmindre andet er angivet. Ingen del af denne publikation må gengives, lagres i et genfindingssystem eller transmitteres i nogen form eller på nogen måde, elektronisk eller mekanisk, ved fotokopiering eller optagelse eller på anden måde uden forudgående skriftlig tilladelse fra Vicon Motion Systems Ltd.
• Vicon® er et registreret varemærke tilhørende 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™ og Vicon Vue™ er varemærker tilhørende Oxford Metrics plc.
• VESA® er et registreret varemærke ejet af VESA (www.vesa.org/about-vesa/). Andre produkt- og virksomhedsnavne heri kan være varemærker tilhørende deres respektive ejere.
• For fuldstændige og opdaterede copyright- og varemærkeanerkendelser, besøg https://www.vicon.com/vicon/copyright-information.
• Vicon Motion Systems er et Oxford Metrics plc-selskab.
• E-mail: support@vicon.com Web: http://www.vicon.com