07. 基础与架设 演练场

通过交互方式驱动设备的 mount 转换，并演示 configure.basis、configure.preset 与 configure.mount 在通信报文层面上如何协同工作。保持一个固定的基准，使交互重点始终集中在 configure 命令上。

你将学到：

• 设置 basis 轴置换（"XZY" → Y 轴方向上的应用坐标系）
• 选择 预设（arm_front），并了解它会配置哪些内容
• 在运行时通过旋转四元数（由键盘控制）覆盖mount
• 互斥规则：mount 与 preset 不能同时出现在同一个 设备配置 块中
• 一次性 configure 语义：每次按键仅发送一条 configure 消息
• （C++ Glaze）使用 std::optional 对互斥字段的建模

工作流程

1. 收到第一条消息时：发送 会话配置文件、configure.basis: "XZY" 以及 configure.preset: arm_front。为固定地面开始持续发送 set_cursor_force。
2. 每个 tick：读取光标的 Y 坐标，计算 force_y = max(0, (floor_pos - y) * stiffness) 并发送。
3. 当用户按下“mount”旋转键时，将 pending_configure = true 置位。
4. 在下一个 tick：构建一个 configure.mount 块，其变换的 rotation 单位四元数（按当前俯仰角/偏航角，先 Z 后 X 进行复合）。省略 preset——二者通信协议中互斥。
5. 重置键（R）清除覆盖设置；下次执行 configure 时将恢复为 preset。

参数

名称	默认值	用途
BASIS	"XZY"	轴置换— Y 轴方向上的应用坐标系
DEVICE_PRESET / DEVICE_CONFIG_PRESET	"arm_front"	命名的预设 — 原点位于设备底座
FLOOR_POS_Y	0.0 m	固定地面平面（应用坐标系 Y 轴）
STIFFNESS	1000 不适用	地面弹簧常数
MOUNT_STEP_DEG	10°	每次按键的旋转角度
PRINT_EVERY_MS	200	遥测节流间隔

控制

按键	操作
W / S	围绕设备沿+X轴（俯仰）旋转，旋转角度为±10°
A / D	围绕设备沿+Z轴（偏航）旋转 ±10°
R	重置挂载——恢复为默认设置
H	显示控制键
Q	退出

mount 与 preset 互斥

该服务将拒绝同时包含这两者的请求 设备配置 块。一旦用户覆盖了 mount，本教程在后续的每次 configure 中都会省略 preset。按下 R 之后，下次执行 configure 时将重新启用 preset 并去掉 mount。

不同的输入模式

C++ 变体在后台的 stdin 线程上按行读取输入（每个字母后需按 ENTER 键）。Python 则在主异步循环中使用 keyboard 对包进行实时按键轮询，无需按 ENTER 键。按键相同，命令也相同。

读取的状态字段

来源： data.inverse3[i].state：

• cursor_position.y — vec3，用于计算穿透地面的深度
• current_cursor_force — 用于遥测上报

发送 / 接收

各变体的负载结构相同；真正的区别在于每个变体如何构建互斥的 mount / preset 分支，以及输入线程如何通知 WebSocket 线程。

Python

单一异步循环，通过 keyboard 对包进行实时按键轮询。pending_configure 这是一个全局标志，由按键处理函数设置，每次发送时 configure 块后清除。

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"]
            # Handshake: profile + basis + preset
            request_msg = {
                "session": {"configure": {"profile": {"name": SLUG}}},
                "inverse3": [{
                    "device_id": device_id,
                    "configure": build_configure_block(first_handshake=True),
                    # -> {"basis": {"permutation": "XZY"},
                    #     "preset": {"preset": "arm_front"}}
                }],
            }
        else:
            handle_key_inputs()  # may set pending_configure = True (classic, not shown)

            y       = data["inverse3"][0]["state"]["cursor_position"]["y"]
            force_y = 0.0 if y > FLOOR_POS_Y else (FLOOR_POS_Y - y) * STIFFNESS

            entry = {
                "device_id": device_id,
                "commands": {"set_cursor_force":
                    {"vector": {"x": 0.0, "y": force_y, "z": 0.0}}},
            }
            if pending_configure:
                entry["configure"] = build_configure_block(first_handshake=False)
                # -> {"mount": {...}}   OR   {"preset": {...}}   (never both)
                pending_configure = False

            request_msg = {"inverse3": [entry]}

        await websocket.send(json.dumps(request_msg))

C++ (nlohmann)

双线程模型：后台 stdin 线程逐行读取输入并设置位 pending_configure（一个 std::atomic<bool>）；libhv I/O 线程会在每个 tick 检查该标志，一旦该标志被置位，便会发出 configure。

std::atomic<bool> pending_configure{false};

ws.onmessage = [&](const std::string &msg) {
    const json data = json::parse(msg);
    if (!data.contains("inverse3") || data["inverse3"].empty()) return;

    const bool do_handshake = first_message;
    if (first_message) first_message = false;
    const bool do_configure = do_handshake || pending_configure.exchange(false);

    json request = {};
    if (do_handshake) {
        request["session"] = {{"configure", {{"profile",
            {{"name", "co.haply.inverse.tutorials:basis-and-mount"}}}}}};
    }

    request["inverse3"] = json::array();
    for (auto &el : data["inverse3"].items()) {
        json dev_cmd = {{"device_id", el.value()["device_id"]}};

        if (do_configure) {
            json cfg = {};
            if (do_handshake) cfg["basis"] = {{"permutation", BASIS}};
            if (mount_overridden) {
                cfg["mount"] = {{"transform", {
                    {"position", {{"x", 0.0}, {"y", 0.0}, {"z", 0.0}}},
                    {"rotation", quat_from_xz_deg(mount_angle_x_deg, mount_angle_z_deg)},
                    {"scale",    {{"x", 1.0}, {"y", 1.0}, {"z", 1.0}}},
                }}};
            } else {
                cfg["preset"] = {{"preset", DEVICE_CONFIG_PRESET}};
            }
            dev_cmd["configure"] = cfg;
        }

        const float y = el.value()["state"]["cursor_position"]["y"].get<float>();
        const float force_y = y > FLOOR_POS_Y ? 0.0f : (FLOOR_POS_Y - y) * STIFFNESS;
        dev_cmd["commands"] = {{"set_cursor_force",
            {{"vector", {{"x", 0.0}, {"y", force_y}, {"z", 0.0}}}}}};

        request["inverse3"].push_back(dev_cmd);
    }
    ws.send(request.dump());
};
std::thread input_thr(input_thread_func);  // stdin reader — flips pending_configure
ws.open("ws://localhost:10001");
while (running.load()) std::this_thread::sleep_for(50ms);

C++ (Glaze)

互斥规则可以自然地映射到 std::optional<preset_cfg> 与 std::optional<mount_cfg> 上：在序列化后的 JSON 中，只出现那个已被赋值的值。预设名称被建模为一个 enum class，并通过 glz::meta 特化将其映射为服务器所期望的字符串。

// The preset set modelled as an enum
enum class device_preset {
    defaults, arm_front, arm_front_centered,
    led_front, led_front_centered, custom,
};

// Glaze meta — serialize the enum as the JSON string the service expects
template <> struct glz::meta<device_preset> {
    using enum device_preset;
    static constexpr auto value =
        enumerate(defaults, arm_front, arm_front_centered,
                  led_front, led_front_centered, custom);
};

// Transform + the configure block
struct vec3 { float x{}, y{}, z{}; };
struct quat { float w{1.0f}, x{}, y{}, z{}; };
struct transform_t { vec3 position{}; quat rotation{}; vec3 scale{1,1,1}; };

struct preset_cfg { device_preset preset; };
struct basis_cfg  { std::string permutation; };
struct mount_cfg  { transform_t transform; };
struct device_configure {
    std::optional<preset_cfg> preset;  // mutually exclusive with mount
    std::optional<basis_cfg>  basis;
    std::optional<mount_cfg>  mount;   // mutually exclusive with preset
};

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

    const bool do_handshake = first_message.exchange(false);
    const bool do_configure = do_handshake || pending_configure.exchange(false);

    commands_message out_cmds{};
    if (do_handshake) {
        out_cmds.session = session_cmd{ /* profile = basis-and-mount */ };
    }

    for (const auto &dev : data.inverse3) {
        device_commands dc{ .device_id = dev.device_id };

        if (do_configure) {
            device_configure cfg{};
            if (do_handshake) cfg.basis = basis_cfg{BASIS};
            if (mount_overridden) {
                cfg.mount = mount_cfg{ .transform = transform_t{
                    .rotation = quat_from_xz_deg(mount_angle_x_deg, mount_angle_z_deg)}};
            } else {
                cfg.preset = preset_cfg{DEVICE_CONFIG_PRESET};
            }
            dc.configure = std::move(cfg);
        }

        const float y = dev.state.cursor_position.y;
        const float force_y = y > FLOOR_POS_Y ? 0.0f : (FLOOR_POS_Y - y) * STIFFNESS;
        dc.commands.set_cursor_force = set_cursor_force_cmd{{0.0f, force_y, 0.0f}};
        out_cmds.inverse3.push_back(std::move(dc));
    }

    std::string out_json;
    (void)glz::write_json(out_cmds, out_json);
    ws.send(out_json);
};
std::thread input_thr(input_thread_func);
ws.open("ws://localhost:10001");
while (running.load()) std::this_thread::sleep_for(50ms);

随 SDK 安装程序一同提供

教程 07 也随 SDK 一起安装在本地——请在服务安装目录下查看 tutorials/07-haply-inverse-basis-and-mount/。

源代码： Python·C++·C++ Glaze

相关内容： Basis 轴置换 · Mount 与工作区 · 设备配置 · 控制命令（set_cursor_force） · 类型（变换） · 教程 04（Hello Floor）