設定の参照
このドキュメントでは、エンドポイントが持つすべての設定を一覧表示しています。 /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オブジェクト、設定キーを上書き値にマッピングするものです。キーは、 /settings/ HTTP-Route が返される(参照: 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、およびイベントストリームサーバー用のネットワークポートとバインドアドレス。ほとんどのエントリは、起動時(boot)にのみ有効です。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
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[] | — | Wireless-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 | 新しいセッションにおけるKraft-Gateの標準増幅。 |
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). |
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 | ブート | Wireless-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 | — | カーソルがバブルに入ったときに、速度をゼロにリセットする。 |
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 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 ハブのペアリングインターフェースに基づく。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
features/verse_grip_pairing/enabled | bool | — | 接続および切断の連携、あるいは検出を有効にします。 |
features/verse_grip_pairing/hall_threshold_vg | int | 範囲 1~32 | 有線版のVerseGripが接続済みとみなされるHall-Pegel。 |
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) かつ、ホールセンサーをバイパスします(ハードウェア障害時の回避策)。 |
serialization/…
変換結果のフォーマット設定 – WebSocket および HTTP JSON のペイロードが対象です。
| シュルッセル | タイプ | 制限事項 | 説明 |
|---|---|---|---|
serialization/explicit_fields | bool | — | その同一性デフォルト値に一致する変換フィールドを、シリアル化された出力に含めます(例: position: {0,0,0}, rotation: {w:1,…}). クライアントがすべてのフィールドを明示的に指定することを要求している場合に便利です。デフォルト: false. |
serialization/force_complete_transforms | bool | — | 変換結果には常に position, rotation und 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 | — | 破棄されたコマンドをカウントするための移動ウィンドウのサイズ(ms)。 |
session/commands/tick_on_empty_batch | bool | — | 植えてみよう main_loop-WebSocketバッチ全体が破棄された場合にも、このチェックボックスにチェックを入れてください。 |