パラメータ一覧
このドキュメントには、エンドポイントから返されるすべてのパラメータが記載されています /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
}
タイプの対応関係
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 HTTP API のポート(デフォルト 10000). |
communication/websocket/port | int | 起動 | バージョン 3.1 の WebSocket のメインポート(デフォルト 10001). |
communication/websocket/legacy_port | int | 起動 | バージョン3.0から引き継がれたWebSocketポート(デフォルト 10000). |
communication/events/port | int | 起動 | イベントストリームの WebSocket ポート(デフォルト 10020). |
devices/…
devices/detection/…
シリアルポートのスキャンポリシー。すべての項目は上級者向けです。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
devices/detection/scan_period_ms | int | 範囲 100~10000;開始 | 2回のシリアルポートスキャン間の間隔(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 ファミリーの各デバイスに適用されるグローバルなデフォルト設定。各セッション固有の置換設定が優先されます。
| 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/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.
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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/…
末端アームの動作用速度制限装置。
| 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 Hubのペアリングインターフェースに電力を供給します。
| 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、ホールセンサーをバイパスして(ハードウェア故障時の回避策)。 |
serialization/…
変換結果の出力形式 — WebSocket および HTTP JSON のペイロードが対象です。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
serialization/explicit_fields | bool | — | デフォルトのアイデンティティ値と等しい値を持つ変換フィールドを、シリアライズされた出力に含める(例: position: {0,0,0}, rotation: {w:1,…}). クライアントが各フィールドを明示的に指定することを要求する場合に便利です。デフォルト値: false. |
serialization/force_complete_transforms | bool | — | 常に送信する position, rotation et scale 各変換出力において、方向調整機能のみを備えたデバイス(Verse Grip、Wireless Verse Grip)を含め、それ以外では rotation. Englobe serialization/explicit_fields. デフォルト値: false. |
session/…
セッションプランナーおよびコマンドパイプラインの制限事項。
| Clé | タイプ | 制約 | 説明 |
|---|---|---|---|
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のロット全体が拒否された場合でも。 |