APIリファレンス

ContactGlove Python SDKは、ContactGloveを扱うためのPythonライブラリです。

必要環境見出しへのリンクをコピー

対応言語はPython 3.10以上です。

SDK本体はpure Pythonで、OS固有のビルドは不要です。 Windows 11、macOS、Ubuntuで動作確認済みです。 viewerのセットアップとDivingStationの利用環境は、それぞれ確認してください。

あらかじめDivingStationをインストールし、起動しておく必要があります。

このライブラリは次のパッケージに依存しています。

インストール見出しへのリンクをコピー

配布パッケージをコンピューターに保存して展開し、展開したフォルダで同梱のwheelファイルをインストールします。

python -m pip install ./contactglovesdk-X.Y.Z-py3-none-any.whl

依存パッケージ（python-osc、matplotlibなど）はpipが自動的にインストールします。

使い方見出しへのリンクをコピー

DivingStationへの接続と切断見出しへのリンクをコピー

DivingStationに接続するには、ContactGloveClient.connect_to_hostメソッドを使います。

connect_to_hostに渡すHostは、ホスト名、IPアドレス、DivingStation側の受信ポートの3つの情報を持ちます。ホスト名は、ホストを区別するためにユーザーが自由に決める名前です。IPアドレスは、DivingStationを実行しているコンピューターに割り当てられたIPアドレスです。DivingStationの受信ポートは、DivingStationがSDKからのOSCリクエストを受信するポートです。通常は25791ですが、DivingStation側で変更できます。変更した場合は、同じ値を設定してください。

SDK（ローカル）側の受信ポートは、ContactGloveClientのコンストラクタ引数local_portで指定します。0（既定）を渡すとOSが空いているポートを自動で割り当てます。割り当てられたポートは、接続後にclient.local_portプロパティで確認できます。

DSへOSCコマンドを送るときの送信元ポートは、コンストラクタ引数send_portで指定します。0（既定）を渡すとOSが空いているポートを割り当てます。最初の送信（接続など）の後は、client.send_portプロパティで実際のポート番号を確認できます。

LAN承認待ちやデータ途絶からの復帰のためにリトライするには、disconnectやcloseを呼ばずに、同じクライアントでconnect_to_host(host)を再度呼び出してください。同じ送信ソケットからConnectを再送し、受信ポートも維持します（send_port=0の場合も同じです）。SDKは30秒ごとにConnectを自動で再送することも続けます。呼び出しが成功しても、LAN承認が完了したとは限りません。DivingStationの再起動後は、リトライでセッションを復帰できます。必要ならDivingStationで再度承認してください。明示的なDisconnectはセッションを終了し、承認待ちや承認済みの状態を取り消すことがあります。

DivingStationとの接続を閉じるには、disconnectメソッドを使います。SDK全体の終了処理としては、close()（またはwith文によるコンテキストマネージャー形式）でローカルサーバーと送信ソケットを停止します。

from contactglovesdk import ContactGloveClient, Host

host = Host("localhost", "127.0.0.1", 25791)

with ContactGloveClient() as client:
    # Connect to DivingStation
    client.connect_to_host(host)

    # Do various things

    # Disconnect from DivingStation
    client.disconnect(host)

値を読み取る見出しへのリンクをコピー

グローブに関するさまざまな情報を読み取るメソッドがあります。返される値は、呼び出した時点で最後に受信したデータです。取得できる値とメソッドは次のとおりです。

グローブのデータは非同期に届きます。接続する前にコールバックを登録して実際のグローブIDを取得し、データが届いてから読み取ってください。接続の呼び出しはローカルセッションを開始しますが、DivingStationの接続承認やデータ送信を確認するものではありません。

from threading import Event

from contactglovesdk import ContactGloveClient, DeviceConnectedState, Host, InvalidIDError

host = Host("localhost", "127.0.0.1", 25791)
received = Event()
glove_ids = []

def on_glove(glove):
    if glove.connected_state == DeviceConnectedState.Connected and not received.is_set():
        glove_ids.append(glove.id)
        received.set()

with ContactGloveClient() as client:
    client.register_callback_for_glove_data_stream(on_glove)
    client.connect_to_host(host)
    try:
        if received.wait(timeout=5):
            try:
                glove = client.get_data_for_glove(glove_ids[0])
                print(f"id={glove.id}")
            except InvalidIDError:
                print("The glove is no longer available")
        else:
            print("No glove data received within 5 seconds")
    finally:
        client.disconnect(host)

データが届かない場合は、グローブがDivingStationに接続され有効になっていることと、必要な接続承認が完了していることを確認してください。グローブが複数ある場合は、最初のIDが目的のグローブとは限らないため、対象のIDを選んでください。

値の変化を自動で受け取る見出しへのリンクをコピー

グローブに関するさまざまな値が更新されるたびに自動で呼び出されるコールバックを登録できます。コールバックはOSCの受信スレッドから呼び出されるため、コールバック内の処理は複数のスレッドからアクセスされることを前提に実装してください。コールバックが例外を送出した場合、SDKはトレースバック付きでcontactglovesdkロガーに記録し（loggingを設定していない場合はstderrに表示されます）、他のコールバックの呼び出しを続けます。

次のように使います。

import time

from contactglovesdk import ContactGloveClient, GloveData, Host

host = Host("localhost", "127.0.0.1", 25791)

def on_glove(g: GloveData) -> None:
    print(f"[callback] id={g.id}  battery={g.battery_percentage}%"
          f"  left={g.is_left}  state={g.connected_state.name}")

with ContactGloveClient() as client:
    # Registering callbacks before connecting avoids missing updates
    client.register_callback_for_glove_data_stream(on_glove)

    client.connect_to_host(host)

    # Wait for 5 seconds
    time.sleep(5)

    client.disconnect(host)

振動見出しへのリンクをコピー

vibrate_gloveメソッドは、振動機能を持つグローブに振動コマンドを送ります。コマンドは、現在接続中のすべてのDSホストに送られます。 YOUR_GLOVE_ID はDivingStationから受信した実際のIDに置き換えてください。

client.vibrate_glove("YOUR_GLOVE_ID", frequency=200.0, amplitude=0.8, duration=0.2)

定義されている型と関数見出しへのリンクをコピー

このSDKが定義し、利用できるようにしている型と関数は次のとおりです。

クラス見出しへのリンクをコピー

列挙型見出しへのリンクをコピー

例外見出しへのリンクをコピー

定数見出しへのリンクをコピー

DeviceFamilyType見出しへのリンクをコピー

class DeviceFamilyType(IntEnum)

デバイスの種類を表す列挙型

/DS2/HC/Deviceのdevice_typeフィールドに対応します。 主な対象はContactGlove3です。

DeviceColor見出しへのリンクをコピー

class DeviceColor(IntEnum)

デバイスの表示色設定を表す列挙型

/DS2/HC/Deviceのcolorフィールドに対応します。

表示色の型名の移行

表示色設定の公開型名はDeviceColorです。旧版でLedColorを使っているコードは、 from contactglovesdk import DeviceColorへ変更し、LedColor.Greenなどの参照を DeviceColor.Greenへ置き換えてください。GloveData.colorのフィールド名、色の数値、 OSCの通信形式は同じです。

LedColorはDeviceColorの互換エイリアスとして公開されているため、旧import名も引き続き動作します。 新しいコードではDeviceColorを使ってください。 シリアライズされた列挙値は、旧版とのデータ受け渡しに対応するため、LedColorの型名を保持します。

DeviceConnectedState見出しへのリンクをコピー

class DeviceConnectedState(IntEnum)

デバイスの接続状態を表す列挙型

/DS2/HC/Deviceのconnected_stateフィールドに対応します。

ButtonStatus見出しへのリンクをコピー

class ButtonStatus(IntEnum)

ボタンの押下状態を表す列挙型

/DS2/HC/Controllerの各ボタンのフィールドに対応します。

TrackingState見出しへのリンクをコピー

class TrackingState(IntEnum)

IK由来のデータのトラッキング状態を表す列挙型。

/DS2/HC/Ergonomics、/DS2/HC/HandSkeleton、/DS2/HC/HandSkeletonRawのtracking_stateフィールドに対応します。 IkFailedまたはNotAttemptedの値は表示や診断には使えますが、制御、速度の推定、補間には使わないでください。これらの用途で有効なのは Tracked の値だけです。

NotAttempted は必要なIK処理が実行されなかったことを表します。前段の処理失敗や入力不足のほか、更新間隔の制御で既存の姿勢を再利用するなど、姿勢計算が不要と判断された場合も含みます。この状態自体はIKの失敗を意味しません。

SkeletonData はリターゲットIK、RawSkeletonData と ErgonomicsData はソーススケルトンIKの状態を表し、同じ時刻でも状態が異なる場合があります。

ErgonomicsIndex見出しへのリンクをコピー

class ErgonomicsIndex(IntEnum)

ErgonomicsData.valuesの各要素が表す関節を示す列挙型

インデックスは片手分（ERGONOMICS_COUNT = 20要素）で、values[i]はErgonomicsIndex(i)に対応します。値の単位は度で、曲げ角は指を伸ばしたときに0度です。

SkeletonNode見出しへのリンクをコピー

class SkeletonNode(IntEnum)

SkeletonData.positionsの各要素が表す関節を示す列挙型

インデックスは片手分（SKELETON_NODE_COUNT = 25要素）で、positions[i]はSkeletonNode(i)に対応します。

SkeletonRotationNode見出しへのリンクをコピー

class SkeletonRotationNode(IntEnum)

SkeletonData.rotationsの各要素が表す関節を示す列挙型

インデックスは片手分（SKELETON_ROTATION_COUNT = 19要素）で、rotations[i]はSkeletonRotationNode(i)に対応します。 SkeletonNodeと異なり、手首と5つの指先のノードは回転の値を持たないため除かれています。

RawSensorIndex見出しへのリンクをコピー

class RawSensorIndex(IntEnum)

RawSensorData.transformsの各要素が表すセンサーを示す列挙型

インデックスは片手分（RAW_SENSOR_COUNT = 5要素）で、transforms[i]はRawSensorIndex(i)に対応します。

ERGONOMICS_COUNT見出しへのリンクをコピー

ERGONOMICS_COUNT: int = 20

片手あたりのエルゴノミクスデータの要素数（5本の指 × 4関節）

SKELETON_NODE_COUNT見出しへのリンクをコピー

SKELETON_NODE_COUNT: int = 25

片手あたりのスケルトンの位置の要素数

SKELETON_ROTATION_COUNT見出しへのリンクをコピー

SKELETON_ROTATION_COUNT: int = 19

片手あたりのスケルトンの回転の要素数（手首と5つの指先のノードを除きます）

RAW_SENSOR_COUNT見出しへのリンクをコピー

RAW_SENSOR_COUNT: int = 5

片手あたりの生センサーのTransformの数（指1本につき1つ）

ContactGloveClient見出しへのリンクをコピー

from contactglovesdk import ContactGloveClient

ContactGlove SDK v2のメインクラス

ポーリングの戻り値と各ストリームのコールバックには、互いに独立したスナップショットを渡します。ネストしたリストや座標・回転の値も独立しており、変更してもSDKのキャッシュやほかのコールバックへ渡す値には影響しません。

使い方：

import time

from contactglovesdk import ContactGloveClient, Host, InvalidIDError

host = Host("localhost", "127.0.0.1", 25791)
with ContactGloveClient() as client:
    # Register before connecting so the first update is not missed.
    client.register_callback_for_glove_data_stream(
        lambda g: print(g.id, g.battery_percentage)
    )
    client.connect_to_host(host)
    try:
        # Poll until an ID arrives or the five-second deadline expires.
        deadline = time.monotonic() + 5.0
        glove_ids = client.get_ids_of_available_gloves()
        while not glove_ids and time.monotonic() < deadline:
            time.sleep(0.1)
            glove_ids = client.get_ids_of_available_gloves()

        if glove_ids:
            try:
                glove = client.get_data_for_glove(glove_ids[0])
                print(glove.id)
            except InvalidIDError:
                print("The glove is no longer available")
        else:
            print("No glove data received within 5 seconds")
    finally:
        client.disconnect(host)

パブリックメソッド見出しへのリンクをコピー

クラス属性見出しへのリンクをコピー

__init__見出しへのリンクをコピー

ContactGloveClient(local_host: str = "0.0.0.0", local_port: int = 0, send_port: int = 0)

引数見出しへのリンクをコピー

• local_host ローカルのOSCサーバーがbindするネットワークインターフェース（"0.0.0.0"ですべてのインターフェース）。

• local_port ローカルのOSCサーバーがbindするポート番号（0ならOSが空いているポートを自動で選びます）。

• send_port DSへOSCを送るためのローカルのUDPポート番号（0ならOSが空いているポートを自動で選びます）。

start_server見出しへのリンクをコピー

def start_server(self) -> int

どのホストにも接続せずに、ローカルのOSCサーバーを起動します。

connect_to_hostを呼ぶ前にローカルのポート番号が必要な場合に使います。

戻り値見出しへのリンクをコピー

サーバーが実際にbindしたポート番号。

例外見出しへのリンクをコピー

• SDKNotAvailableError ポートのbindに失敗した場合。

local_port見出しへのリンクをコピー

@property
def local_port(self) -> int | None

ローカルのOSCサーバーが使っているポート番号。動作していない間はNoneです。

send_port見出しへのリンクをコピー

@property
def send_port(self) -> int | None

OSCの送信ソケットが使っているポート番号。最初の送信の前はNoneです。

close見出しへのリンクをコピー

def close(self)

ローカルのOSCサーバーと送信ソケットを停止します。

実行中のストリームコールバックがある場合は、それが終わるのを待ってから戻ります。

connect_to_host見出しへのリンクをコピー

def connect_to_host(self, host: Host)

DivingStationに接続し、データストリームを開始します。

ローカルのOSCサーバーがまだ動作していなければ起動し、hostに/DS2/HC/Connect <local_port>を送ります。接続を維持している間は、同じ送信ソケットから30秒ごとにConnectを再送します。

同じIPアドレスとDSポートに対してもう一度呼び出すと、Disconnectを送ったり、送信ソケット・受信ポート・keepaliveワーカーを置き換えたりせずに、Connectを再送します。LAN承認待ちやデータ消失からの復帰のためのリトライに使ってください。send_portが0の場合も、OSが選んだ送信元ポートは維持されます。呼び出しから戻っても、LAN承認が完了したとは限りません。DSの再起動後は、Connectのリトライでセッションを復帰できます。必要ならDSで再度承認してください。明示的なdisconnectはセッションを終了し、承認待ちや承認済みの状態を取り消すことがあります。

引数見出しへのリンクをコピー

• host 接続先のDSのホスト情報。

例外見出しへのリンクをコピー

• SDKNotAvailableError ローカルの受信ポートまたは送信ポートのbindに失敗した場合。

disconnect見出しへのリンクをコピー

def disconnect(self, host: Host)

DSから切断します。

hostに/DS2/HC/Disconnect <local_port>を送ります。最後の接続を閉じるときは、実行中のストリームコールバックが終わるまで待ちます。

引数見出しへのリンクをコピー

• host connect_to_hostに渡したものと同じホスト情報。

例外見出しへのリンクをコピー

• NotConnectedError 指定したホストへの接続が存在しない場合。

does_glove_support_haptics見出しへのリンクをコピー

def does_glove_support_haptics(self, glove_id: str) -> bool

グローブが振動に対応しているかを確認します。

引数見出しへのリンクをコピー

• glove_id 確認するグローブのID。

戻り値見出しへのリンクをコピー

振動機能があるかどうか。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのグローブが存在しない場合。

get_data_for_glove見出しへのリンクをコピー

def get_data_for_glove(self, glove_id: str) -> GloveData

グローブIDに対応するグローブの情報を読み取ります。

引数見出しへのリンクをコピー

• glove_id 読み取るグローブのID。

戻り値見出しへのリンクをコピー

グローブの情報のスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのグローブが存在しない場合。

get_controller_data_for_glove見出しへのリンクをコピー

def get_controller_data_for_glove(self, glove_id: str) -> ControllerData

グローブIDに対応するコントローラーの入力データを読み取ります。

引数見出しへのリンクをコピー

• glove_id 読み取るグローブのID。

戻り値見出しへのリンクをコピー

コントローラーの入力データのスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのデータをまだ受信していない場合。

get_ergonomics_data_for_glove見出しへのリンクをコピー

def get_ergonomics_data_for_glove(self, glove_id: str) -> ErgonomicsData

グローブIDに対応する指の開き角と曲げ角のデータを読み取ります。

引数見出しへのリンクをコピー

• glove_id 読み取るグローブのID。

戻り値見出しへのリンクをコピー

エルゴノミクスデータのスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのデータをまだ受信していない場合。

get_skeleton_data_for_glove見出しへのリンクをコピー

def get_skeleton_data_for_glove(self, glove_id: str) -> SkeletonData

グローブIDに対応する関節の位置と回転のデータを読み取ります。

引数見出しへのリンクをコピー

• glove_id 読み取るグローブのID。

戻り値見出しへのリンクをコピー

スケルトンデータのスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのデータをまだ受信していない場合。

get_raw_skeleton_data_for_glove見出しへのリンクをコピー

def get_raw_skeleton_data_for_glove(self, glove_id: str) -> RawSkeletonData

グローブIDに対応するリターゲット前の手のスケルトンを読み取ります。

戻り値見出しへのリンクをコピー

位置と回転を含む、独立したスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのデータをまだ受信していない場合。

get_rawsensor_data_for_glove見出しへのリンクをコピー

def get_rawsensor_data_for_glove(self, glove_id: str) -> RawSensorData

グローブIDに対応する生センサーのTransformデータを読み取ります。

引数見出しへのリンクをコピー

• glove_id 読み取るグローブのID。

戻り値見出しへのリンクをコピー

生センサーのTransformデータのスナップショット。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのデータをまだ受信していない場合。

get_ids_of_available_gloves見出しへのリンクをコピー

def get_ids_of_available_gloves(self) -> list[str]

現在把握しているすべてのグローブのIDを読み取ります。

戻り値見出しへのリンクをコピー

グローブIDのリスト。

get_number_of_available_gloves見出しへのリンクをコピー

def get_number_of_available_gloves(self) -> int

現在把握しているグローブの総数を読み取ります。

戻り値見出しへのリンクをコピー

グローブの総数。

vibrate_glove見出しへのリンクをコピー

def vibrate_glove(self, glove_id: str, frequency: float, amplitude: float, duration: float)

グローブを振動させます。

コマンドは、現在接続中のすべてのDSホストに送られます。

引数見出しへのリンクをコピー

• glove_id 振動させるグローブのID。

• frequency 振動の周波数（Hz、100.0〜500.0）。

• amplitude 振動の振幅（0.0〜1.0）。

• duration 振動の持続時間（秒、0.001〜1.0）。

例外見出しへのリンクをコピー

• InvalidIDError 指定したIDのグローブが存在しない場合。

• ValueError frequency、amplitude、durationのいずれかが仕様の範囲外であるか、有限の値でない場合。

request_retarget_profile_info見出しへのリンクをコピー

def request_retarget_profile_info(self, profile_uuid: str, request_id: int)

リターゲットプロファイルの表示名と説明をDivingStationに要求します。

応答は、register_callback_for_retarget_profile_info_streamで登録したコールバックに届きます。

引数見出しへのリンクをコピー

• profile_uuid 問い合わせる36文字のUUID。

• request_id リクエストとその応答を対応付ける符号付き32ビット整数。

例外見出しへのリンクをコピー

• ValueError UUIDまたはリクエストIDがプロトコルの形式に合わない場合。

register_callback_for_glove_data_stream見出しへのリンクをコピー

def register_callback_for_glove_data_stream(self, callback: Callable[[GloveData], None])

グローブの情報が更新されたときに呼び出されるコールバックを登録します。

/DS2/HC/Deviceを受信するたびに、更新後のGloveDataを引数としてコールバックが呼び出されます。コールバックはOSCの受信スレッドから呼び出されます。connected_stateがUnconnectedのレコードも渡されますが、その時点でそのIDのデータはもう読み取れません。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

引数見出しへのリンクをコピー

• callback 登録するコールバック関数。

register_callback_for_controller_data_stream見出しへのリンクをコピー

def register_callback_for_controller_data_stream(self, callback: Callable[[ControllerData], None])

コントローラーのデータが更新されたときに呼び出されるコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

引数見出しへのリンクをコピー

• callback 登録するコールバック関数。

register_callback_for_ergonomics_stream見出しへのリンクをコピー

def register_callback_for_ergonomics_stream(self, callback: Callable[[ErgonomicsData], None])

エルゴノミクスデータが更新されたときに呼び出されるコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

引数見出しへのリンクをコピー

• callback 登録するコールバック関数。

register_callback_for_skeleton_stream見出しへのリンクをコピー

def register_callback_for_skeleton_stream(self, callback: Callable[[SkeletonData], None])

スケルトンデータが更新されたときに呼び出されるコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

引数見出しへのリンクをコピー

• callback 登録するコールバック関数。

register_callback_for_raw_skeleton_stream見出しへのリンクをコピー

def register_callback_for_raw_skeleton_stream(self, callback: Callable[[RawSkeletonData], None])

リターゲット前のスケルトンが更新されたときに呼び出されるコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

register_callback_for_rawsensor_stream見出しへのリンクをコピー

def register_callback_for_rawsensor_stream(self, callback: Callable[[RawSensorData], None])

生センサーのTransformデータが更新されたときに呼び出されるコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

引数見出しへのリンクをコピー

• callback 登録するコールバック関数。

register_callback_for_retarget_profile_info_stream見出しへのリンクをコピー

def register_callback_for_retarget_profile_info_stream(self, callback: Callable[[RetargetProfileInfo], None])

リターゲットプロファイル情報の応答を受け取るコールバックを登録します。

コールバックが送出した例外はcontactglovesdkロガーに記録され、他のコールバックの呼び出しは妨げられません。

DEFAULT_DS_PORT見出しへのリンクをコピー

DEFAULT_DS_PORT: int = 25791

DivingStation側のOSC受信ポート番号の既定値

Host見出しへのリンクをコピー

from contactglovesdk import Host

DivingStationのホスト情報を保持するデータクラス

connect_to_host() / disconnect()に渡します。SDK（ローカル）側の受信ポートはContactGloveClientが管理するため、このクラスには含まれません。

パブリック属性見出しへのリンクをコピー

Host.host_name見出しへのリンクをコピー

host_name: str

ホスト名（例："localhost"）

Host.ip_address見出しへのリンクをコピー

ip_address: str

IPアドレス（例："127.0.0.1"）

Host.port見出しへのリンクをコピー

port: int = 25791

DivingStation側のOSC受信ポート番号

GloveData見出しへのリンクをコピー

from contactglovesdk import GloveData

グローブデバイスの情報を保持するデータクラス

OSCアドレス/DS2/HC/Deviceから受信したデータに対応します。

レコードの構成（デバイスごとに10フィールド）：

string id, string pair_id,
int battery_percentage, int is_haptics, int is_left,
int device_type, int color, int connected_state,
string name, int is_external_power_present

パブリック属性見出しへのリンクをコピー

GloveData.id見出しへのリンクをコピー

id: str = ""

デバイスID

GloveData.pair_id見出しへのリンクをコピー

pair_id: str = ""

ペアになっているグローブのID（ない場合は空文字列）

GloveData.battery_percentage見出しへのリンクをコピー

battery_percentage: int = -1

バッテリー残量 [0 - 100]。-1は無効な値を表します

GloveData.is_haptics見出しへのリンクをコピー

is_haptics: bool = False

振動機能があるかどうか

GloveData.is_left見出しへのリンクをコピー

is_left: bool = False

左手用のグローブかどうか

GloveData.device_type見出しへのリンクをコピー

device_type: DeviceFamilyType = DeviceFamilyType.ContactGlove

デバイスの種類

GloveData.color見出しへのリンクをコピー

color: DeviceColor = DeviceColor.Achromatic

デバイスの表示色設定

GloveData.connected_state見出しへのリンクをコピー

connected_state: DeviceConnectedState = DeviceConnectedState.Unknown

接続状態

GloveData.name見出しへのリンクをコピー

name: str = ""

デバイス名

GloveData.is_external_power_present見出しへのリンクをコピー

is_external_power_present: bool = False

外部給電を検出しているかどうか

ControllerData見出しへのリンクをコピー

from contactglovesdk import ControllerData

コントローラーの入力状態を保持するデータクラス

OSCアドレス/DS2/HC/Controllerから受信したデータに対応します。

レコードの構成（コントローラーごとに15フィールド）：

string id, int is_left,
int a, int b, int sys,
int trigger_button, int joystick_button, int trackpad_button,
float trigger, float grip_value, float grip_force,
float joystick_x, float joystick_y,
float trackpad_x, float trackpad_y

パブリック属性見出しへのリンクをコピー

ControllerData.id見出しへのリンクをコピー

id: str = ""

グローブID

ControllerData.is_left見出しへのリンクをコピー

is_left: bool = False

左手かどうか

ControllerData.a_button見出しへのリンクをコピー

a_button: ButtonStatus = ButtonStatus.Unpressed

Aボタンの押下状態

ControllerData.b_button見出しへのリンクをコピー

b_button: ButtonStatus = ButtonStatus.Unpressed

Bボタンの押下状態

ControllerData.sys_button見出しへのリンクをコピー

sys_button: ButtonStatus = ButtonStatus.Unpressed

システムボタンの押下状態

ControllerData.trigger_button見出しへのリンクをコピー

trigger_button: ButtonStatus = ButtonStatus.Unpressed

トリガーボタンの押下状態

ControllerData.joystick_button見出しへのリンクをコピー

joystick_button: ButtonStatus = ButtonStatus.Unpressed

ジョイスティックボタンの押下状態

ControllerData.trackpad_button見出しへのリンクをコピー

trackpad_button: ButtonStatus = ButtonStatus.Unpressed

トラックパッドのタッチの押下状態

ControllerData.trigger見出しへのリンクをコピー

trigger: float = 0.0

トリガーの値（0.0〜1.0）

ControllerData.grip_value見出しへのリンクをコピー

grip_value: float = 0.0

グリップの値（0.0〜1.0）

ControllerData.grip_force見出しへのリンクをコピー

grip_force: float = 0.0

グリップの力（0.0〜1.0）

ControllerData.joystick_x見出しへのリンクをコピー

joystick_x: float = 0.0

ジョイスティックのX軸の値（-1.0〜1.0）

ControllerData.joystick_y見出しへのリンクをコピー

joystick_y: float = 0.0

ジョイスティックのY軸の値（-1.0〜1.0）

ControllerData.trackpad_x見出しへのリンクをコピー

trackpad_x: float = 0.0

トラックパッドのX軸の値（-1.0〜1.0）

ControllerData.trackpad_y見出しへのリンクをコピー

trackpad_y: float = 0.0

トラックパッドのY軸の値（-1.0〜1.0）

ErgonomicsData見出しへのリンクをコピー

from contactglovesdk import ErgonomicsData

指の開き角と曲げ角のデータを保持するデータクラス

OSCアドレス/DS2/HC/Ergonomicsから受信したデータに対応します。

レコードの構成（片手ごとに25フィールド）：

string id, int is_left,
int generated_at_ms_hi, int generated_at_ms_lo, int tracking_state,
float[20] values

values[i]はErgonomicsIndex(i)に対応します。 角度の単位は度で、曲げ角は指を伸ばしたときに0度です。

パブリック属性見出しへのリンクをコピー

ErgonomicsData.id見出しへのリンクをコピー

id: str = ""

グローブID

ErgonomicsData.is_left見出しへのリンクをコピー

is_left: bool = False

左手かどうか

ErgonomicsData.timestamp_ms見出しへのリンクをコピー

timestamp_ms: int = 0

フレームが生成された時刻（Unix時間、ミリ秒）

ErgonomicsData.tracking_state見出しへのリンクをコピー

tracking_state: TrackingState = TrackingState.Tracked

IK由来のトラッキング状態

ErgonomicsData.values見出しへのリンクをコピー

values: list[float] = [0.0, ...]  # 20 elements

関節ごとの開き角・曲げ角の値（片手20要素、度）

SkeletonData見出しへのリンクをコピー

from contactglovesdk import SkeletonData

手のスケルトンデータ（関節の位置と回転）を保持するデータクラス

OSCアドレス/DS2/HC/HandSkeletonから受信したデータに対応します。

レコードの構成（メッセージごとに1レコード、157フィールド）：

string id, string profile_uuid, int is_left,
int generated_at_ms_hi, int generated_at_ms_lo, int tracking_state,
float[75]  # 25 nodes × (p_x, p_y, p_z)
float[76]  # 19 nodes × (q_w, q_x, q_y, q_z)

positions[i]はSkeletonNode(i)に対応します（25要素）。 rotations[i]はSkeletonRotationNode(i)に対応します（19要素。手首と5つの指先のノードは除かれます）。

位置の単位はメートルで、model-rooted空間（手首を原点とする座標系）で表されます。回転は親ノードに対するローカルのクォータニオンです。

パブリック属性見出しへのリンクをコピー

SkeletonData.id見出しへのリンクをコピー

id: str = ""

グローブID

SkeletonData.profile_uuid見出しへのリンクをコピー

profile_uuid: str = ""

リターゲットプロファイルの固定UUID

SkeletonData.is_left見出しへのリンクをコピー

is_left: bool = False

左手かどうか

SkeletonData.timestamp_ms見出しへのリンクをコピー

timestamp_ms: int = 0

フレームが生成された時刻（Unix時間、ミリ秒）

SkeletonData.tracking_state見出しへのリンクをコピー

tracking_state: TrackingState = TrackingState.Tracked

リターゲットのIKに由来するトラッキング状態

SkeletonData.positions見出しへのリンクをコピー

positions: list[Vec3] = [Vec3(x=0.0, y=0.0, z=0.0), ...]  # 25 elements

ノードごとの位置（25要素）。インデックスはSkeletonNodeを参照してください

SkeletonData.rotations見出しへのリンクをコピー

rotations: list[Quaternion] = [Quaternion(w=1.0, x=0.0, y=0.0, z=0.0), ...]  # 19 elements

ノードごとの回転（19要素）。インデックスはSkeletonRotationNodeを参照してください

RawSkeletonData見出しへのリンクをコピー

from contactglovesdk import RawSkeletonData

リターゲット前の手のスケルトンデータを保持するデータクラス。

OSCアドレス/DS2/HC/HandSkeletonRawから受信したデータに対応します。メッセージごとに1レコードで、profile_uuidを除き、位置と回転の構成はSkeletonDataと同じです。

パブリック属性見出しへのリンクをコピー

RawSkeletonData.id見出しへのリンクをコピー

id: str = ""

グローブID

RawSkeletonData.is_left見出しへのリンクをコピー

is_left: bool = False

左手かどうか

RawSkeletonData.timestamp_ms見出しへのリンクをコピー

timestamp_ms: int = 0

フレームが生成された時刻（Unix時間、ミリ秒）

RawSkeletonData.tracking_state見出しへのリンクをコピー

tracking_state: TrackingState = TrackingState.Tracked

ソーススケルトンのIKに由来するトラッキング状態

RawSkeletonData.positions見出しへのリンクをコピー

positions: list[Vec3] = [Vec3(x=0.0, y=0.0, z=0.0), ...]  # 25 elements

ノードごとの位置（25要素）。インデックスはSkeletonNodeを参照してください

RawSkeletonData.rotations見出しへのリンクをコピー

rotations: list[Quaternion] = [Quaternion(w=1.0, x=0.0, y=0.0, z=0.0), ...]  # 19 elements

ノードごとの回転（19要素）。インデックスはSkeletonRotationNodeを参照してください

RawSensorData見出しへのリンクをコピー

from contactglovesdk import RawSensorData

片手分の生センサーのTransformデータを保持するデータクラス

OSCアドレス/DS2/HC/RawSensorTransformsから受信したデータに対応します。各Transformは、/DS2/HC/HandSkeletonと同じ右手系のmodel-rooted空間で表されます。位置はwristを原点とするセンサーの中心位置で、回転はセンサーのローカル座標系からmodel-rooted空間への向きです。

レコードの構成（片手ごとに39フィールド）：

string id, int is_left,
int generated_at_ms_hi, int generated_at_ms_lo,
float[35]  # 5 sensors × (p_x, p_y, p_z, q_w, q_x, q_y, q_z)

transforms[i]はRawSensorIndex(i)に対応します（5要素。親指、人差し指、中指、薬指、小指の順）。

パブリック属性見出しへのリンクをコピー

RawSensorData.id見出しへのリンクをコピー

id: str = ""

グローブID

RawSensorData.is_left見出しへのリンクをコピー

is_left: bool = False

左手かどうか

RawSensorData.timestamp_ms見出しへのリンクをコピー

timestamp_ms: int = 0

フレームが生成された時刻（Unix時間、ミリ秒）

RawSensorData.transforms見出しへのリンクをコピー

transforms: list[Transform] = [Transform(position=Vec3(x=0.0, y=0.0, z=0.0), rotation=Quaternion(w=1.0, x=0.0, y=0.0, z=0.0)), ...]  # 5 elements

センサーごとの位置と回転（片手5要素）。インデックスはRawSensorIndexを参照してください

RetargetProfileInfo見出しへのリンクをコピー

from contactglovesdk import RetargetProfileInfo

リターゲットプロファイルの情報を運ぶ応答を保持するデータクラス。

OSCアドレス/DS2/HC/HandSkeleton/Profileから受信したデータに対応します。 statusは0（存在する）、1（UUIDは有効だが該当するプロファイルが存在しない）、2（不正な問い合わせ）のいずれかです。

パブリック属性見出しへのリンクをコピー

RetargetProfileInfo.request_id見出しへのリンクをコピー

request_id: int = 0

リクエストとその応答を対応付ける、クライアントが指定した値

RetargetProfileInfo.profile_uuid見出しへのリンクをコピー

profile_uuid: str = ""

リターゲットプロファイルのUUID（statusによります）

RetargetProfileInfo.status見出しへのリンクをコピー

status: int = 0

プロファイル情報の取得結果（0、1、2）

RetargetProfileInfo.name見出しへのリンクをコピー

name: str = ""

ユーザーに表示するプロファイル名

RetargetProfileInfo.description見出しへのリンクをコピー

description: str = ""

プロファイルの説明

Transform見出しへのリンクをコピー

from contactglovesdk import Transform

位置と回転を組み合わせたTransform

RawSensorData.transformsの各要素として使われます。

パブリック属性見出しへのリンクをコピー

Transform.position見出しへのリンクをコピー

position: Vec3 = Vec3(x=0.0, y=0.0, z=0.0)

位置

Transform.rotation見出しへのリンクをコピー

rotation: Quaternion = Quaternion(w=1.0, x=0.0, y=0.0, z=0.0)

回転

Vec3見出しへのリンクをコピー

from contactglovesdk import Vec3

3次元ベクトル

パブリック属性見出しへのリンクをコピー

Vec3.x見出しへのリンクをコピー

x: float = 0.0

X成分

Vec3.y見出しへのリンクをコピー

y: float = 0.0

Y成分

Vec3.z見出しへのリンクをコピー

z: float = 0.0

Z成分

Quaternion見出しへのリンクをコピー

from contactglovesdk import Quaternion

回転を表すクォータニオン

パブリック属性見出しへのリンクをコピー

Quaternion.w見出しへのリンクをコピー

w: float = 1.0

スカラー成分

Quaternion.x見出しへのリンクをコピー

x: float = 0.0

X成分

Quaternion.y見出しへのリンクをコピー

y: float = 0.0

Y成分

Quaternion.z見出しへのリンクをコピー

z: float = 0.0

Z成分

ContactGloveSDKError見出しへのリンクをコピー

from contactglovesdk import ContactGloveSDKError

class ContactGloveSDKError(Exception)

SDKが発生させる例外の基底クラス

SDKNotAvailableError見出しへのリンクをコピー

from contactglovesdk import SDKNotAvailableError

class SDKNotAvailableError(ContactGloveSDKError)

ローカルのUDPソケットを開けなかったとき（ポートが使用中の場合など）に発生します

NotConnectedError見出しへのリンクをコピー

from contactglovesdk import NotConnectedError

class NotConnectedError(ContactGloveSDKError)

接続が必要な操作を、その接続が存在しない状態で行おうとしたときに発生します

InvalidIDError見出しへのリンクをコピー

from contactglovesdk import InvalidIDError

class InvalidIDError(ContactGloveSDKError)

指定したグローブIDのデータが現在のデータストアに存在しないときに発生します