매개변수 참조
이 문서는 해당 엔드포인트에서 반환되는 모든 매개변수를 나열합니다. /settings/, 그리고 그들의 clé, 그들의 유형 (출처: type_hint) 및 그들의 제약 조건 (출처: metadata.constraint.range 그리고 de locked(해당되는 경우).
한 가지 매개변수 locked est 실행 시 단독으로. 이 설정은 구성 파일을 통해 또는 [설정] 페이지에서 변경할 수 있습니다. Haply Hub, 하지만 서비스를 완전히 다시 시작해야 합니다. 변경 사항이 적용되도록 하려면. 이러한 설정은 표시되어 있습니다. 부팅 아래 표에서.
구성
서비스 시작 시 매개변수를 재정의할 수 있는 구성 파일은 다음 위치에 있습니다:
| 플랫폼 | 위치 |
|---|---|
| Windows | C:\ProgramData\Haply\Inverse\haply-inverse-service-config.json |
| macOS | /Library/Application Support/Haply/Inverse/haply-inverse-service-config.json |
| 리눅스 | /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
}
가시성 및 필터링
목록의 끝점 /settings (GET /settings, GET /settings/)는 매개변수만 반환합니다 기본 기본값. 전달하십시오 ?advanced=true ‘고급’으로 표시된 매개변수를 포함하고, 그리고 ?deprecated=true 더 이상 사용되지 않는 별칭을 포함하기 위해. 숨겨진 매개변수는 내부 용도로만 사용되며, 다음의 경우에만 표시됩니다. misc/hidden_settings 다음과 같은 방법으로 정의됩니다. POST /settings/misc/hidden_settings (쿼리 매개변수 형태로 이에 상응하는 항목은 존재하지 않습니다). 필터 조건은 논리적 ‘AND’ 연산으로 결합되며, 한 번에 하나의 키만 지정할 수 있습니다. advanced et hidden 두 필터가 모두 해제되어야 합니다. 알려진 키에 대한 POST 및 DELETE 요청은 이러한 필터의 적용을 받지 않습니다.
단일 키의 읽기 작업 (GET /settings/<key>) 정확한 정규 키를 사용할 때 ‘advanced/deprecated’ 필터를 우회하므로, 이미 해당 키를 알고 있는 클라이언트에게는 편리합니다. 숨겨진 키는 여전히 필터의 적용을 받습니다.
세 개의 실행 토글이 필터에 데이터를 공급하며, 이 값들은 서비스의 전체 수명 동안 유지됩니다:
| 클레 | 유형 | 제약 조건 | 설명 |
|---|---|---|---|
misc/advanced_settings | bool | — | 보고된 매개변수 포함 advanced 목록에서 GET /settings (기본값: false). ‘전달하다’와 같은 의미 ?advanced=true 각 요청마다. |
misc/deprecated_settings | bool | — | 보고된 매개변수 포함 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 | 부팅 | REST API의 HTTP 포트(기본값: 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 | — | 탐지 시 무시할 ‘Chemins des ports’ 시리즈. |
devices/detection/additional_ports | string[] | — | 체계적으로 분석해야 할 추가적인 직렬 포트 경로. |
devices/detection/allowed_vendor_id_filter | string[] | — | 포트 열거 시 허용되는 USB 공급자 식별자. |
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*/… 3.5.0 버전에서; le * 이제 ‘se’가 앞에 오게 되었습니다 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 | 새 세션에 대한 힘 임계값 필터의 기본 이득. |
devices/*inverse/control_timeout_ms | int | 범위 50–10,000 | 기기 제어 잠금이 해제되기까지의 만료 시간 (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 무선 방향 조절용 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 | 트리거 발생 후 잠금 유지 시간 (ms). |
features/navigation/bubble/…
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 | — | 커서가 버블 안으로 들어갈 때 속도를 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/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 | plage (0,1] | 히스테리시스 보고서: 충돌은 다음 조건이 충족될 때 종료됩니다. |ext_force| descend sous 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/…
부호화된 거리 필드(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 허브의 페어링 인터페이스에 전원을 공급합니다.
| 클레 | 유형 | 제약 조건 | 설명 |
|---|---|---|---|
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–10,000 | 강제 재알림 간격 (ms). |
features/verse_grip_pairing/force_attached | bool | — | 지정된 상태를 지속적으로 강제 적용하려면 true, 홀 효과 센서를 우회하여 (하드웨어 고장 시의 우회 조치). |
session/serialization/…
변환 결과의 서식 지정 — WebSocket 및 HTTP JSON 페이로드에 적용됩니다. 이 키들은 다음 위치에서 이동되었습니다. serialization/* vers session/serialization/* 3.5.1 버전에서 세션별 적용 범위를 반영하기 위해 변경되었습니다. 이전 경로는 더 이상 사용되지 않는 별칭을 통해 여전히 작동합니다.
| 클레 | 유형 | 제약 조건 | 설명 |
|---|---|---|---|
session/serialization/explicit_fields | bool | — | 시리얼화된 출력 결과에 기본값과 동일한 변환 필드를 포함합니다(예: position: {0,0,0}, rotation: {w:1,…}). 고객이 각 필드가 명시적으로 포함되어야 한다고 요구할 때 유용합니다. 기본값: false. |
session/serialization/force_complete_transforms | bool | — | 항상 송신 position, rotation et scale 변환 출력 각각에서, 방향 조절 기능만 있는 기기(Verse Grip, Wireless Verse Grip)를 포함하여, 그렇지 않으면 rotation. 포함 session/serialization/explicit_fields. 기본값: 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에 도입됨 — 네 가지 키 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 | avancé | ~의 일정을 계획하기 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. 읽기 및 쓰기 작업은 투명하게 리디렉션됩니다. |
내부 용도로만 사용되는 매개변수
여러 매개변수 그룹이 표시되어 있습니다 hidden 버전 3.5.1에서 제공되며 내부 용도로만 사용됩니다 — rate/dispatch/* (AIMD 송신 유량 상한 및 역압 임계값), session/freeform/* (행동적 흔적) 및 session/serialization/preview/* (프리뷰 버전의 직렬화 실험 기능, 예를 들어 오일러 쿼터니언 출력 및 Wireless VerseGrip 라우팅 등). 이 기능들은 다음을 통해 이용할 수 있습니다. misc/hidden_settings 디버깅 목적으로 제공되지만, 향후 마이너 릴리스에서 이 설정들이 상위 수준으로 승격되거나 이름이 변경되거나 삭제될 수 있으므로, 클라이언트의 동작을 이러한 설정에 의존하지 마십시오.