VICON Tracker Python Api brukerveiledning

VICON Tracker Python API

Spesifikasjoner

• Produktnavn: Vicon Tracker Python API
• Kompatibilitet: Tracker 4.0
• Støttede Python-versjoner: 2.7 og Python 3

Produktbruksinstruksjoner

Installer Tracker API

Følg disse trinnene for å bruke Tracker API med Python:

1. Sjekk Python-versjonen for å sikre kompatibilitet.
2. Installer Python ved å laste den ned fra den offisielle webnettstedet og velge riktig versjon.
3. Finn og installer Tracker Python-modulen fra den angitte mappen.

Sjekk Python-versjonen

1. Åpne en ledetekst.
2. Skriv "py" og trykk Enter.
3. Hvis Python ikke er installert, se installasjonsinstruksjonene.

Installer Python

1. Gå til Pythons offisielle webnettstedet.
2. Last ned og installer Python, og sørg for å legge til python.exe til PATH under installasjonen.

Installer Tracker Python-modulen:

1. Finn installasjonen files i den angitte mappen.
2. Velg installasjonsmetode basert på oppsettet ditt.

Installer Python-modulen ved å kjøre batchen File:

1. Naviger til Python-installasjonsmappen: C: Program FilesViconTracker4.xSDKPython
2. Dobbeltklikk på 'install_tracker_api.bat' for å starte installasjonsprosessen.

Ofte stilte spørsmål (FAQ):

Spørsmål: Hva kan jeg automatisere ved å bruke Tracker API?

• A: Tracker API lar deg automatisere vanlige funksjoner som å laste, spille av, eksportere data, aktivere/deaktivere objekter og utløse arbeidsflytdeler.

Spørsmål: Hvilke Python-versjoner støttes av Tracker API?

• A: Tracker API støtter Python versjon 2.7 og Python

Om denne veiledningen

• Tracker API lar deg kontrollere visse funksjoner i Tracker via et Python API.
• API-en lar deg automatisere noen vanlige funksjoner i Tracker, som å laste, spille av og eksportere data, aktivere eller deaktivere forskjellige objekter eller utløse deler av arbeidsflyten.
• Dette dokumentet lar deg komme i gang med Tracker API.

Installer Tracker API

• For å bruke Tracker API med Python, må du sørge for at du har begge installert.
• Tracker API gir støtte for Python 2.7 og Python 3. Vicon anbefaler at du bruker den siste fullversjonen av Python 3 med mindre prosjektet ditt krever at du bruker en spesifikk versjon av Python.

Disse prosedyrene veileder deg gjennom installasjonsprosessen:

• Sjekk Python-versjonen på
• Installerer Python på
• Installerer Tracker Python-modulen på
• Sjekk at Python-modulen er riktig installert på

Sjekk Python-versjonen

• Hvis du ikke er sikker på om du har Python installert eller hvilken versjon av Python du bruker, kan du åpne en ledetekst og kjøre py-kommandoen.

For eksampde:

Hvis du ikke har installert Python, se Installer Python.

Installer Python Slik installerer du Python 2 eller 3:

1. Gå til  https://www.python.org/downloads/
2. Finn den nødvendige versjonen og installer Python, og sørg for at Legg til python.exe til PATH er valgt:

I bildet ovenfor er ABC erstattet med brukernavnet ditt for installasjonsmappen.

Installer Tracker Python-modulen Slik installerer du Tracker Python-modulen:

1. Finn installasjonen files. Hvis du installerte Tracker på standardplasseringen, finnes de i denne mappen: C:\Program Files\Vicon\Tracker4.x\SDK\Python
   • Disse files vises:
2. Installer Tracker Python-modulen på en av følgende måter, avhengig av din spesielle installasjon:
   • Den enkleste måten er å kjøre batchen file (install_tracker_api.bat) som er inkludert i Tracker-installasjonen (som vist i bildet ovenfor).
   • Dette fungerer vanligvis bra hvis:
   • Python ble installert til PATH-variabelen; eller
   • Flere versjoner av Python er installert, men du vil installere API til den nyeste versjonen du installerte; eller
   • Bare én versjon av Python er installert.
   • Hvis noen av disse betingelsene gjelder, se Installer python-modulen ved å kjøre batchen file på.
   • I alle andre tilfeller, installer Python-modulen ved å bruke pip. Dette gjelder vanligvis hvis:
   • Flere versjoner av Python er installert, men du vil installere til en spesifikk versjon; eller
   • Flere forskjellige versjoner av Python er installert og du vil installere på dem alle (i dette tilfellet må du installere modulen for hver versjon); eller
   • Bare én enkelt versjon av Python er installert, men du installerte ikke til PATH.
   • Hvis noen av disse betingelsene gjelder, se Installer Python-modulen ved å kjøre pip på.

Installer Python-modulen ved å kjøre batchen file Slik gjør du dette:

1. Naviger til Python-installasjonsmappen: C:\Program Files\Vicon\Tracker4.x\SDK\Python
2. Dobbeltklikk install_tracker_api.bat.
   • Installasjonsprosessen initialiseres automatisk.

Installer Python-modulen ved å kjøre pip

1. Naviger til Scripts-mappen for Python du vil bruke:
2. For Python 3 er standard installasjonsmappe: C: \Users\ \AppData\Local\Programs\Python\Python \Sc river
   • For Python 2.7 er standard installasjonsmappe: C:\Python27\Scripts
3. Åpne et kommandovindu eller PowerShell i den mappen.
4. Kjør følgende kommando for å installere Vicon Core API: C: \Brukere\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installer "C:\Program Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api"
   • Kjør følgende kommando for å installere Tracker API C: \Brukere\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe installer "C:\Program Files\Vicon\Tracker 4.0\SDK\Python\tracker_api"

Note Ovennevnte eksamples bruker en Python 3.11-installasjon med Tracker 4.0. Banen og kommandoene dine kan variere noe.

Sjekk at Python-modulen er riktig installert

• Kontroller at følgende moduler er installert.
• vicon_core_api: Dette er kjernen for fjernkontroll-API og inkluderer en klient for kommunikasjon med terminalserveren.
• tracker_api: Services API for tilgang til Tracker-spesifikk applikasjonsfunksjonalitet.
• For å teste at Tracker Python-modulen er riktig installert, prøv å importere en av modulene i Python: >>> import vicon_core_api

Hvis prosessen ovenfor ikke gjenkjenner modulen, prøv følgende:

• Sjekk site-packages-mappen i Python-installasjonen for mappen tracker_api eller vicon_core_api. For Python 3.11 er plasseringen av standard installasjonsmappe:
  • C:\Brukere\ \AppData\Local\Programs\Python\Python311\Lib\site-packages
• Sjekk systemmiljøvariablene og sørg for at skriptmappen for Python-installasjonen du vil bruke er den høyeste på listen. For Python 3.11 er standardplasseringen for installasjonsmappen:
  • C:\Brukere\ \AppData\Local\Programs\Python\Python311\Scripts
• Hvis en av modulenes mapper mangler, og du har bekreftet banen, kjør på nytt gjennom installasjonsprosessen beskrevet i Installere Tracker Python-modulen på.

Koble til terminalserveren

• For å koble til terminalserveren, importer først Vicon Core API-modulen: >>> import vicon_core_api
  • >>> fra vicon_core_api import
• Deretter oppretter du en klient. Dette prøver automatisk å koble til den spesifikke vertsadressen på standardporten (52800) >>> c = Client('localhost')
• Sjekk at klienten er koblet til serveren: >>> print(c.connected) Sant
• Hvis svaret er False, sørg for at du har en forekomst av Tracker som kjører på den angitte vertsadressen og brannmuren din ikke blokkerer trafikk på port 52800, før du oppretter en ny klient.
• Når du har koblet til, kan du få tilgang til tjenestene som tilbys av Tracker-terminalserveren.
• Denne eksample bruker grunnleggende objekttjenester: >>> import tracker_api >>> fra tracker_api import BasicObjectServices >>> tjenester = BasicObjectServices(c)
• Når den er tilkoblet, kan du kalle metoder på Tracker-forekomsten.
  • For eksample, for å få en liste over objekter i sporingspanelet, bruk: >>> result, object_list = services.basic_object_list() >>> print(result)
  • Ok: funksjonen lyktes
  • >>> print(objektliste)
  • ['Objekt1', 'Objekt2'...]
• Alle API-kall returnerer en resultatkode, som er beskrevet i vicon_core_api/result.py.
• En mulig feilkode er Result.RPCNotConnected, som mottas hvis forbindelsen til terminalserveren mistes.
• For eksample: >>> resultat, object_list = services.basic_object_list() vicon_core_api.client.RPCError: RPCNotConnected: Tilkoblingen til den eksterne funksjonen eller tilbakeringingen er ikke åpen
• For å vise en liste over alle tilgjengelige funksjoner og dokumentasjon: >>> help( tracker_api)

Example skript

• Du kan finne eksample skript som viser bruken av vanlige API-funksjoner på C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
• Alle skriptene har dokumentasjon og har et hjelpealternativ som gir detaljer om de relevante argumentene.
• Å løpe somample script, åpne et kommandovindu eller power shell i script-mappen ovenfor. Du kan gjøre dette på en av to måter:
• Åpne ledeteksten og endre katalogen til skriptmappen: c:\> cd C:\Program Files\Vicon\Tracker
  • 4.0\SDK\Python\sample_scripts
• Hold SHIFT+høyreklikk i skriptmappen og velg Åpne kommandovindu her eller Åpne Powershell-vindu her.
• Herfra kan du kjøre eksenampskriptet du velger.
• Følgende eksamples bruk kommandovinduet.

camera_calibration_wave.py

• Dette skriptet viser hvordan du bruker API-funksjoner til å kontrollere kalibreringsprosessen for å starte og stoppe stavbølgen.
  • C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py camera_calibration_wave.py
• Hvis vellykket, vises kalibreringskontrollene

capture_control.py

• Dette skriptet viser hvordan du fanger opp live data C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• Capture-navnet er oppført før kontrollene. For å endre fangstnavnet, bruk capture_services og SetCaptureName.
• For spørsmål om bruk av Tracker API, kontakt Vicon Support1.
• 1 mailto:support@vicon.com
• Vicon Tracker Python API hurtigstartveiledning 31. mai 2023, revisjon 1
• For bruk med Tracker 4.0
• © Copyright 2020–2023 Vicon Motion Systems Limited. Alle rettigheter forbeholdt.
• Revisjon 1. For bruk med Tracker 4.0
• Vicon Motion Systems Limited forbeholder seg retten til å gjøre endringer i informasjon eller spesifikasjoner i dette dokumentet uten varsel.
• Selskaper, navn og data brukt i f.eksamplesene er fiktive med mindre annet er angitt. Ingen del av denne publikasjonen kan reproduseres, lagres i et gjenfinningssystem eller overføres i noen form eller på noen måte, elektronisk eller mekanisk, ved fotokopiering eller opptak eller på annen måte uten skriftlig forhåndstillatelse fra Vicon Motion Systems Ltd.
• Vicon® er et registrert varemerke for 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 varemerker for Oxford Metrics plc.
• VESA® er et registrert varemerke som eies av VESA (www.vesa.org/about-vesa/). Andre produkt- og firmanavn her kan være varemerker for deres respektive eiere.
• For fullstendige og oppdaterte opphavsretts- og varemerkebekreftelser, besøk https://www.vicon.com/vicon/copyright-information.
• Vicon Motion Systems er et Oxford Metrics plc-selskap.
• E-post: support@vicon.com Web: http://www.vicon.com