01. Inverse3の出力

シミュレーションのWebSocketに接続し、サービスから報告される最初のInverse3から、カーソルの位置、速度、および力をストリーミングします。

学習内容：

• WebSocket接続を開き、初期の完全な状態メッセージを受信すること
• ゼロ力のset_cursor_forceキープアライブを送信し、セッションを維持し続けること
• Haply Hubがシミュレーションを認識できるように、セッションプロファイルを登録すること
• 最初のメッセージのみでハンドシェイクを行うパターン — 最初の送信後に session/configure を削除すること
• 部分更新のセマンティクスにおいて、ワークスペースの transform（位置、回転、スケール）を読み取る
• コンソール出力を読みやすい頻度に抑えること

ワークフロー

1. ws://localhost:10001 WebSocket接続を開きます。サービスは直ちに、接続されているデバイスの一覧を完全な状態のフレームを送信します。
2. 最初のフレームで、最初のInverse3の device_id を取得し、2つの部分からなるリクエストメッセージを作成します：
   • session.configure.profile.name — シミュレーションをHaplyに登録します。
   • ゼロベクトルを指定した、デバイスごとのset_cursor_forceコマンド。サービスはこれをキープアライブとして使用します。コマンドが継続して受信されている限り、ステータスフレームの送信を続けます。
3. メッセージを返信します。次のティックが始まる前に session フィールドを削除してください。セッションプロファイルは1回限りのハンドシェイクであり、それ以降のティックではコマンドのみを送信します。
4. 以降の各状態フレームごとに、カーソルのvec3フィールド（位置、速度、力）を約10 Hzに抑えて出力し、ゼロ力のキープアライブを再送信します。

パラメーター

名前	デフォルト	用途
URI	ws://localhost:10001	シミュレーションチャネルのWebSocket URL
PRINT_EVERY_MS	100	コンソール出力の抑制間隔
セッションプロファイル名	co.haply.inverse.tutorials:print-inverse3	Haply Hub内でこのシミュレーションを識別します

読み取り状態フィールド

data.inverse3[0].state 以下から読み取ります:

• cursor_position、cursor_velocity、current_cursor_force — いずれもvec3
• transform — ワークスペースの変換。サブオブジェクトとして position（vec3）、rotation（quaternion）、scale（vec3）を持っています

部分更新のセマンティクス

恒等値（単位元）のデフォルト値（position: {0,0,0}、rotation: {w:1,x:0,y:0,z:0}、scale: {1,1,1}）と等しいサブフィールドは、帯域幅を節約するため、ペイロードから省略されます。読み取り時には必ずデフォルト値を指定してください（例：C++では .value("position", default_pos)、Pythonでは .get("position", default_pos)）。すべてのフィールドを常に受信するには、serialization/explicit_fieldsを有効にしてください。

送受信

WebSocketのループでは、ステートフレームを受信し、コマンドフレームを作成して返送します。最初のコマンドフレームには、セッションのハンドシェイクとゼロフォースのset_cursor_force「キープアライブ」が含まれます。以降のフレームには「キープアライブ」のみが含まれます（セッションは削除されます）。

Python

単一の非同期ループです — recv() → コマンドを作成 → send() → 繰り返し。

async with websockets.connect(URI) as websocket:
    while True:
        msg  = await websocket.recv()
        data = json.loads(msg)

        if first_message:
            first_message = False
            device_id = data["inverse3"][0]["device_id"]
            request_msg = {
                "session": {"configure": {"profile": {
                    "name": "co.haply.inverse.tutorials:print-inverse3"}}},
                "inverse3": [{
                    "device_id": device_id,
                    "commands": {"set_cursor_force":
                        {"vector": {"x": 0.0, "y": 0.0, "z": 0.0}}},
                }]
            }

        await websocket.send(json.dumps(request_msg))
        request_msg.pop("session", None)  # one-shot handshake

C++ (nlohmann)

libhvは、独自のI/OスレッドでWebSocketを処理します。フレームごとの処理は ws.onmessage 内部に実装されています。メインスレッドは、ENTERキーが押されるまで単にブロックするだけです。

ws.onmessage = [&](const std::string &msg) {
    const json data = json::parse(msg);

    if (first_message) {
        first_message = false;
        device_id = data["inverse3"][0].at("device_id").get<std::string>();
        request_msg = {
            {"session", {{"configure", {{"profile",
                {{"name", "co.haply.inverse.tutorials:print-inverse3"}}}}}}},
            {"inverse3", json::array({
                {{"device_id", device_id},
                 {"commands", {{"set_cursor_force",
                   {{"vector", {{"x", 0.0}, {"y", 0.0}, {"z", 0.0}}}}}}}},
            })},
        };
    }

    ws.send(request_msg.dump());
    request_msg.erase("session");  // one-shot handshake
};
ws.open("ws://localhost:10001");
while (std::cin.get() != '\n') {}  // block main thread

C++ (Glaze)

nlohmannバリアントと同じlibhvのコールバックモデルです。異なるのは本体部分のみです。Glazeはコンパイル時のリフレクションを使用します。JSONの構造を反映した構造体を宣言し、glz::read / glz::write_json を呼び出します。std::optional<session_cmd> 一度限りのハンドシェイクを保持します。設定されていない場合、GlazeはシリアライズされたJSONからそのフィールドを省略します。

// Struct models
struct vec3 { float x{}, y{}, z{}; };
struct inverse_state {
    vec3 cursor_position{}, cursor_velocity{}, current_cursor_force{};
    /* + body_orientation, angular_position, angular_velocity */
};
struct inverse_device { std::string device_id; inverse_state state; };
struct devices_message { std::vector<inverse_device> inverse3; };

struct set_cursor_force_cmd { vec3 vector; };
struct commands_message {
    std::optional<session_cmd> session;  // omitted from JSON when unset
    std::vector<device_commands> inverse3;
};

// Send / receive
ws.onmessage = [&](const std::string &msg) {
    devices_message data{};
    if (glz::read<glz_settings>(data, msg)) return;

    commands_message out_cmds{};
    if (first_message) {
        first_message = false;
        out_cmds.session = session_cmd{ /* profile = print-inverse3 */ };
    }
    // ... populate out_cmds.inverse3 with zero-force keepalive ...

    std::string out_json;
    (void)glz::write_json(out_cmds, out_json);
    ws.send(out_json);
};
ws.open("ws://localhost:10001");
while (std::cin.get() != '\n') {}  // block main thread

コマンドライン引数（Python）

Python バリアントでは、チュートリアルの出力を変更するための 2 つのフラグを指定できます。

フラグ	効果
--full	1行の要約ではなく、各状態フレームの生のJSONペイロードを整形して出力します。サービスが送信するフィールドを確認する際に便利です。
--query-config	各ティックを送信する際に session.force_render_full_state: {} を追加し、サービスが毎フレーム完全なスナップショット（config ブロック（デバイスタイプ、ファームウェア、プリセット、マウント、フィルターなどを含む）を再送信するようにします。このフラグがない場合、config は最初のフレームでのみ送信され、それ以降のフレームはストリーミングの差分となります。

両方のフラグは組み合わせて使用できます。python 01-haply-inverse-print-inverse3.py --full --query-config を実行すると、毎ティック config が表示された完全なJSONペイロードが出力されます。これは、Haply Hub または HTTP API から設定の変更をリアルタイムで確認する際に便利です。基礎となるWebSocketコマンドについては、session.force_render_full_state を参照してください。

C++バリアントでは、これらのフラグは提供されていません。常に1行の要約を出力し、config は最初のフレームでのみ受信します。

SDKインストーラーに同梱

チュートリアル01も、SDKと一緒にローカルにインストールされています。サービスのインストールディレクトリ配下の tutorials/01-haply-inverse-print-inverse3/ ご確認ください。

出典: Python·C++·C++ Glaze

関連： WebSocket プロトコル ・ 制御コマンド（set_cursor_force） ・ セッション ・ 型（vec3）