パラメータ一覧
このドキュメントでは、エンドポイントから返されるすべてのパラメータを列挙しています。 /settings/、そして彼らの clé, 彼らの タイプ （出典： type_hint) およびそれらの 制約 （出典： metadata.constraint.range そして locked（該当する場合）。
1つのパラメータ locked est 実行時には読み取り専用. 設定ファイルまたは[設定]ページから変更できます。 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
}
可視性とフィルタリング
リストの終端ポイント /settings (GET /settings, GET /settings/) はパラメータのみを返す 基本 デフォルト設定。送信してください ?advanced=true 「詳細」と指定されたパラメータを含めるため、および ?deprecated=true 廃止されたエイリアスを含めるためです。非表示のパラメータは内部使用専用であり、以下の場合にのみ表示されます。 misc/hidden_settings は、以下の方法によって定義される。 POST /settings/misc/hidden_settings （クエリパラメータとしての対応する項目は存在しません）。フィルタ条件は論理「AND」で結合されます。つまり、一度に1つのキーを指定します。 advanced et hidden この機能では、2つのフィルタの両方が解除されている必要があります。既知のキーに対するPOSTおよびDELETEリクエストは、これらのフィルタの適用対象外となります。
単一キーによる読み取り（GET /settings/<key>) 完全一致の正規キーを使用する場合、これらのキーは「advanced/deprecated」フィルターを迂回します。これは、すでにそのキーを知っているクライアントにとっては便利です。非表示のキーについては、引き続きフィルターの対象となります。
3つの実行フラグがフィルタに供給されており、それらの値はサービスの存続期間中ずっと保持されます：
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
misc/advanced_settings | bool | — | 報告されたパラメータを含みます advanced リスト内 GET /settings (デフォルト値： false). 伝達することと同義 ?advanced=true 各リクエストごとに。 |
misc/deprecated_settings | bool | — | 報告されたパラメータを含みます deprecated リスト内 GET /settings (デフォルト値： false). 伝達することと同義 ?deprecated=true 各リクエストごとに。 |
タイプの対応関係
APIから返されるタイプ情報には、以下のJSON構造が対応しています：
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3(オブジェと{x, y, z})GENERIC→json（任意の構造化値）
communication/…
HTTP、WebSocket、およびイベントストリームサーバー用のネットワークポートとリンクアドレス。ほとんどの設定項目は、起動時のみ変更可能です。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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 | ブート | REST APIのHTTPポート（デフォルト値： 10000). |
communication/websocket/port | int | ブート | v3.1のWebSocketメインポート（デフォルト値： 10001). |
communication/websocket/legacy_port | int | ブート | v3.0 から引き継がれた WebSocket ポート（デフォルト値： 10000). |
communication/events/port | int | ブート | イベントストリームの WebSocket ポート（デフォルト値： 10020). |
devices/…
devices/detection/…
シリアルポートのスキャンポリシー。すべてのエントリが先頭に移動されます。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
devices/detection/scan_period_ms | int | 範囲 100～10000；開始 | シリアルポートの分析間隔（ms）。 |
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 | — | 検出中は「Chemins des ports」シリーズを無視する。 |
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*/… バージョン 3.5.0 では、 * 「initial」は、これからは「se」の前に置かれるようになりました inverse. 旧リテラル構文を使用している設定ファイルは、バージョン 3.5.1 では認識されませんので、更新してください。なお、キー自体は変更されていません。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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 | デバイスの制御ロックが解除されるまでの残り時間（ms）。 |
devices/*inverse/query_orientation_on_idle | bool | — | デバイスが非アクティブ状態のときに、ファームウェアに本体の向きを問い合わせる。 |
devices/*inverse/safeties/expose_in_snapshot | bool | — | 各デバイス固有のセキュリティ指標をスナップショットに含める GET /devices/{id}. |
devices/presets
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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/…
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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のワイヤレス操作用「One Euro」フィルターの設定。 |
features/…
features/calibration/…
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
features/calibration/hall_threshold | int | ページ 1–32 | 校正中にスタイラスが固定されているとみなされる、ホール効果センサーのレベル。 |
features/grip_hook/…
グリップの自動動作 — ハンドルを垂直に保持している間は、スライダーをロックします。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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 | トリガー発生後のロック保持時間（ms）。 |
features/navigation/bubble/…
Bubble ナビゲーションモジュールのデフォルト値 — 動作が bubble 初めて有効化されます。以下のページをご覧ください。 ナビゲーションモジュール 各フィールドの実行時セマンティクスについて。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | バブルの中心のデフォルト位置。 |
features/navigation/bubble/center_enabled | bool | — | を適用する center バブル挙動を初めて有効にした際に設定されます。 |
features/navigation/bubble/rotation_enabled | bool | — | ワークスペースの回転をナビゲーションの方向に適用する。 |
features/navigation/bubble/scale_enabled | bool | — | ワークスペースの縮尺をナビゲーション速度に適用する。 |
features/navigation/bubble/center_drift_speed | float | ≥ 0 | センターモードにおけるドリフト速度（m/s） auto_follow. |
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/navigation/bubble/stop_at_collision | bool | — | 衝突が発生している間、バブルの中心が衝突方向へ流れないようにする。 |
features/navigation/bubble/collision_threshold | float | > 0 | 衝突が検出される外力の大きさ（N）。 |
features/navigation/bubble/collision_inflate_scale | float | ≥ 1 | 適用される乗数 velocity_zone_width 衝突が発生している間。 |
features/navigation/bubble/collision_exit_ratio | float | [0, 1]の範囲 | ヒステリシス比：衝突は、以下の条件が満たされた時点で終了する。 |ext_force| descend sous collision_threshold × this. 1.0 ヒステリシスを無効にします。 |
features/navigation/bubble/avatar_boundary_enabled | bool | — | アバターのグローバル位置をSDF形式に制限する avatar_boundary 設定済み。 |
features/safe_trajectory/…
末端アームの動作用速度制限装置。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | 安全走行速度リミッターを有効にしてください。 |
features/safe_trajectory/max_vel | float | 範囲 0.01～2.0 | 末端装置の最大許容速度（m/s）。 |
features/screensaver/…
Inverse3 端末で、セッションが実行されていない際に表示されるスクリーンセーバーの待機アニメーション。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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）。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
features/sdf/enabled | bool | — | SDFハプティックエフェクトモジュールを有効または無効にします。 |
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 ハブのペアリングインターフェースに電力を供給します。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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 | ワイヤレスVerseGripが固定されたとみなされるホール効果レベル。 |
features/verse_grip_pairing/detach_debounce_ms | int | 範囲 0～1000 | 引き出しを確定する前のリバウンド防止待ち時間（ms）。 |
features/verse_grip_pairing/heartbeat_ms | int | 範囲 100～10000 | 強制再通知の間隔（ms）。 |
features/verse_grip_pairing/force_attached | bool | — | 常に指定された状態を強制する true、ホール効果センサーをバイパスして（ハードウェアの故障時の回避策として）。 |
session/serialization/…
変換結果の出力形式 — WebSocket および HTTP JSON のペイロードに影響します。これらのキーは、 serialization/* vers session/serialization/* バージョン3.5.1では、セッションごとの適用範囲を反映させるため変更されました。以前のパスは、非推奨のエイリアスを通じて引き続き機能します。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
session/serialization/explicit_fields | bool | — | シリアル化された出力に、デフォルトのアイデンティティ値を持つ変換フィールドを含める（例： position: {0,0,0}, rotation: {w:1,…}). クライアントが各フィールドを明示的に指定することを要求する場合に便利です。デフォルト： false. |
session/serialization/force_complete_transforms | bool | — | 常に送信する position, rotation et scale 各変換出力において、方向調整機能のみを備えたデバイス（Verse Grip、Wireless Verse Grip）を含め、それ以外では rotation. 含まれるもの session/serialization/explicit_fields. デフォルト： false. |
serialization/explicit_fields (非推奨) | bool | — | 代わりに、以下を使用してください session/serialization/explicit_fields. 読み取りおよび書き込みは、カノニカルキーに対して透過的にリダイレクトされます。 |
serialization/force_complete_transforms (非推奨) | bool | — | 代わりに、以下を使用してください session/serialization/force_complete_transforms. 読み取りおよび書き込みは、カノニカルキーに対して透過的にリダイレクトされます。 |
session/…
セッションスケジューラ。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
session/min_simulation_rate_hz | int | 範囲 20～500 | 警告が発動するまでの、当該機器のシミュレーションにおける許容最低周波数（Hz）。 |
rate/…
サービスの周期。バージョン3.5.1で導入 — 4つのキー rate/websocket/* 以下は、以前は以下の下にありました session/commands/*; 古いパスは、非推奨のエイリアスのおかげで、今でも機能しています。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
rate/websocket/zoh_window_ms | int | — | ゼロの維持ウィンドウ — このウィンドウ（ms）内で受信したプローブを削除します。 |
rate/websocket/drop_warning_threshold | int | — | 警告が表示されるまでの間に、ウィンドウ内で失われた注文の数。 |
rate/websocket/drop_warning_window_ms | int | — | 失われたコマンドをカウントするために使用されるスライディングウィンドウのサイズ（ms）。 |
rate/websocket/tick_on_empty_batch | bool | avancé | 「ティック」を計画する main_loop WebSocketのロット全体が失われた場合でも。 |
session/commands/zoh_window_ms (非推奨) | int | — | 代わりに、以下を使用してください rate/websocket/zoh_window_ms. 読み取りと書き込みは透過的にリダイレクトされます。 |
session/commands/drop_warning_threshold (非推奨) | int | — | 代わりに、以下を使用してください rate/websocket/drop_warning_threshold. 読み取りと書き込みは透過的にリダイレクトされます。 |
session/commands/drop_warning_window_ms (非推奨) | int | — | 代わりに、以下を使用してください rate/websocket/drop_warning_window_ms. 読み取りと書き込みは透過的にリダイレクトされます。 |
session/commands/tick_on_empty_batch (非推奨) | bool | — | 代わりに、以下を使用してください rate/websocket/tick_on_empty_batch. 読み取りと書き込みは透過的にリダイレクトされます。 |
内部使用専用のパラメータ
いくつかのパラメータ群にマークが付けられています hidden バージョン 3.5.1 では、これらは内部使用のみに限定されています — rate/dispatch/* （AIMDの送出流量上限および背圧閾値）、 session/freeform/* （行動的特徴）および session/serialization/preview/* （プレリリース版でのシリアライゼーションの実験機能。例えば、オイラーのクォータニオン出力やWireless VerseGripのルーティングなど）。これらは以下からアクセスできます。 misc/hidden_settings デバッグ目的で用意されていますが、将来のマイナーバージョンアップでこれらの設定が昇格、名称変更、または削除される可能性があるため、クライアントの動作をこれらの設定に依存させないでください。