VICON Tracker Python Api 使用者指南

VICON 追蹤器 Python API

規格

• 產品名稱： Vicon 追蹤器 Python API
• 相容性: 追蹤器4.0
• 支援的Python版本： 2.7 和Python 3

產品使用說明

安裝追蹤器 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 。

安裝追蹤器 Python 模組：

1. 找到安裝 files 在指定的資料夾中。
2. 根據您的設定選擇安裝方法。

透過運行批次安裝Python模組 File:

1. 導航至 Python 安裝資料夾：C:Program FilesViconTracker4.xSDKPython
2. 雙擊“install_tracker_api.bat”以啟動安裝程序。

常見問題 (FAQ)：

Q：使用 Tracker API 可以自動化執行哪些操作？

• A: Tracker API 可讓您自動執行常見功能，例如載入、播放、匯出資料、啟用/停用物件以及觸發工作流程部分。

Q：Tracker API 支援哪些 Python 版本？

• A: Tracker API 支援 Python 2.7 版本和 Python

關於本指南

• Tracker API 可讓您透過 Python API 控制 Tracker 的某些功能。
• 此 API 可讓您自動執行 Tracker 的一些常見功能，例如載入、播放和匯出資料、啟用或停用不同的物件或觸發部分工作流程。
• 本文檔使您能夠開始使用 Tracker API。

安裝追蹤器 API

• 若要將 Tracker API 與 Python 結合使用，您必須確保兩者都已安裝。
• Tracker API 提供對 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，確保選擇「將 python.exe 新增至 PATH」：

在上圖中，ABC 替換為您的安裝資料夾的使用者名稱。

安裝 Tracker Python 模組 要安裝 Tracker Python 模組：

1. 找到安裝 files。如果您將 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 在。
   • 在所有其他情況下，請使用 pip 安裝 Python 模組。這通常適用於以下情況：
   • 安裝了多個版本的Python，但您想安裝到特定版本；或者
   • 安裝了多個不同版本的Python，並且您想要安裝所有版本（在這種情況下，您必須為每個版本安裝模組）；或者
   • 僅安裝了單一版本的 Python，但未安裝到 PATH。
   • 如果其中任何條件適用，請參閱透過執行 pip 安裝 Python 模組。

透過運行批次來安裝Python模組 file 為此：

1. 導航至 Python 安裝資料夾： C:\程式 Files\Vicon\Tracker4.x\SDK\Python
2. 雙擊 install_tracker_api.bat。
   • 安裝過程自動初始化。

透過運行 pip 安裝 Python 模組

1. 導航到您要使用的 Python 的 Scripts 資料夾：
2. 對於 Python 3，預設安裝資料夾為：C:\Users\ \AppData\Local\Programs\Python\Python \腳本
   • 對於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檔案使用帶有 Tracker 3.11 的 Python 4.0 安裝。您的路徑和命令可能略有不同。

檢查Python模組是否安裝正確

• 檢查以下模組是否已安裝。
• vicon_core_api： 這是核心遠端控制 API，包括用於與終端伺服器通訊的客戶端。
• tracker_api： 用於存取 Tracker 特定應用程式功能的服務 API。
• 若要測試 Tracker Python 模組是否正確安裝，請嘗試在 Python 中匯入模組之一：>>> import vicon_core_api

如果上述過程無法識別模組，請嘗試以下操作：

• 檢查 Python 安裝中的 site-packages 資料夾中的 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
• 如果回應為 False，請確保在建立新用戶端之前，您有一個在指定主機位址執行的 Tracker 實例，且您的防火牆沒有封鎖連接埠 52800 上的流量。
• 連線成功後，即可存取Tracker終端伺服器提供的服務。
• 這個前任ample 使用基本物件服務： >>> 導入 tracker_api >>> 從 tracker_api 導入 BasicObjectServices >>> services = BasicObjectServices(c)
• 連線後，您可以呼叫 Tracker 實例上的方法。
  • 對於前amp文件，要取得追蹤面板中的物件列表，請使用： >>> 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 腳本，在上面的腳本資料夾中開啟命令視窗或 Power shell。您可以透過以下兩種方式之一執行此操作：
• 開啟命令提示字元並將目錄變更為腳本資料夾： c:\> cd C:\程序 Files\Vicon\追蹤器
  • 4.0\SDK\Python\sample_scripts
• 按住 SHIFT 鍵並右鍵點擊腳本資料夾，然後選擇在此處開啟命令視窗或在此處開啟 Powershell 視窗。
• 從這裡你可以運行 examp您選擇的腳本。
• 以下前amp使用命令視窗。

camera_calibration_wave.py

• 此腳本示範如何使用API​​函數來控制啟動和停止魔杖波的校準過程。
  • C:\程式 Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> pycamera_calibration_wave.py
• 如果成功，將顯示校準控件

捕獲控制.py

• 該腳本展示瞭如何捕獲即時數據 C:\Program Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py capture_control.py
• 捕獲名稱列在控制項之前。若要變更擷取名稱，請使用 capture_services 和 SetCaptureName。
• 有關使用 Tracker API 的問題，請聯絡 Vicon 支援1。
• 1個郵寄地址：支持@vicon.com
• Vicon Tracker Python API 快速入門指南 31 年 2023 月 1 日，修訂版 XNUMX
• 與 Tracker 4.0 搭配使用
• © 版權所有 2020–2023 Vicon Motion Systems Limited。 版權所有。
• 修訂版 1。與 Tracker 4.0 一起使用
• Vicon Motion Systems Limited 保留更改本文檔中的資訊或規格的權利，恕不另行通知。
• ex 中使用的公司、名稱和數據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 公司。
• 電子郵件： 支持@vicon.com Web: http://www.vicon.com