設定の参照
このドキュメントでは、エンドポイントによって使用されるすべての設定を一覧表示しています。 /settings/ 返却される、その シュルッセル, 彼女の タイプ (出典： type_hint) およびそれらの 制限事項 (出典： metadata.constraint.range + locked（該当する場合）。
Eine 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オブジェクト、設定キーを上書き値にマッピングするものです。キーは、HTTPルートによって指定された有効な設定キーでなければなりません。 /settings/ 返却される（参照： 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、つまり「advanced」とマークされた設定を含めるため、そして ?deprecated=true、古いエイリアスを含めるためです。非表示の設定は内部使用のために予約されており、以下の場合にのみ表示されます。 misc/hidden_settings über POST /settings/misc/hidden_settings が設定されます（これに対応するクエリパラメータはありません）。フィルタフラグは「AND」で結合されます。つまり、 advanced als auch hidden とマークされているものは、両方のゲートが開いている必要があります。既知のキーに対するPOSTおよびDELETEは、ゲートによる制限を受けません。
個々のキーに対する読み取りアクセス（GET /settings/<key>) 正確な正規キーを使用すれば、Advanced/Deprecated-Gate を回避できます。これは、事前知識を持つクライアントにとって便利です。非表示のキーは引き続きロックされたままとなります。
3つの実行時間スイッチがゲートを初期化します。これらの値は、サービスの存続期間全体を通じて維持されます：
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
misc/advanced_settings | bool | — | Als advanced [ ] にマークされた設定 GET /settings- 音声をオンにする（標準） false). これは、以下の引数渡しに相当します。 ?advanced=true お問い合わせのたびに。 |
misc/deprecated_settings | bool | — | Als 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、およびイベントストリームサーバー用のネットワークポートとバインドアドレス。ほとんどのエントリは、起動時にのみ適用されます。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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 | スタート | WebSocket v3.1 のメインポート（標準 10001). |
communication/websocket/legacy_port | int | スタート | WebSocket v3.0 のレガシーポート（標準 10000). |
communication/events/port | int | スタート | WebSocket イベントストリームのポート (標準 10020). |
devices/…
devices/detection/…
シリアルポートのスキャンに関するガイドライン。すべてのエントリは「拡張」としてマークされています。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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 | 検出エラーが再度記録されるまでの遅延時間（s）。 |
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 ファミリーのすべてのデバイスに適用されるグローバルなデフォルト値です。セッションごとの上書き設定が優先されます。
3.5.0 では、テンプレートは次のようになっていました。 devices/inverse*/…; 業界をリードする * 今、直面しているのは inverse. 3.5.1 では、旧形式の構成ファイルは正しく読み込まれなくなりました。修正してください。キー自体については、それ以外は変更されていません。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
devices/*inverse/filters/force_scale/gain | float | 範囲 0.0～2.0 | すべてのデバイスに適用される、出力値のグローバルな乗数です。 |
devices/*inverse/filters/force_gate/gain | float | 範囲 0.0～1.0 | 新しいセッションにおけるKraft-Gateの標準増幅。 |
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
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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 | ロックがトリガーされた後、ロック状態が維持される時間（ms）。 |
features/navigation/bubble/…
バブルナビゲーションモジュールのデフォルト値 — 以下の場合にセッションに渡されます。 bubble- 挙動が初めて有効になる。各フィールドの実行時セマンティクスについては、以下のページをご覧ください。 ナビゲーションモジュール.
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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| unter collision_threshold × this 落ちる。 1.0 ヒステリシスを無効にします。 |
features/navigation/bubble/avatar_boundary_enabled | bool | — | 設定されたSDF形状に対するアバターの空間位置 avatar_boundary 制限する。 |
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/…
Signed-Distance-Fields（SDF HFX）に基づくハプティック効果モジュール。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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 | 力がゼロになった後の自動スキャン開始までの遅延（s）。 |
features/verse_grip_pairing/…
Inverse3 と（有線または無線の）Verse Gripとの間の取り付けおよび取り外しの記録。Haply Hubの接続インターフェースの基礎となる。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | 「取り付け・取り外しの連動および検出」を有効にする。 |
features/verse_grip_pairing/hall_threshold_vg | int | 範囲 1～32 | Hall-Pegel：VerseGrip（有線）から先が接続済みとみなされます。 |
features/verse_grip_pairing/hall_threshold_wvg | int | 範囲 1～32 | VerseGrip（ワイヤレス）から先を「Hall-Pegel」とみなす。 |
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/…
Transformの出力のフォーマット — WebSocketおよびHTTP JSONのペイロードが対象です。これらのキーは、バージョン3.5.1で serialization/* nach session/serialization/* セッションごとの適用範囲を反映させるため、移動されました。旧パスは、引き続き旧式のエイリアスを介して解決されます。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
session/serialization/explicit_fields | bool | — | 同一性デフォルト値に一致するトランスフォーム・フェルダーを、シリアライズされた出力に含める（例： position: {0,0,0}, rotation: {w:1,…}). クライアントが各フィールドを明示的に指定することを要求している場合に便利です。デフォルト： false. |
session/serialization/force_complete_transforms | bool | — | イマー position, rotation und scale すべてのTransform出力で出力する。これは、向きのみを検出するデバイス（Verse Grip、Wireless Verse Grip）の場合でも同様であり、それ以外では単に rotation 出力する。終了 session/serialization/explicit_fields ein. 標準： false. |
serialization/explicit_fields (旧版) | bool | — | 代わりに、以下を使用してください session/serialization/explicit_fields. 読み取りおよび書き込みアクセスは、カノニカルキーに対して透過的に転送されます。 |
serialization/force_complete_transforms (旧版) | bool | — | 代わりに、以下を使用してください session/serialization/force_complete_transforms. 読み取りおよび書き込みアクセスは、カノニカルキーに対して透過的に転送されます。 |
session/…
セッション・スケジューラ。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
session/min_simulation_rate_hz | int | 範囲 20～500 | 警告が発動されるまでの、機器のシミュレーションレートに関する最低限の許容値（Hz）。 |
rate/…
サービス・タクティング。3.5.1で導入されたもの――以下に挙げる4つ rate/websocket/*-鍵は以前、以下の場所にありました session/commands/*; 古いパスは、引き続き古いエイリアスを介して解決されます。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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 | 上級 | エーネン 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. 読み取りおよび書き込みアクセスは透過的に転送されます。 |
内部使用限定の設定
3.5.1 では、複数の設定グループが hidden 納品済みであり、社内での使用に限定されています — rate/dispatch/* (AIMD—ディスパッチレートの上限および背圧の閾値)、 session/freeform/* （行動フィンガープリント）および session/serialization/preview/* （公開前のシリアライゼーション実験。例えば、オイラー四元数の出力や、Wireless VerseGrip向けのルーティングなど）。これらは、 misc/hidden_settings 利用可能ですが、将来のマイナーバージョンで移行、名称変更、または削除される可能性があるため、クライアントの動作をこれらに依存させないでください。