設定を参照
この文書は /settings/ エンドポイントが返すすべての設定を キー, タイプ(type_hint (基準)、 制約条件(metadata.constraint.range および該当する場合 locked (基準)とともに列挙します。
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 | 起動時 | localhost の代わりに 0.0.0.0サーバーにバインドします。 |
communication/http/port | int | 起動時 | HTTP REST API ポート(デフォルト値 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/…
シリアルポートスキャンに関するポリシーです。すべての項目は詳細設定です。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
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 | — | 検出中にスキップするシリアルポートのパスです。 |
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 | デバイス制御のロックを解除するまでの制限時間(ms)です。 |
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(マウント変換(mount transform)、基底など)。 |
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の向きに関するOne Euro Filterの設定です。 |
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/max_velocity | float | — | 速度範囲における最大航行速度(m/s)です。 |
features/navigation/bubble/velocity_zone_width | float | — | これは、気泡表面の外側にある速度領域の幅(m)です。 |
features/navigation/bubble/reset_velocity_on_entry | bool | — | カーソルがバブルに入ると、速度を0にリセットします。 |
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/…
これは、符号付き距離場(Signed-distance-field)ハプティック効果モジュール(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 | — | 加わる力が0に近い場合、SDFフィールドを自動的にプローブします。 |
features/sdf/probe_on_zero_force/delay | float | 範囲 0.001~60.0 | 力が0になった後、自動プローブを開始するまでの遅延時間(秒)です。 |
features/verse_grip_pairing/…
Inverse3 および(有線または無線)Verse Grip間の接続・切断の追跡です。Haply ハブのペアリング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 | ワイヤレス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で恒久的に固定します(ハードウェア障害を回避するため)。 |
serialization/…
出力形式の変換 — WebSocket および HTTP の JSON ペイロードに影響します。
| キー | タイプ | 制約条件 | 説明 |
|---|---|---|---|
serialization/explicit_fields | bool | — | シリアル化された出力における、恒等デフォルト値のような transform フィールド(例: position: {0,0,0}, rotation: {w:1,…})も含まれます。クライアント側ですべてのフィールドが明示的に存在しなければならない場合に便利です。デフォルト値: false. |
serialization/force_complete_transforms | bool | — | 方向のみを出力するデバイス(Verse Grip、Wireless Verse Grip)を含め、すべてのトランスフォーム出力において position, rotation, そして scaleを常に含みます。これらのデバイスは、そうでなければ 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 | — | 警告が発生する前に、Windows内で実行されたコマンドの数です。 |
session/commands/drop_warning_window_ms | int | — | ドロップされたコマンドを集計するためのスライディングウィンドウのサイズ(ms)です。 |
session/commands/tick_on_empty_batch | bool | — | WebSocketのバッチ全体が破棄された場合でも main_loop ティックをスケジュールします。 |