Руководство пользователя API VICON Tracker Python

Содержание скрывать

1 VICON Трекер Python API

2 Инструкции по применению продукта

3 Об этом руководстве

4 Установите API трекера

5 Подключитесь к терминальному серверу

VICON Трекер Python API

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

Название продукта: API-интерфейс Vicon Tracker Python
Совместимость: Трекер 4.0
Поддерживаемые версии Python: 2.7 и Питон 3

Инструкции по применению продукта

Установите API трекера

Чтобы использовать API Tracker с Python, выполните следующие действия:

Проверьте версию Python, чтобы убедиться в совместимости.
Установите Python, загрузив его с официального сайта. webсайт и выбрав подходящую версию.
Найдите и установите модуль Tracker Python из указанной папки.

Проверить версию Python

Откройте командную строку.
Введите «py» и нажмите Enter.
Если Python не установлен, обратитесь к инструкциям по установке.

Установить Питон

Перейти к Официальный представитель Python webсайт.
Загрузите и установите Python, добавив python.exe в PATH во время установки.

Установите модуль Tracker Python:

Найдите установку files в указанной папке.
Выберите метод установки в зависимости от ваших настроек.

Установите модуль Python, запустив пакетный пакет File:

Перейдите в папку установки Python: C: Program. FilesViconTracker4.xSDKPython
Дважды щелкните «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, такие как загрузка, воспроизведение и экспорт данных, активация или деактивация различных объектов или запуск частей рабочего процесса.
Этот документ поможет вам начать работу с Tracker API.

Установите 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 2 или 3:

Перейти к https://www.python.org/downloads/
Найдите нужную версию и установите Python, убедившись, что выбран параметр «Добавить python.exe в PATH»:

На изображении выше ABC заменено вашим именем пользователя для папки установки.

Установите модуль Tracker Python. Чтобы установить модуль Tracker Python:

Найдите установку fileс. Если вы установили Трекер в папку по умолчанию, они находятся в этой папке: C:\Program. Files\Vicon\Tracker4.x\SDK\Python
- Эти fileотображаются:

Установите модуль Tracker Python одним из следующих способов, в зависимости от конкретной установки:
- Самый простой способ — запустить пакет file (install_tracker_api.bat), который включен в установку Трекера (как показано на изображении выше).
- Обычно это работает хорошо, если:
- Python был установлен в переменную PATH; или
- Установлено несколько версий Python, но вы хотите установить API последней установленной версии; или
- Установлена только одна версия Python.
- Если какое-либо из этих условий применимо, см. раздел Установка модуля Python путем запуска пакета. file на.
- Во всех остальных случаях установите модуль Python с помощью pip. Обычно это применяется, если:
- Установлено несколько версий Python, но вы хотите установить конкретную версию; или
- Установлено несколько разных версий Python, и вы хотите установить их все (в этом случае вам необходимо установить модуль для каждой версии); или
- Установлена только одна версия Python, но вы не устанавливали ее в PATH.
- Если какое-либо из этих условий применимо, см. раздел Установка модуля Python с помощью pip on.

Установите модуль Python, запустив пакет file Для этого:

Перейдите в папку установки Python: C:\Программа Files\Vicon\Tracker4.x\SDK\Python
Дважды щелкните install_tracker_api.bat.
- Процесс установки инициализируется автоматически.

Установите модуль Python, запустив pip

Перейдите в папку Scripts для Python, который вы хотите использовать:
Для Python 3 папка установки по умолчанию: C:\Users\. \AppData\Local\Programs\Python\Python \Sc рипы
- Для Python 2.7 папка установки по умолчанию: C:\Python27\Scripts.

Откройте командное окно или PowerShell в этой папке.
Запустите следующую команду, чтобы установить 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 удаленного управления, включающий клиент для связи с сервером терминалов.
трекер_апи: 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) True
Если ответ ложный, прежде чем создавать новый клиент, убедитесь, что у вас есть экземпляр Tracker, работающий по указанному адресу хоста, и ваш брандмауэр не блокирует трафик на порту 52800.
После успешного подключения вы сможете получить доступ к услугам, предоставляемым терминальным сервером Трекера.
Этот бывшийample использует базовые объектные сервисы: >>> импортируйте tracker_api >>> из tracker_api import BasicObjectServices >>> Services = BasicObjectServices(c)
Когда он подключен, вы можете вызывать методы экземпляра Tracker.
- Напримерample, чтобы получить список объектов на панели «Отслеживание», используйте: >>> result, object_list = Services.basic_object_list() >>> print(result)
- Хорошо: функция выполнена успешно
- >>> печать(список_объектов)
- ['Объект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)

Exampле скрипты

Вы можете найти бывшегоampфайлы сценариев, показывающие использование общих функций API на C:\Программа Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts
Все сценарии имеют документацию и имеют параметр –help, который предоставляет подробную информацию о соответствующих аргументах.

Для запуска какample script, откройте командное окно или оболочку Power Shell в папке сценариев выше. Вы можете сделать это одним из двух способов:
Откройте командную строку и измените свой каталог на папку сценариев: c:\> компакт-диск C:\Program Files\Vicon\Трекер
- 4.0\SDK\Python\sample_scripts
Удерживайте SHIFT+щелкните правой кнопкой мыши в папке сценариев и выберите «Открыть командное окно здесь» или «Открыть окно Powershell здесь».

Отсюда вы можете запустить exampсценарий по вашему выбору.
Следующий примерampиспользуйте командное окно.

camera_калибровка_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.
По вопросам использования Tracker API обращайтесь в службу поддержки Vicon1.
1 письмо:support@vicon.com
Краткое руководство по API Vicon Tracker Python 31 мая 2023 г., редакция 1

Для использования с Трекером 4.0.
Версия 1. Для использования с Tracker 4.0.
Vicon Motion Systems Limited оставляет за собой право вносить изменения в информацию или спецификации в этом документе без предварительного уведомления.
Компании, имена и данные, используемые в examples являются вымышленными, если не указано иное. Никакая часть данной публикации не может быть воспроизведена, сохранена в поисковой системе или передана в любой форме и любыми средствами, электронными или механическими, путем фотокопирования или записи или иным образом без предварительного письменного разрешения 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 Трекер Python API [pdf] Руководство пользователя
Трекер Python API, Трекер, Python API, API

Ссылки

Руководство пользователя