01. 「Inverse3 」を出力する
シミュレーションのWebSocketに接続し、サービスが報告する最初のInverse3 のカーソル位置、速度、および力をストリーミングします。
学習内容:
- WebSocket接続の確立と初期フルステートメッセージの受信
- 強度ゼロのキープアライブを以下経由で送信する
set_cursor_force, セッションがアクティブな状態を維持できるように - Haply Hubがシミュレーションを認識できるように、セッションプロファイルを登録する
- 最初のメッセージに対するハンドシェイクパターン — 最初の送信後に「session/configure」を削除する
- ワークスペースの読み出し—
transform(位置、回転、拡大縮小)と部分更新のセマンティクス - コンソール出力を読みやすい速度に抑える
手順
- WebSocket 経由で接続してください
ws://localhost:10001. このサービスは直ちに フルステート・フレーム 接続されたデバイスと。 - 最初のフレームでは、
device_id最初のInverse3 を選択し、2つの部分からなる問い合わせメッセージを作成してください:session.configure.profile.name— シミュレーションを登録する Haply.- デバイス固有のコマンド
set_cursor_forceゼロベクトルを使用します。このサービスはこれをキープアライブとして利用しており、コマンドの受信が続く限り、ステータスフレームを送信し続けます。
- そのメッセージを返信してください。 このフィールドを削除してください
session次のサイクル前に――セッションプロファイルは1回限りのハンドシェイクであり、その後のサイクルではコマンドのみを送信する。 - それ以降の各状態フレームでは、カーソルフィールドに
vec3(位置、速度、力)を、約10 Hzに制限して出力し、力をゼロにしたキープアライブを再度送信してください。
パラメータ
| 名称 | 標準値 | Zweck |
|---|---|---|
URI | ws://localhost:10001 | シミュレーションチャンネルのWebSocket URL |
PRINT_EVERY_MS | 100 | コンソール出力の制限 |
| セッションプロファイル名 | co.haply.inverse.tutorials:print-inverse3 | Haply Hub におけるこのシミュレーションを特定します |
読み込まれた状態フィールド
Aus data.inverse3[0].state:
cursor_position,cursor_velocity,current_cursor_force— それぞれvec3transform— ワークスペース変換;サブオブジェクトとしてposition(vec3),rotation(quaternion),scale(vec3)
中立の標準値に相当するフィールド(position: {0,0,0}, rotation: {w:1,x:0,y:0,z:0}, scale: {1,1,1}), となる ペイロードから除外された、帯域幅を節約するためです。読み込む際は、必ずデフォルト値を指定してください(例: .value("position", default_pos) C++では、 .get("position", default_pos) (Pythonで)。有効にしてください serialization/explicit_fields、すべてのフィールドを常に保持するため。
送信/受信
WebSocketループ:ステータスフレームの受信、および コマンドフレーム. 最初のコマンドフレームには、セッションハンドシェイクと、強度ゼロのキープアライブが以下を通じて含まれています。 set_cursor_force; それ以降の各フレームには nur キープアライブ(セッションが削除されます)。
- Python
- C++ (nlohmann)
- C++ (Glaze)
単一の非同期ループ — 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
libhv は WebSocket を独自の I/O スレッドで制御します。各フレームごとの処理は 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
nlohmann バージョンと同じ libhv コールバックモデルですが、本体部分のみが異なります。Glaze はコンパイル時にリフレクションを利用します。JSON の構造を反映した構造体を宣言し、 glz::read / glz::write_json auf. 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 | 各ステータスフレームの生のJSONペイロードを、1行の要約ではなく、フォーマットされた形式で出力します。サービスがどのフィールドを出力しているかを確認するのに役立ちます。 |
--query-config | 各アウトバウンド・タクトごとに再度追加します session.force_render_full_state: {} ein、これにより、サービスは各フレームごとに完全なスナップショットを再度出力するようになります( config-ブロック — デバイス種別、ファームウェア、プリセット、マウント、フィルター、…)。このフラグがない場合は config 最初のフレームでのみ送信され、それ以降のフレームはストリーミング・デルタとなります。 |
どちらのフラグも組み合わせることができます — python 01-haply-inverse-print-inverse3.py --full --query-config 完全なJSONペイロードを出力し、その内容は以下の通りです。 config 各サイクルごとに表示されます。これは、Haply ハブやHTTP APIを介して設定がどのように変更されるかをリアルタイムで追跡する際に便利です。参照: session.force_render_full_state そのWebSocketコマンドに対して。
C++のバリエーションでは、これらのフラグは提供されていません。これらは常に1行の要約を出力し、 config 最初のフレームのみ。
また、チュートリアル 01 は SDK とともにローカルにインストールされています。サービスのインストールディレクトリ内の tutorials/01-haply-inverse-print-inverse3/ nach.
関連項目: WebSocketプロトコル ・ ステューアコマンド (set_cursor_force) ・ 会議 ・ 型 (vec3)