VICON トラッカー Python API ユーザーガイド

コンテンツ 隠れる

1 VICON トラッカー Python API

2 製品使用説明書

3 このガイドについて

4 トラッカー API をインストールする

VICON トラッカー Python API

仕様

製品名: Vicon トラッカー Python API
互換性: トラッカー4.0
サポートされている Python バージョン: 2.7 および Python 3

製品使用説明書

トラッカー API をインストールする

Python で Tracker API を使用するには、次の手順に従います。

Python のバージョンを確認して互換性を確認してください。
公式からPythonをダウンロードしてインストールします webサイトにアクセスし、適切なバージョンを選択します。
指定したフォルダーから Tracker Python モジュールを見つけてインストールします。

Pythonのバージョンを確認する

コマンドプロンプトを開きます。
「py」と入力して Enter キーを押します。
Python がインストールされていない場合は、インストール手順を参照してください。

Pythonをインストールする

へ移動 Pythonの公式 webサイト.
Python をダウンロードしてインストールします。インストール中に python.exe を PATH に追加します。

トラッカー Python モジュールをインストールします。

インストールを見つけます file指定されたフォルダー内にあります。
セットアップに基づいてインストール方法を選択してください。

バッチを実行して Python モジュールをインストールする File:

Python インストールフォルダーに移動します: C: Program FilesViconTracker4.xSDKPython
「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 をインストールする

Python で Tracker API を使用するには、両方がインストールされていることを確認する必要があります。
Tracker API は、Python 2.7 および Python 3 のサポートを提供します。Vicon では、プロジェクトで特定のバージョンの Python を使用する必要がない限り、Python 3 の最新の完全リリースを使用することをお勧めします。

以下の手順に従って、インストールプロセスを進めてください。

Pythonのバージョンを確認する
Python のインストール
Tracker Python モジュールをインストールする
Python モジュールが正しくインストールされていることを確認してください

Pythonのバージョンを確認する

Python がインストールされているかどうか、または使用している Python のバージョンが不明な場合は、コマンドプロンプトを開いて py コマンドを実行できます。

例えばamp上：

Python がインストールされていない場合は、「Python のインストール」を参照してください。

Pythonをインストールする Python 2 または 3 をインストールするには:

へ移動 https://www.python.org/downloads/
必要なバージョンを見つけて Python をインストールし、「Python.exe を PATH に追加」が選択されていることを確認します。

上の画像では、ABC がインストールフォルダーのユーザー名に置き換えられます。

Tracker Python モジュールをインストールする Tracker Python モジュールをインストールするには、次の手順を実行します。

インストールを見つけます files.トラッカーをデフォルトの場所にインストールした場合、トラッカーは次のフォルダーにあります: C:\Program Files\Vicon\Tracker4.x\SDK\Python
- これら fileが表示されます。

特定のインストールに応じて、次のいずれかの方法で Tracker Python モジュールをインストールします。
- 最も簡単な方法はバッチを実行することです file (install_tracker_api.bat) これは、Tracker インストールに含まれています (上の図を参照)。
- 通常、これは次の場合にうまく機能します。
- Python は PATH 変数にインストールされました。または
- 複数のバージョンの Python がインストールされていますが、API をインストールした最新バージョンにインストールしたいと考えています。または
- Python の単一バージョンのみがインストールされます。
- これらの条件のいずれかが当てはまる場合は、「バッチを実行して Python モジュールをインストールする」を参照してください。 file の上。
- それ以外の場合は、pip を使用して Python モジュールをインストールします。これは通常、次の場合に適用されます。
- Python の複数のバージョンがインストールされていますが、特定のバージョンにインストールしたい場合。または
- Python の複数の異なるバージョンがインストールされており、それらすべてにインストールしたいとします (この場合、バージョンごとにモジュールをインストールする必要があります)。または
- Python の単一バージョンのみがインストールされていますが、PATH にインストールされていません。
- これらの条件のいずれかが当てはまる場合は、「pip on を実行して Python モジュールをインストールする」を参照してください。

バッチを実行して Python モジュールをインストールする file これを行うには:

Python インストールフォルダーに移動します。 C:\プログラム Files\Vicon\Tracker4.x\SDK\Python
install_tracker_api.bat をダブルクリックします。
- インストールプロセスは自動的に初期化されます。

pip を実行して Python モジュールをインストールします

使用する Python の Scripts フォルダーに移動します。
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 install “C:\Program” Files\Vicon\Tracker 4.0\SDK\Python\vicon_core_api”
- 次のコマンドを実行して、Tracker API C をインストールします。 \ユーザー\ \AppData\Local\Programs\Python\Python311\Scrip ts> .\pip.exe install “C:\Program” Files\Vicon\Tracker 4.0\SDK\Python\tracker_api”

注記上記の例ampファイルでは、Tracker 3.11 を備えた Python 4.0 インストールを使用します。パスとコマンドは若干異なる場合があります。

Pythonモジュールが正しくインストールされていることを確認してください

以下のモジュールがインストールされていることを確認してください。
vicon_core_api: これはコアリモートコントロール API であり、ターミナルサーバーと通信するためのクライアントが含まれています。
トラッカー_API: Tracker 固有のアプリケーション機能にアクセスするためのサービス API。
Tracker Python モジュールが正しくインストールされていることをテストするには、Python でモジュールの 1 つをインポートしてみてください: >>> 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 ターミナルサーバーが提供するサービスにアクセスできるようになります。
この元ampファイルは基本的なオブジェクトサービスを使用します。 >>> import tracker_api >>> from tracker_api import BasicObjectServices >>> services = BasicObjectServices(c)
接続すると、Tracker インスタンスのメソッドを呼び出すことができます。
- 例えばampファイル、[追跡] パネル内のオブジェクトのリストを取得するには、次を使用します: >>> result, object_list = services.basic_object_list() >>> print(result)
- わかりました： 関数は成功しました
- >>> print(オブジェクトリスト)
- ['オブジェクト 1'、'オブジェクト 2'…]

すべての API 呼び出しは結果コードを返します。これについては vicon_core_api/result.py で説明されています。
考えられる失敗コードの 1 つは、ターミナルサーバーへの接続が失われた場合に受信される Result.RPCNotConnected です。
例えばampファイル: >>> 結果、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 オプションを使用できます。

として実行するにはampファイルスクリプトを作成するには、上記のスクリプトフォルダーでコマンドウィンドウまたは Power Shell を開きます。これは、次の 2 つの方法のいずれかで実行できます。
コマンドプロンプトを開き、ディレクトリを script フォルダーに変更します。 c:\> cd C:\プログラム Files\Vicon\Tracker
- 4.0\SDK\Python\sample_scripts
Shift キーを押しながらスクリプトフォルダー内で右クリックし、[ここでコマンドウィンドウを開く] または [ここで Powershell ウィンドウを開く] を選択します。

ここから元のファイルを実行できますampファイルスクリプトを選択します。
次の例ampコマンドウィンドウを使用します。

カメラ_キャリブレーション_wave.py

このスクリプトは、API 関数を使用して杖の波の開始と停止の調整プロセスを制御する方法を示します。
- C:\プログラム Files\Vicon\Tracker 4.0\SDK\Python\sample_scripts> py Camera_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 Support1 にお問い合わせください。
1 mailto：support@vicon.com
Vicon Tracker Python API クイックスタートガイド、31 年 2023 月 1 日、改訂 XNUMX

トラッカー 4.0 で使用する場合
リビジョン 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は、OxfordMetricsplcの会社です。
メールアドレス: support@vicon.com Web: http://www.vicon.com

ドキュメント / リソース

VICON トラッカー Python API [pdf] ユーザーガイド
トラッカー Python API、トラッカー、Python API、Api

参考文献

ユーザーマニュアル