跳至主要内容
版本:3.5.x

01. 打印Inverse3

连接到模拟 WebSocket,并从服务报告Inverse3 第一个Inverse3 流式传输光标位置、速度和力。

您将学到:

  • 建立 WebSocket 连接并接收初始完整状态消息
  • 发送零力 set_cursor_force 使用 keepalive 保持会话活跃
  • 注册会话配置文件,以便Haply 识别您的模拟
  • 仅首条消息的握手模式——在首次发送后移除会话/配置
  • 读取工作区 transform (位置、旋转、缩放)采用部分更新语义
  • 将控制台输出限制在可读的速度

工作流程

  1. 打开一个 WebSocket 连接至 ws://localhost:10001该服务会立即推送一个 全状态帧 列出已连接的设备。
  2. 在第一个帧中,选择第一个Inverse3 device_id 并构建一个包含两部分的请求消息:
    • session.configure.profile.name — 将模拟注册到 Haply Hub.
    • 按设备计 set_cursor_force 带有零向量的命令。该服务将其用作保持活动机制——只要持续收到命令,它就会不断发送状态帧。
  3. 将消息发回去。 剥去 session 领域 在下一次心跳之前——会话配置文件是一次性握手;后续心跳仅发送命令。
  4. 每个后续状态帧:打印光标 vec3 字段(位置、速度、力),采样率限制在约10 Hz,并重新发送零力保持信号。

参数

名称默认目的
URIws://localhost:10001模拟通道 WebSocket URL
PRINT_EVERY_MS100控制台输出节流阀
会话配置文件名称co.haply.inverse.tutorials:print-inverse3在Haply 中标识此模拟

读取状态字段

来自 data.inverse3[0].state:

  • cursor_position, cursor_velocity, current_cursor_forcevec3 每个
  • transform — 工作区变换;包含 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 保持活动;每个后续帧都携带 保持连接(已移除会话信息)。

单个异步循环 — 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

命令行选项(Python)

该 Python 变体接受两个参数来更改教程的输出内容:

旗帜效果
--full将每个状态帧的原始 JSON 有效载荷以可读格式呈现,而非仅显示一行摘要。这有助于发现服务发出的字段。
--query-config重新注入 session.force_render_full_state: {} 在每次出站请求时,该服务都会重新发送一个完整的快照(包括 config block — 设备类型、固件、预设、安装、滤波器等)在每个帧上。如果没有它, config 仅在第一个帧到达,后续帧均为增量流。

这两面旗帜结合在一起—— python 01-haply-inverse-print-inverse3.py --full --query-config 输出完整的 JSON 有效载荷,其中包含 config 在每个时间步长中都能看到,这在通过Haply 或 HTTP API 实时观察设置变化时非常方便。参见 session.force_render_full_state 用于底层的 WebSocket 命令。

C++ 版本不会显示这些标志——它们总是打印一行摘要,并接收 config 仅在第一帧。

随 SDK 安装程序一起发布

教程 01 也会随 SDK 一起安装在本地——请查看 tutorials/01-haply-inverse-print-inverse3/ 位于服务安装目录下。

来源: Python·C++·C++ Glaze

相关: WebSocket 协议 · 控制命令 (set_cursor_force) · 会话 · 类型 (vec3)