Haply Inverse SDK

Haply Inverse SDKは、言語に依存しないWebSocket + HTTPインターフェースであり、Haply のハプティックデバイス（Inverse3、Inverse3x、 Minverse,VerseGrip,Wireless VerseGrip）にアクセスできるようにします。ローカルサービスとして実行され、デバイスの探索、シリアル通信、安全監視、およびステータスのストリーミングを処理するため、アプリケーション側ではソケットを介してJSONを使用するだけで済みます。

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

• デバイスの検出と管理— HTTP REST API を通じて接続されたHaply デバイスを自動的に一覧表示し、構成します。
• リアルタイムの状態ストリーミング— WebSocketsを介して、ハプティック制御サイクル（数kHzレベル）でデバイスの状態を送信します。
• コマンド処理— 精密なハプティックフィードバックを実現するため、力および位置のコマンドを高精度で実行します。
• バックグラウンドでの動作— ローカルサービスとして実行され、ユーザーの操作を必要とせずに、デバイスをいつでも使用できる状態に保ちます。

Haply Hubのインストール

始めるのに最も簡単な方法は、**Haply Hub**です。これは、Haply デバイスのインストール、実行、設定、テスト、および監視を行うためのデスクトップアプリケーションです。ファームウェアを最新の状態に保つことができ、Inverse Serviceバンドルやデモも含まれているため、コードを書く前にハードウェアを確認することができます。

Haply

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

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

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

Hub を使用しなくても、Inverse Service の特定のバージョンをシステムサービス（Windows）またはデーモン（Linux / macOS）としてインストールすることができます。インストーラーのリンクおよび説明については、サービスの実行に関するドキュメントを参照してください。

簡単な例

サービスに接続して、最初の Inverse3 のカーソル位置を読み取り、力が 0 のキープアライブ（keepalive）を送信することで、サービスがステータスフレームのストリーミングを継続するようにします：

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(())
}

警告

力の値を変更する際はご注意ください。突然高い力の値を設定すると、装置が破損したり、予期せぬ動作が発生したりするおそれがあります。

情報

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

その他の例

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