Haply Inverse SDK

Haply Inverse SDK は、Haplyの触覚デバイス（Inverse3、Inverse3x、Minverse、VerseGrip、およびWireless VerseGrip）向けの、言語非依存のWebSocket + HTTPインターフェースです。デバイスの検出、シリアル通信、安全性の監視、状態のストリーミングを処理するローカルサービスとして動作するため、アプリケーションはソケット経由でJSONを用いて通信するだけで済みます。

主な機能は以下の通りです：

• デバイスの検出と管理— HTTP REST API を通じて、接続された Haply デバイスを自動的に一覧表示し、設定を行います。
• リアルタイム状態ストリーミング— WebSocket を介して、触覚制御レート（数kHz）でデバイスの状態を送信します。
• コマンド処理— 精密な触覚フィードバックを実現するため、力と位置のコマンドを高い忠実度で実行します。
• バックグラウンド動作— ローカルサービスとして実行され、ユーザーの操作を必要とせずにデバイスの準備状態を維持します。

Haply Hub でのインストール

最も簡単に始める方法は、Haply Hub を使用することです。これは、Haplyデバイスのインストール、実行、設定、テスト、監視を行うためのデスクトップアプリケーションです。ファームウェアを最新の状態に保ち、Inverse Service を同梱しており、コードを1行も書く前にハードウェアを検証できるデモも提供します。

Haply

Haply Hubの最新バージョンをダウンロードする

Hubをダウンロードしてインストールし、デバイスを接続してください。Hubがファームウェアのアップデート手順を案内します。インストール後は、Hubを開いている間、Inverse Serviceがバックグラウンドで自動的に実行されます。

スタンドアロンでのインストールをご希望ですか？

Hub を使用せずに、Inverse Service の特定のバージョンをシステムサービス（Windows）またはデーモン（Linux / macOS）としてインストールすることも可能です。インストーラーのリンクや手順については、「サービスの実行」を参照してください。

簡単な例

サービスに接続し、最初のInverse3のカーソル位置を読み取り、サービスが状態フレームのストリーミングを継続するように、強度ゼロのキープアライブを送信します：

Python

import asyncio, json, websockets

async def main():
    # Connect to the Haply Inverse service WebSocket
    async with websockets.connect("ws://localhost:10001") as ws:
        # Read the first state frame to discover the device id
        first_state = json.loads(await ws.recv())
        device_id = first_state["inverse3"][0]["device_id"]

        # Build a zero-force keepalive command targeting that device
        keepalive = {"inverse3": [{
            "device_id": device_id,
            "commands": {"set_cursor_force": {"vector": {"x": 0, "y": 0, "z": 0}}}
        }]}

        # Realtime loop: one send per tick, then read the resulting state
        while True:
            await ws.send(json.dumps(keepalive))
            state = json.loads(await ws.recv())
            pos = state["inverse3"][0]["state"]["cursor_position"]
            print(f"pos: {pos}")

asyncio.run(main())

JavaScript（Node）

import WebSocket from 'ws'

// Connect to the Haply Inverse service WebSocket
const ws = new WebSocket('ws://localhost:10001')
let keepalive

ws.on('message', (msg) => {
  const state = JSON.parse(msg)
  if (!keepalive) {
    // Read the first state frame to discover the device id
    const deviceId = state.inverse3[0].device_id
    // Build a zero-force keepalive command targeting that device
    keepalive = JSON.stringify({
      inverse3: [
        {
          device_id: deviceId,
          commands: { set_cursor_force: { vector: { x: 0, y: 0, z: 0 } } },
        },
      ],
    })
    ws.send(keepalive)
    return
  }
  // Realtime loop: one send per tick, then read the resulting state
  ws.send(keepalive)
  console.log('pos:', state.inverse3[0].state.cursor_position)
})

C++ (nlohmann)

#include <external/libhv.h>
#include <nlohmann/json.hpp>

int main() {
    hv::WebSocketClient ws;
    nlohmann::json keepalive;

    ws.onmessage = [&](const std::string& msg) {
        auto state = nlohmann::json::parse(msg);
        if (keepalive.is_null()) {
            // Read the first state frame to discover the device id
            auto device_id = state["inverse3"][0]["device_id"];
            // Build a zero-force keepalive command targeting that device
            keepalive = {{"inverse3", nlohmann::json::array({{
                {"device_id", device_id},
                {"commands", {{"set_cursor_force",
                    {{"vector", {{"x", 0}, {"y", 0}, {"z", 0}}}}}}}
            }})}};
            ws.send(keepalive.dump());
            return;
        }
        // Realtime loop: one send per tick, then read the resulting state
        ws.send(keepalive.dump());
        auto pos = state["inverse3"][0]["state"]["cursor_position"];
        std::cout << "pos: " << pos << "\n";
    };
    // Connect to the Haply Inverse service WebSocket
    ws.open("ws://localhost:10001");
    std::cin.get();
}

C++（最適化）

コンパイル時のリフレクションには、Glazeを使用します。これは、世界で最も高速な JSON ライブラリの一つです。触覚レート（数 kHz）では、JSON の解析に費やされる 1 マイクロ秒が、そのまま制御ループから奪われる 1 マイクロ秒となるため、この点は重要です。読み書きする最小限の形状のみを宣言してください。それ以外は無視されます。

#include <external/libhv.h>
#include <glaze/glaze.hpp>

struct vec3 { float x{}, y{}, z{}; };
struct inverse_state { vec3 cursor_position; };
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 device_cmd { std::string device_id;
    struct { std::optional<set_cursor_force_cmd> set_cursor_force; } commands; };
struct commands_message { std::vector<device_cmd> inverse3; };

int main() {
    hv::WebSocketClient ws;
    commands_message keepalive;
    ws.onmessage = [&](const std::string& msg) {
        devices_message state{};
        if (glz::read_json(state, msg)) return;
        if (keepalive.inverse3.empty()) {
            // Read the first state frame to discover the device id
            auto device_id = state.inverse3[0].device_id;
            // Build a zero-force keepalive command targeting that device
            keepalive.inverse3.push_back({device_id});
            keepalive.inverse3[0].commands.set_cursor_force = set_cursor_force_cmd{};
            std::string out; (void)glz::write_json(keepalive, out);
            ws.send(out);
            return;
        }
        // Realtime loop: one send per tick, then read the resulting state
        std::string out; (void)glz::write_json(keepalive, out);
        ws.send(out);
        printf("pos: %f %f %f\n", state.inverse3[0].state.cursor_position.x,
               state.inverse3[0].state.cursor_position.y,
               state.inverse3[0].state.cursor_position.z);
    };
    // Connect to the Haply Inverse service WebSocket
    ws.open("ws://localhost:10001");
    std::cin.get();
}

Rust

tokio-tungstenite + serde_json を使用した説明用の例です。

use futures_util::{SinkExt, StreamExt};
use serde_json::json;
use tokio_tungstenite::{connect_async, tungstenite::Message};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    // Connect to the Haply Inverse service WebSocket
    let (mut ws, _) = connect_async("ws://localhost:10001").await?;

    // Read the first state frame to discover the device id
    let first = match ws.next().await {
        Some(Ok(Message::Text(m))) => m,
        _ => anyhow::bail!("no initial state frame"),
    };
    let first_state: serde_json::Value = serde_json::from_str(&first)?;
    let device_id = first_state["inverse3"][0]["device_id"].as_str().unwrap();

    // Build a zero-force keepalive command targeting that device
    let keepalive = json!({
        "inverse3": [{
            "device_id": device_id,
            "commands": { "set_cursor_force": { "vector": { "x": 0, "y": 0, "z": 0 } } }
        }]
    }).to_string();

    // Realtime loop: one send per tick, then read the resulting state
    loop {
        ws.send(Message::Text(keepalive.clone())).await?;
        let msg = match ws.next().await {
            Some(Ok(Message::Text(m))) => m,
            _ => break,
        };
        let state: serde_json::Value = serde_json::from_str(&msg)?;
        println!("pos: {}", state["inverse3"][0]["state"]["cursor_position"]);
    }
    Ok(())
}

警告

力の値を変更する際は、十分にご注意ください。急激に大きな力の値を設定すると、デバイスが破損したり、予期せぬ動作を引き起こしたりする可能性があります。

備考

メッセージのエンベロープ、ポート、コンテンツタイプに関する規則については、JSON の仕様ページを参照してください。

その他の例

Python、C++（nlohmann）、C++（Glaze）で作成された、力フィードバック、位置制御、複数デバイス構成、マウント／ベース設定、イベントストリーミングを扱う高機能なチュートリアルについては、チュートリアルページをご覧ください。