設定リファレンス
このドキュメントでは、 /settings/ エンドポイントと彼らの キー, タイプ （出典： type_hint)、および 制約 （出典： metadata.constraint.range + locked （該当する場合）。
A locked 設定は 実行時は読み取り専用. 設定ファイルまたは Haply 設定ページですが、 システムを完全に再起動する必要があります 変更を反映させるには。これらは ブート 以下の表に。
構成
サービスの起動時に設定を上書きするための設定ファイルは、以下の場所にあります：
| プラットフォーム | 場所 |
|---|---|
| Windows | C:\ProgramData\Haply\Inverse\haply-inverse-service-config.json |
| macOS | /Library/Application Support/Haply/Inverse/haply-inverse-service-config.json |
| Linux | /etc/haply-inverse-service/haply-inverse-service-config.json |
設定ファイルは フラットなJSONオブジェクト 設定キーをマッピングして値を上書きします。キーは、 /settings/ HTTPルート（参照： APIリファレンス）。指定されていないキーについては、サービスのデフォルト値が使用されます。
たとえば、ネットワーク設定の上書き：
{
"communication/http/port": 8400,
"communication/websocket/port": 8500,
"communication/events/port": 9000,
"communication/bind_all_interfaces": true
}
型のマッピング
APIが返す型ヒントは、以下のJSON形式に対応しています：
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3（～を含むオブジェクト）{x, y, z})GENERIC→json（任意の構造化された値）
communication/…
HTTP、WebSocket、およびイベントストリームサーバー用のネットワークポートとバインドアドレス。ほとんどのエントリは起動時のみ有効です。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
communication/serial/enabled | bool | — | シリアルデバイスの通信を有効または無効にします。 |
communication/bind_address | string | ブート | HTTP サーバーおよび WebSocket サーバーがバインドする IP アドレス。 |
communication/bind_all_interfaces | bool | ブート | サーバーを 0.0.0.0 localhostの代わりに。 |
communication/http/port | int | ブート | HTTP REST API ポート（デフォルト 10000). |
communication/websocket/port | int | ブート | メイン v3.1 WebSocket ポート（デフォルト 10001). |
communication/websocket/legacy_port | int | ブート | Legacy v3.0 WebSocket ポート（デフォルト 10000). |
communication/events/port | int | ブート | イベントストリーム用 WebSocket ポート（デフォルト 10020). |
devices/…
devices/detection/…
シリアルポートのスキャンポリシー。すべてのエントリは「詳細」設定です。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
devices/detection/scan_period_ms | int | 範囲 100～10000; 起動 | シリアルポートのスキャン間隔（ミリ秒）。 |
devices/detection/handshake_timeout_s | int | 範囲 1～15 | ポートごとのハンドシェイクタイムアウト（秒）。 |
devices/detection/max_retries | int | 範囲 1～10 | ポートごとのハンドシェイク再試行の最大回数。 |
devices/detection/failure_log_delay_s | int | 範囲 1～60 | 検知失敗の再ログ記録までの遅延時間（秒）。 |
devices/detection/block_looping_ports | bool | — | ループポートが検出された場合のブロックデバイスの準備状態。 |
devices/detection/excluded_ports | json | — | 検出時にスキップするシリアルポートのパス。 |
devices/detection/additional_ports | string[] | — | 無条件にスキャンする追加のシリアルポートパス。 |
devices/detection/allowed_vendor_id_filter | string[] | — | ポートの列挙中に許可されるUSBベンダーID。 |
devices/detection/port_name_substring_filter | string[] | — | 一致させるプラットフォーム固有のポート名の部分文字列。 |
devices/detection/wireless_verse_grip_description_filter | string[] | — | ワイヤレスVerseGripの検出におけるポート記述のサブストリング。 |
devices/detection/inverse3x_description_filter | string[] | — | Inverse3xの検出におけるポート記述のサブストリング。 |
devices/detection/extra_ports （非推奨） | string[] | — | 使用 devices/detection/additional_ports その代わり、読み取りと書き込みは標準キーに透過的に転送されます。 |
devices/inverse*/…
Inverse3すべてのデバイスにグローバルなデフォルト設定が適用されます。セッションごとの上書き設定が優先されます。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
devices/inverse*/filters/force_scale/gain | float | 範囲 0.0～2.0 | すべてのデバイスにグローバルな出力増幅率が適用されます。 |
devices/inverse*/filters/force_gate/gain | float | 範囲 0.0～1.0 | 新しいセッションのデフォルトのフォースゲートゲイン。 |
devices/inverse*/control_timeout_ms | int | 範囲 50～10000 | デバイス制御ロックを解除するまでのタイムアウト時間（ミリ秒）。 |
devices/inverse*/query_orientation_on_idle | bool | — | デバイスがアイドル状態のときに、ファームウェアから本体の向きを照会する。 |
devices/presets
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
devices/presets | json | — | デバイスタイプごとのデフォルトのデバイス設定プリセット（マウント変換、基底など） inverse_arm_front_*, inverse_led_front_*, minverse_*, verse_grip_default, wireless_verse_grip_default, custom_verse_grip_default). |
devices/wireless_verse_grip/…
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
devices/wireless_verse_grip/battery/low_threshold | int | — | バッテリー残量がこの値を下回ると、バッテリー残量低下の警告が表示される。 |
devices/wireless_verse_grip/battery/critical_threshold | int | — | バッテリー残量がこの値を下回ると、バッテリー残量低下の警告が発動します。 |
devices/wireless_verse_grip/battery/reset_margin | int | — | バッテリー警告が解除されるまでのヒステリシスマージン。 |
devices/wireless_verse_grip/filters/orientation_filter | json | ブート | ワイヤレスVerseGripの向きに対応した1ユーロフィルター設定。 |
features/…
features/calibration/…
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/calibration/hall_threshold | int | 範囲 1～32 | キャリブレーション中にペンが装着されているとみなされるホールセンサーのレベル。 |
features/grip_hook/…
グリップフックの自動動作 — グリップを垂直に保持している間、カーソルの位置を固定します。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/grip_hook/enabled | bool | — | グリップを垂直に保持したときに、グリップフックの自動ロックを有効にする。 |
features/grip_hook/use_hall | bool | — | グリップの検出には、姿勢情報ではなくホールセンサーの閾値を使用してください。 |
features/grip_hook/hall | int | 範囲 1～32 | グリップロックを作動させるためのホールセンサーの閾値。 |
features/grip_hook/hold_duration | int | 範囲 10～1000 | トリガー発生後のロック保持時間（ミリ秒）。 |
features/navigation/bubble/…
バブルナビゲーションモジュールのデフォルト設定 — 以下の場合にセッションに渡される bubble まず、その動作が有効化されます。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | バブルの中心位置（デフォルト）。 |
features/navigation/bubble/max_velocity | float | — | 速度ゾーンにおける最大航行速度（m/s）。 |
features/navigation/bubble/velocity_zone_width | float | — | 気泡表面の外側にある速度領域の幅（m）。 |
features/navigation/bubble/reset_velocity_on_entry | bool | — | カーソルがバブルに入ったときに、速度をゼロにリセットする。 |
features/navigation/bubble/spring_inner | float | — | 気泡中心におけるばね定数（N/m）。 |
features/navigation/bubble/spring_surface | float | — | 気泡表面におけるばね定数（N/m）。 |
features/navigation/bubble/spring_outer | float | — | 外縁におけるばね定数（N/m）。 |
features/navigation/bubble/damping_inner | float | — | 気泡中心における減衰係数（Ns/m）。 |
features/navigation/bubble/damping_surface | float | — | 気泡表面における減衰係数（Ns/m）。 |
features/navigation/bubble/damping_outer | float | — | 外縁における減衰係数（Ns/m）。 |
features/navigation/bubble/wall_stiffness | float | — | 外境界における硬い壁の剛性（N/m）。 |
features/navigation/bubble/bump_width | float | — | 気泡表面の触知可能な隆起の幅（m）。 |
features/navigation/bubble/bump_stiffness | float | — | 気泡表面の触覚突起の剛性（N/m）。 |
features/safe_trajectory/…
エンドエフェクタの動きに対する速度制限装置。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | 安全軌道速度制限機能を有効にしてください。 |
features/safe_trajectory/max_vel | float | 範囲 0.01～2.0 | エンドエフェクタの最大許容速度（m/s）。 |
features/screensaver/…
Inverse3 で、セッションが実行されていない場合に再生されるアイドルアニメーション。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/screensaver/enabled | bool | — | Inverse3 で、アイドル時のスクリーンセーバーアニメーションを有効にします。 |
features/screensaver/speed | float | 範囲 0.001～0.2 | スクリーンセーバーのアニメーション速度。 |
features/screensaver/distracted_speed | float | 範囲 0.001～0.2 | ユーザーが近くにいるが、操作を行っていない場合のアニメーション速度。 |
features/sdf/…
署名付き距離場ハプティック効果モジュール（SDF HFX）。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/sdf/enabled | bool | — | SDFのhaptic-effectsモジュールを有効または無効にします。 |
features/sdf/state_output | bool | — | デフォルトで、デバイス出力ペイロードにSDFステートを含める。 |
features/sdf/max_count | int | 範囲 0～128 | 有効なSDFエフェクトの最大数（0 = 無制限）。 |
features/sdf/events/created | bool | — | 新しいSDFエフェクトが作成されたときにイベントを発行します。 |
features/sdf/events/deleted | bool | — | SDFエフェクトが削除されたときにイベントを発行します。 |
features/sdf/events/updated | bool | — | SDFエフェクトが更新されたときにイベントを発行します。 |
features/sdf/probe_on_zero_force/enabled | bool | — | 作用する力がゼロに近い場合、SDFフィールドを自動でプローブする。 |
features/sdf/probe_on_zero_force/delay | float | 範囲 0.001～60.0 | 電圧がゼロになった後の自動プローブ開始までの遅延時間（秒）。 |
features/verse_grip_pairing/…
Inverse3 （有線または無線の）Verse Grip間のトラッキング機能を有効化／無効化します。Haply HubのペアリングUIを動作させます。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | ペアリング／接続・切断の追跡を有効にする。 |
features/verse_grip_pairing/hall_threshold_vg | int | 範囲 1～32 | 有線VerseGripが接続されているとみなされるホールレベル。 |
features/verse_grip_pairing/hall_threshold_wvg | int | 範囲 1～32 | Wireless VerseGripが装着されているとみなされるホールレベル。 |
features/verse_grip_pairing/detach_debounce_ms | int | 範囲 0～1000 | デタッチを実行する前にデバウンスを行う期間（ミリ秒）。 |
features/verse_grip_pairing/heartbeat_ms | int | 範囲 100～10000 | 強制再通知の間隔（ミリ秒）。 |
features/verse_grip_pairing/force_attached | bool | — | 添付された状態を常に true、ホールセンサーをバイパスする（ハードウェア故障時の回避策）。 |
serialization/…
トランスフォームの出力フォーマット — WebSocket および HTTP の JSON ペイロードに影響します。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
serialization/explicit_fields | bool | — | シリアライズされた出力には、そのアイデンティティ・デフォルトと等しい変換フィールドを含める（例： position: {0,0,0}, rotation: {w:1,…}). クライアントがすべてのフィールドを明示的に指定することを要求する場合に便利です。デフォルト： false. |
serialization/force_complete_transforms | bool | — | 常に送信する position, rotation, そして scale すべてのトランスフォーム出力において、通常は出力のみを行う方向情報専用デバイス（Verse Grip、Wireless Verse Grip）を含め rotation. 包含する serialization/explicit_fields. 既定値： false. |
session/…
セッションスケジューラとコマンドパイプラインの制限。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
session/min_simulation_rate_hz | int | 範囲 20～500 | 警告が発動する前の、許容される最小デバイスシミュレーションレート（Hz）。 |
session/commands/zoh_window_ms | int | — | ゼロ次ホールドウィンドウ — このウィンドウ（ms）内に受信したプローブを抑制します。 |
session/commands/drop_warning_threshold | int | — | 警告が表示されるまでのウィンドウ内でのコマンドの失敗回数。 |
session/commands/drop_warning_window_ms | int | — | 失われたコマンドをカウントするためのスライディングウィンドウのサイズ（ミリ秒）。 |
session/commands/tick_on_empty_batch | bool | — | 予約する main_loop WebSocketのバッチ全体が失われた場合でも、チェックマークが表示される。 |