VICON Tracker Python API

Технічні характеристики

• Назва продукту: Vicon Tracker Python API
• Сумісність: Трекер 4.0
• Підтримувані версії Python: 2.7 і Python 3

Інструкція з використання продукту

Встановіть Tracker API

Щоб використовувати Tracker API з Python, виконайте такі дії:

1. Перевірте версію Python, щоб переконатися в сумісності.
2. Встановіть Python, завантаживши його з офіційного сайту webсайту та вибравши відповідну версію.
3. Знайдіть і встановіть модуль Tracker Python із зазначеної папки.

Перевірте версію Python

1. Відкрийте командний рядок.
2. Введіть «py» і натисніть Enter.
3. Якщо Python не встановлено, зверніться до інструкцій зі встановлення.

Встановіть Python

1. Перейти до Офіційна особа Python webсайт.
2. Завантажте та встановіть Python, додавши python.exe до PATH під час встановлення.

Встановіть модуль Tracker Python:

1. Знайдіть установку files у вказаній папці.
2. Виберіть спосіб встановлення залежно від ваших налаштувань.

Встановіть модуль Python шляхом пакетного запуску File:

1. Перейдіть до папки встановлення Python: C: Program FilesViconTracker4.xSDKPython
2. Двічі клацніть «install_tracker_api.bat», щоб розпочати процес встановлення.

Часті запитання (FAQ):

З: Що я можу автоматизувати за допомогою Tracker API?

• A: API Tracker дозволяє автоматизувати загальні функції, такі як завантаження, відтворення, експорт даних, активація/дезактивація об’єктів і запуск частин робочого процесу.

З: Які версії Python підтримуються Tracker API?

• A: API Tracker підтримує Python версії 2.7 і Python

Про цей посібник

• API Tracker дозволяє керувати певними функціями Tracker через API Python.
• API дає змогу автоматизувати деякі загальні функції Tracker, такі як завантаження, відтворення та експорт даних, активація чи дезактивація різних об’єктів або запуск частин робочого процесу.
• Цей документ дає вам змогу розпочати роботу з API Tracker.

Встановіть Tracker API

• Щоб використовувати Tracker API з Python, ви повинні переконатися, що у вас інстальовано обидва.
• API Tracker підтримує Python 2.7 і Python 3. Vicon рекомендує вам використовувати останню повну версію Python 3, якщо ваш проект не вимагає використання певної версії Python.

Ці процедури проведуть вас через процес встановлення:

• Перевірте версію Python на
• Встановлення Python на
• Встановлення модуля Tracker Python на
• Перевірте, чи правильно встановлено модуль Python

Перевірте версію Python

• Якщо ви не впевнені, чи встановлено у вас Python або яку версію Python ви використовуєте, ви можете відкрити командний рядок і виконати команду py.

наприкладampле:

Якщо у вас не встановлено Python, перегляньте статтю Встановлення Python.

Встановіть Python Щоб установити Python 2 або 3:

1. Перейти до  https://www.python.org/downloads/
2. Знайдіть потрібну версію та встановіть Python, переконавшись, що вибрано Add python.exe to PATH:

На зображенні вище ABC замінено вашим іменем користувача для папки інсталяції.

Встановіть модуль Tracker Python Щоб установити модуль Tracker Python:

1. Знайдіть установку fileс. Якщо ви інсталювали Tracker у типовому місці, вони знаходяться в цій папці: C:\Program Files\Vicon\Tracker4.x\SDK\Python
   • Ці files відображаються:
2. Встановіть модуль Tracker Python одним із наведених нижче способів, залежно від вашої конкретної інсталяції:
   • Найпростіший спосіб - запустити партію file (install_tracker_api.bat), який включено до інсталяції Tracker (як показано на зображенні вище).
   • Зазвичай це добре працює, якщо:
   • Python було встановлено до змінної PATH; або
   • Установлено кілька версій Python, але ви хочете інсталювати API до останньої версії, яку ви встановили; або
   • Встановлюється лише одна версія Python.
   • Якщо застосовна будь-яка з цих умов, див. статтю Інсталяція модуля python шляхом пакетного запуску file на.
   • У всіх інших випадках інсталюйте модуль Python за допомогою pip. Зазвичай це стосується таких випадків:
   • Встановлено кілька версій Python, але ви хочете встановити певну версію; або
   • Встановлено кілька різних версій Python, і ви хочете встановити їх усі (у цьому випадку вам потрібно встановити модуль для кожної версії); або
   • Встановлено лише одну версію Python, але ви не встановили в PATH.
   • Якщо будь-яка з цих умов застосовна, див. Інсталяція модуля Python за допомогою pip on.

Встановіть модуль Python, запустивши пакет file Для цього:

1. Перейдіть до папки встановлення Python: C:\Програма Files\Vicon\Tracker4.x\SDK\Python
2. Двічі клацніть install_tracker_api.bat.
   • Процес інсталяції запускається автоматично.

Встановіть модуль Python, запустивши pip

1. Перейдіть до папки Scripts для Python, який ви хочете використовувати:
2. Для Python 3 папка встановлення за замовчуванням: C: \Users\ \AppData\Local\Programs\Python\Python \Sc рипи
   • Для Python 2.7 папка встановлення за замовчуванням: C:\Python27\Scripts
3. Відкрийте командне вікно або PowerShell у цій папці.
4. Виконайте таку команду, щоб установити Vicon Core API: C: \Користувачі\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe встановити «C:\Program Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api”
   • Виконайте таку команду, щоб інсталювати Tracker API C: \Користувачі\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe встановити «C:\Program Files\Vicon\Tracker 4.0\SDK\Python\tracker_api”

Примітка Наведений вище прикладampвикористовувати інсталяцію Python 3.11 із Tracker 4.0. Ваш шлях і команди можуть дещо відрізнятися.

Перевірте, чи правильно встановлено модуль Python

• Перевірте, чи встановлено такі модулі.
• vicon_core_api: Це основний API віддаленого керування, який включає клієнт для зв’язку з сервером терміналів.
• tracker_api: API служб для доступу до функцій програми Tracker.
• Щоб перевірити, чи правильно встановлено модуль Tracker Python, спробуйте імпортувати один із модулів у Python: >>> import vicon_core_api

Якщо описаний вище процес не розпізнає модуль, спробуйте наступне:

• Перевірте папку site-packages у інсталяції Python на наявність папки tracker_api або vicon_core_api. Для Python 3.11 розташування папки встановлення за замовчуванням:
  • C:\Користувачі\ \AppData\Local\Programs\Python\Python311\Lib\site-packages
• Перевірте змінні системного середовища та переконайтеся, що папка зі сценаріями для інсталяції Python, яку ви хочете використовувати, розташована найвищою в списку. Для Python 3.11 розташування папки встановлення за замовчуванням:
  • C:\Користувачі\ \AppData\Local\Programs\Python\Python311\Scripts
• Якщо будь-яка з папок модулів відсутня, і ви перевірили шлях, повторно запустіть процес встановлення, описаний у Встановлення модуля Tracker Python на.

Підключіться до термінального сервера

• Щоб підключитися до термінального сервера, спочатку імпортуйте модуль Vicon Core API: >>> import vicon_core_api
  • >>> з імпорту vicon_core_api
• Далі створіть клієнта. Це автоматично намагається підключитися до конкретної адреси хоста на порту за замовчуванням (52800) >>> c = Client('localhost')
• Переконайтеся, що клієнт успішно підключився до сервера: >>> print(c.connected) Правда
• Якщо відповідь False, перед створенням нового клієнта переконайтеся, що у вас є екземпляр Tracker, запущений на вказаній адресі хоста, і ваш брандмауер не блокує трафік на порту 52800.
• Після успішного підключення ви можете отримати доступ до послуг, які надає термінальний сервер Tracker.
• Цей колишнійample використовує основні служби об'єктів: >>> import tracker_api >>> from tracker_api import BasicObjectServices >>> services = BasicObjectServices(c)
• Коли він підключений, ви можете викликати методи екземпляра Tracker.
  • наприкладample, щоб отримати список об’єктів на панелі відстеження, використовуйте: >>> result, object_list = services.basic_object_list() >>> print(result)
  • Добре: функція виконана успішно
  • >>> print(object_list)
  • ['Об'єкт1', 'Об'єкт2'…]
• Усі виклики API повертають код результату, який описано у vicon_core_api/result.py.
• Одним із можливих кодів помилок є Result.RPCNotConnected, який отримується, якщо з’єднання з сервером терміналів втрачено.
• наприкладample: >>> result, object_list = services.basic_object_list() vicon_core_api.client.RPCError: RPCNotConnected: підключення до віддаленої функції або зворотного виклику не відкрито
• Щоб відобразити список усіх доступних функцій і документації: >>> help( tracker_api)

Example скрипти

• Ви можете знайти ексample сценарії, що показують використання загальних функцій API на C:\Програма Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
• Усі сценарії мають документацію та мають опцію –help, яка надає деталі відповідних аргументів.
• Бігати якample script, відкрийте командне вікно або Power Shell у папці scripts вище. Ви можете зробити це одним із двох способів:
• Відкрийте командний рядок і змініть свій каталог на папку сценаріїв: c:\> cd C:\Program Files\Vicon\Tracker
  • 4.0\SDK\Python\sample_scripts
• Утримуйте SHIFT+клацніть правою кнопкою миші в папці зі сценаріями та виберіть Відкрити вікно команд тут або Відкрити вікно Powershell тут.
• Звідси ви можете запустити ексampсценарій на ваш вибір.
• Наступний прикладampвикористовувати командне вікно.

camera_calibration_wave.py

• Цей сценарій демонструє, як використовувати функції API для керування процесом калібрування запуску та зупинки хвилі палички.
  • C:\Програма Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py camera_calibration_wave.py
• У разі успіху відображаються елементи керування калібруванням

capture_control.py

• Цей сценарій показує, як отримувати поточні дані C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• Назва захоплення вказана перед елементами керування. Щоб змінити назву запису, використовуйте capture_services і SetCaptureName.
• Із запитаннями щодо використання API Tracker звертайтеся до служби підтримки Vicon1.
• 1 лист:support@vicon.com
• Vicon Tracker Python API Короткий посібник із початку роботи 31 травня 2023 р., версія 1
• Для використання з Tracker 4.0
• © Vicon Motion Systems Limited, 2020–2023. Всі права захищені.
• Редакція 1. Для використання з Tracker 4.0
• Компанія Vicon Motion Systems Limited залишає за собою право вносити зміни до інформації чи специфікацій у цьому документі без попередження.
• Компанії, назви та дані, використані в напрampфайли є фіктивними, якщо не зазначено інше. Жодна частина цієї публікації не може бути відтворена, збережена в пошуковій системі або передана в будь-якій формі чи будь-якими засобами, електронними чи механічними, шляхом фотокопіювання чи запису чи іншим чином без попереднього письмового дозволу Vicon Motion Systems Ltd.
• Vicon® є зареєстрованою торговою маркою 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™ і Vicon Vue™ є товарними знаками Oxford Metrics plc.
• VESA® є зареєстрованою торговою маркою, що належить VESA (www.vesa.org/about-vesa/). Інші назви продуктів і компаній, наведені тут, можуть бути товарними знаками відповідних власників.
• Щоб отримати повну та актуальну інформацію про визнання авторських прав і торгових марок, відвідайте веб-сайт https://www.vicon.com/vicon/copyright-information.
• Vicon Motion Systems є компанією Oxford Metrics plc.
• Електронна пошта: support@vicon.com Web: http://www.vicon.com

Документи / Ресурси

VICON Tracker Python API [pdfПосібник користувача Трекер Python Api, трекер, Python Api, Api

Список літератури

• Посібник користувача