設定の参考
このドキュメントでは、以下の内容を記載しています。 /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 | 起動時のみ | サーバーを 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 | 起動時のみ | 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 | — | 各デバイスタイプのデフォルト設定プリセット(マウント変換、basis など)は、以下を網羅しています。 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 スタイルのワイヤレス「One Euro」フィルター構成。 |
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 ナビゲーションモジュールのデフォルト値は、初回起動時に bubble 実行時にセッションに送信されます。
| キー | タイプ | 制約 | 説明 |
|---|---|---|---|
features/navigation/bubble/center | vec3 | — | バブルの中心のデフォルト位置。 |
features/navigation/bubble/max_velocity | float | — | 速度制限区域内の最大航行速度(m/s)。 |
features/navigation/bubble/velocity_zone_width | float | — | Bubble 表面外側の速度領域の幅(m)。 |
features/navigation/bubble/reset_velocity_on_entry | bool | — | カーソルが「Bubble」に入ったとき、速度をゼロにリセットします。 |
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 | — | Bubble 表面の触覚的な突起の幅(m)。 |
features/navigation/bubble/bump_stiffness | float | — | Bubble 表面の触覚的な突起の剛性(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)触覚効果モジュール(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 | 電力がゼロになった後、自動検出が始まるまでの遅延(秒)。 |
features/verse_grip_pairing/…
Inverse3 (有線または無線)Verse Grip との接続/切断の追跡。Haply ハブのペアリング画面に対応しています。
| キー | タイプ | 制約 | 説明 |
|---|---|---|---|
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 | 切断前のデバウンスウィンドウ(ミリ秒)を確認します。 |
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 | — | 零次保持ウィンドウ――このウィンドウ内で受信した検出信号を抑制する(ミリ秒)。 |
session/commands/drop_warning_threshold | int | — | ウィンドウ内で破棄されたコマンドの数がこの値に達すると、警告が発生します。 |
session/commands/drop_warning_window_ms | int | — | 破棄されたコマンドをカウントするためのスライディングウィンドウのサイズ(ミリ秒)。 |
session/commands/tick_on_empty_batch | bool | — | WebSocketのバッチ全体が破棄された場合でも、1回スケジューリングされる main_loop チェック。 |