설정 참조
이 문서에서는,/settings/ 엔드포인트가 반환하는 모든 설정을, 그 키、형(type_hint (유래),제약(metadata.constraint.range 유래, 그리고 해당되는 경우 locked)와 함께 목록으로 정리해 두었습니다.
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 및 이벤트 스트림 서버의 네트워크 포트와 바인딩 주소입니다. 대부분의 항목은 부팅 시에만 적용됩니다.
| 키 | 형 | 제약 | 설명 |
|---|---|---|---|
communication/serial/enabled | bool | — | 직렬 장치 통신을 활성화하거나 비활성화합니다. |
communication/bind_address | string | 부팅 | HTTP 및 WebSocket 서버가 바인딩되는 IP 주소입니다. |
communication/bind_all_interfaces | bool | 부팅 | localhost가 아니라 0.0.0.0 서버를 바인딩합니다. |
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; 부팅 | 직렬 포트의 스캔 간격(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 | — | 탐지 시 건너뛸 직렬 포트 경로. |
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 | 장치 제어 잠금을 해제하기까지의 타임아웃(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 (해당 기기를 위한 마운트 변환이나 basis 등). |
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 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 | — | 커서가 버블 안으로 들어갈 때 속도를 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/…
엔드 이펙터의 움직임에 대한 속도 제한 장치입니다.
| 키 | 형 | 제약 | 설명 |
|---|---|---|---|
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 | — | 인가력이 거의 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의 페어링 UI를 작동시킵니다.
| 키 | 형 | 제약 | 설명 |
|---|---|---|---|
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 페이로드에 영향을 미칩니다.
| 키 | 형 | 제약 | 설명 |
|---|---|---|---|
serialization/explicit_fields | bool | — | 시리얼라이즈된 출력에, 단위 원소(identity)의 기본값과 동일한 변환 필드를 포함합니다(예: position: {0,0,0}、rotation: {w:1,…}). 클라이언트가 모든 필드에 대한 명시적인 지정을 요구하는 경우에 유용합니다. 기본값: false。 |
serialization/force_complete_transforms | bool | — | 방향만 제어하는 장치(Verse Grip, Wireless Verse Grip)를 포함하여 모든 트랜스폼 출력에서 position、rotation、그리고 scale 를 항상 출력합니다. 일반적으로는 rotation 해당 장치만 출력하는 장치도 대상에 포함됩니다.serialization/explicit_fields 의 기능을 포함합니다. 기본값: false。 |
session/…
세션 스케줄러와 명령어 파이프라인의 상한값입니다.
| 키 | 형 | 제약 | 설명 |
|---|---|---|---|
session/min_simulation_rate_hz | int | 범위 20–500 | 경고가 발생하기 전까지 허용되는 장치의 시뮬레이션 속도 하한값(Hz)입니다. |
session/commands/zoh_window_ms | int | — | 0차 홀드 창입니다. 이 창 내에서 수신된 프로브를 억제합니다(ms). |
session/commands/drop_warning_threshold | int | — | 경고가 발생하기 전까지 창 내에서 취소된 명령의 수입니다. |
session/commands/drop_warning_window_ms | int | — | 무효화된 명령어의 개수를 계산하기 위한 슬라이딩 윈도우의 크기입니다(ms). |
session/commands/tick_on_empty_batch | bool | — | WebSocket의 전체 배치가 폐기된 경우에도,main_loop 틱을 예약합니다. |