설정 참조
이 문서는 엔드포인트가 지원하는 모든 설정을 나열합니다. /settings/ 반환하며, 그 Schlüssel, 그녀의 유형 (출처: type_hint) 및 그들의 제한 사항 (출처: metadata.constraint.range + locked(해당되는 경우).
Eine locked-설정은 실행 시 읽기 전용. 이는 구성 파일이나 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
}
유형 할당
API에서 반환되는 타입 정보는 다음 JSON 타입에 해당합니다:
STRING→stringBOOL→boolINT→intFLOAT→floatARR_STRING→string[]VEC3→vec3(다음 속성을 가진 객체:{x, y, z})GENERIC→json(임의의 구조화된 값)
communication/…
HTTP, WebSocket 및 이벤트 스트림 서버에 대한 네트워크 포트 및 바인드 주소. 대부분의 항목은 부팅 시(boot)에만 적용됩니다.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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/…
직렬 포트 스캔 지침. 모든 항목은 고급 설정입니다.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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[] | — | 무선 VerseGrip을 식별하기 위한 포트 설명의 부분 문자열. |
devices/detection/inverse3x_description_filter | string[] | — | Inverse3x를 식별하기 위한 포트 설명의 부분 문자열. |
devices/detection/extra_ports (구 버전) | string[] | — | 대신 devices/detection/additional_ports 사용합니다. 읽기 및 쓰기 요청은 캐노니컬 키로 투명하게 전달됩니다. |
devices/inverse*/…
Inverse3 제품군 전체에 적용되는 글로벌 기본값입니다. 세션별 재정의 설정이 우선 적용됩니다.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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/presets
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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/…
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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 필터 설정. |
features/…
features/calibration/…
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
features/calibration/hall_threshold | int | 범위 1–32 | 교정 시 핀이 삽입된 것으로 간주되는 홀 센서 레벨. |
features/grip_hook/…
그립 후크의 자동 동작 – 그립을 세운 상태로 유지하는 동안 커서가 고정됩니다.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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-동작이 처음 활성화될 때.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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/…
엔드 이펙터의 이동을 위한 속도 제한기.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
features/safe_trajectory/enabled | bool | — | 안전한 주행 경로를 위해 속도 제한 장치를 활성화하십시오. |
features/safe_trajectory/max_vel | float | 범위 0.01–2.0 | 엔드 이펙터의 최대 허용 속도 (m/s). |
features/screensaver/…
Inverse3 기기에서 세션에 의해 제어되지 않을 때, 유휴 상태에서 재생되는 애니메이션.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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)를 기반으로 한 햅틱 효과 모듈.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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으로 떨어진 후 자동 조회가 이루어지기 전의 지연 시간 (s). |
features/verse_grip_pairing/…
Inverse3 와 Verse Grip(유선 또는 무선) 간의 연결 및 분리 감지. Haply Hub의 페어링 화면 기반.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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–10,000 | 강제 재알림 간격 (ms). |
features/verse_grip_pairing/force_attached | bool | — | “연결됨” 상태를 영구적으로 강제 적용합니다 (true) 그리고 홀 센서를 우회합니다(하드웨어 오류 시 해결 방법). |
serialization/…
변환 결과의 서식 지정 – WebSocket 및 HTTP JSON 페이로드에 적용됩니다.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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/…
세션 스케줄러 및 명령어 파이프라인에 대한 한계값.
| Schlüssel | 유형 | 제한 사항 | 설명 |
|---|---|---|---|
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-웹소켓 배치 전체가 폐기된 경우에도 이 항목을 선택하십시오. |