본문으로 이동

매개변수 참조

이 문서는 엔드포인트에서 반환되는 모든 매개변수를 나열합니다. /settings/ 그들과 함께 clé, 그들의 유형 (출처: type_hint) 및 그들의 제약 조건 (출처: metadata.constraint.range + locked(해당되는 경우).

한 가지 매개변수 locked est 실행 시 단독으로. 이 설정은 구성 파일을 통해 또는 [설정] 페이지에서 변경할 수 있습니다. Haply Hub, 하지만 서비스를 완전히 다시 시작해야 합니다. 변경 사항이 적용되도록 하려면. 이러한 설정은 표시되어 있습니다. 부팅 아래 표에서.

구성​

서비스 시작 시 매개변수를 변경할 수 있는 구성 파일은 다음 위치에 있습니다:

플랫폼위치
WindowsC:\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 → string
  • BOOL → bool
  • INT → int
  • FLOAT → float
  • ARR_STRING → string[]
  • VEC3 → vec3 (다음이 포함된 항목: {x, y, z})
  • GENERIC → json (임의의 구조화된 값)

communication/…​

HTTP, WebSocket 및 이벤트 스트림 서버의 네트워크 포트 및 수신 대기 주소. 대부분의 항목은 시작 시에만 수정할 수 있습니다.

클레유형제약 조건설명
communication/serial/enabledbool—직렬 장치와의 통신 활성화 또는 비활성화.
communication/bind_addressstring시동HTTP 및 WebSocket 서버가 연결을 수신 대기하는 IP 주소.
communication/bind_all_interfacesbool시동서버가 다음 주소를 수신하도록 설정하기 0.0.0.0 localhost 대신.
communication/http/portint시동REST HTTP API 포트 (기본값 10000).
communication/websocket/portint시동버전 3.1의 기본 WebSocket 포트 (기본값) 10001).
communication/websocket/legacy_portint시동버전 3.0에서 계승된 WebSocket 포트 (기본값 10000).
communication/events/portint시동이벤트 스트림의 WebSocket 포트 (기본값 10020).

devices/…​

devices/detection/…​

직렬 포트 스캔 정책. 모든 항목은 고급 수준입니다.

클레유형제약 조건설명
devices/detection/scan_period_msint범위 100–10000; 시작두 번의 직렬 포트 스캔 사이의 간격 (ms).
devices/detection/handshake_timeout_sint1–15쪽항구별 거래 만료 기간 (초).
devices/detection/max_retriesint1–10쪽포트당 최대 협상 시도 횟수.
devices/detection/failure_log_delay_sint1–60쪽탐지 실패를 다시 기록하기까지의 대기 시간 (초).
devices/detection/block_looping_portsbool—루프 포트가 감지되면 해당 장치의 가용성을 차단합니다.
devices/detection/excluded_portsjson—탐지 시 무시할 ‘Chemins des ports’ 시리즈.
devices/detection/additional_portsstring[]—체계적으로 스캔해야 할 추가 직렬 포트 경로.
devices/detection/allowed_vendor_id_filterstring[]—포트 열거 시 허용되는 USB 공급자 식별자.
devices/detection/port_name_substring_filterstring[]—각 플랫폼별로 고유한 포트 이름의 하위 문자열을 검색해야 합니다.
devices/detection/wireless_verse_grip_description_filterstring[]—VerseGrip 무선 감지를 위한 포트 설명 하위 문자열.
devices/detection/inverse3x_description_filterstring[]—Inverse3x 탐지를 위한 포트 설명 서브스트링.
devices/detection/extra_ports (구식)string[]—대신 다음을 사용하세요 devices/detection/additional_ports. 읽기 및 쓰기 작업은 캐논 키로 투명하게 전달됩니다.

devices/inverse*/…​

Inverse3 제품군의 각 기기에 적용되는 전역 기본값입니다. 각 세션별 대체 설정이 우선 적용됩니다.

클레유형제약 조건설명
devices/inverse*/filters/force_scale/gainfloat범위 0.0–2.0모든 기기에 적용되는 출력 힘의 전체 배율.
devices/inverse*/filters/force_gate/gainfloat범위 0.0–1.0새 세션에 대한 강제 실행 게이트의 기본 이득.
devices/inverse*/control_timeout_msint범위 50–10,000기기 제어 잠금이 해제되기까지의 만료 시간 (ms).
devices/inverse*/query_orientation_on_idlebool—기기가 비활성 상태일 때 펌웨어에 기기의 방향을 조회합니다.

devices/presets​

클레유형제약 조건설명
devices/presetsjson—각 기기 유형별 기본 구성 설정(마운팅 변환, 베이스 등) 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_thresholdint—배터리 잔량이 몇 퍼센트 이하가 되면 배터리 부족 경고가 표시됩니다.
devices/wireless_verse_grip/battery/critical_thresholdint—배터리 잔량이 이 비율 이하로 떨어지면 배터리 경고가 발령됩니다.
devices/wireless_verse_grip/battery/reset_marginint—배터리 경고가 해제되기 전까지의 히스테리시스 범위.
devices/wireless_verse_grip/filters/orientation_filterjson시동VerseGrip 무선 방향 조절용 One Euro 필터 설정.

features/…​

features/calibration/…​

클레유형제약 조건설명
features/calibration/hall_thresholdint1–32쪽보정 중에 스타일릿이 부착된 것으로 간주되는 홀 효과 센서의 레벨.

features/grip_hook/…​

그립 후크의 자동 작동 방식: 손잡이를 수직으로 잡으면 슬라이더가 잠깁니다.

클레유형제약 조건설명
features/grip_hook/enabledbool—손잡이를 수직으로 잡았을 때 그립 후크의 자동 잠금 기능을 활성화합니다.
features/grip_hook/use_hallbool—손잡이를 감지할 때 방향 대신 홀 효과 센서의 임계값을 활용하십시오.
features/grip_hook/hallint1–32쪽핸들 잠금을 작동시키는 홀 효과 센서의 임계값.
features/grip_hook/hold_durationint범위 10–1000트리거 발생 후 잠금 유지 시간 (ms).

features/navigation/bubble/…​

“버블” 탐색 모듈의 기본값으로, 동작이 처음 활성화될 때 세션으로 전달됩니다. bubble.

클레유형제약 조건설명
features/navigation/bubble/centervec3—버블 중심의 기본 위치.
features/navigation/bubble/max_velocityfloat—속도 제한 구역 내의 최대 항해 속도 (m/s).
features/navigation/bubble/velocity_zone_widthfloat—기포 표면 바깥쪽의 속도 영역의 폭 (m).
features/navigation/bubble/reset_velocity_on_entrybool—커서가 버블 안으로 들어갈 때 속도를 0으로 재설정합니다.
features/navigation/bubble/spring_innerfloat—기포 중심부의 강성 계수 (N/m).
features/navigation/bubble/spring_surfacefloat—기포 표면의 강성 계수 (N/m).
features/navigation/bubble/spring_outerfloat—외부 한계 강성 계수 (N/m).
features/navigation/bubble/damping_innerfloat—거품 중심부의 감쇠 계수 (Ns/m).
features/navigation/bubble/damping_surfacefloat—기포 표면의 감쇠 계수 (Ns/m).
features/navigation/bubble/damping_outerfloat—외곽 한계 감쇠 계수 (Ns/m).
features/navigation/bubble/wall_stiffnessfloat—외부 경계에서의 강체 벽의 강성 (N/m).
features/navigation/bubble/bump_widthfloat—기포 표면의 촉감 돌기 너비 (m).
features/navigation/bubble/bump_stiffnessfloat—기포 표면의 촉감 돌기 강성 (N/m).

features/safe_trajectory/…​

터미널 이펙터의 이동을 위한 속도 제한 장치.

클레유형제약 조건설명
features/safe_trajectory/enabledbool—안전 주행 속도 제한 기능을 활성화하십시오.
features/safe_trajectory/max_velfloat범위 0.01–2.0최종 효과기의 최대 허용 속도 (m/s).

features/screensaver/…​

Inverse3 기기에서 세션이 실행되지 않을 때 재생되는 비활성 애니메이션.

클레유형제약 조건설명
features/screensaver/enabledbool—Inverse3 기기에서 비활성 상태일 때 화면 보호기 애니메이션을 활성화합니다.
features/screensaver/speedfloat범위 0.001–0.2스크린 세이버 애니메이션 속도.
features/screensaver/distracted_speedfloat범위 0.001–0.2사용자가 상호작용하지 않은 채 가까이 있을 때 애니메이션의 속도.

features/sdf/…​

부호화된 거리 필드 햅틱 효과 모듈 (SDF HFX).

클레유형제약 조건설명
features/sdf/enabledbool—SDF 햅틱 효과 모듈을 켜거나 끕니다.
features/sdf/state_outputbool—기본적으로 기기의 출력 데이터에 SDF 상태를 포함합니다.
features/sdf/max_countint범위 0–128활성 SDF 효과의 최대 개수 (0 = 무제한).
features/sdf/events/createdbool—새로운 SDF 이펙트가 생성될 때 이벤트를 발생시킵니다.
features/sdf/events/deletedbool—SDF 이펙트가 제거될 때 이벤트를 발생시킵니다.
features/sdf/events/updatedbool—SDF 이펙트가 업데이트될 때 이벤트를 발생시킵니다.
features/sdf/probe_on_zero_force/enabledbool—가해지는 힘이 0에 가까워지면 SDF 필드를 자동으로 분리합니다.
features/sdf/probe_on_zero_force/delayfloat범위 0.001–60.0힘이 0이 된 후 자동 측정이 시작되기까지의 지연 시간 (초).

features/verse_grip_pairing/…​

Inverse3 와 Verse Grip 기기(유선 또는 무선) 간의 연결 및 분리 상태를 모니터링합니다. Haply 허브의 페어링 인터페이스에 전원을 공급합니다.

클레유형제약 조건설명
features/verse_grip_pairing/enabledbool—페어링 및 장착·제거 추적 기능을 활성화합니다.
features/verse_grip_pairing/hall_threshold_vgint1–32쪽유선형 VerseGrip 장치가 고정된 것으로 간주되는 홀 센서의 감지 수준.
features/verse_grip_pairing/hall_threshold_wvgint1–32쪽무선 VerseGrip 장치가 고정된 것으로 간주되는 홀 센서의 감지 수준.
features/verse_grip_pairing/detach_debounce_msint범위 0–1000인출을 확정하기 전의 반동 방지 대기 시간 (ms).
features/verse_grip_pairing/heartbeat_msint범위 100–10,000강제 재알림 간격 (ms).
features/verse_grip_pairing/force_attachedbool—항상 “고정” 상태를 강제 적용하려면 true, 홀 센서를 우회하여 (하드웨어 고장 시의 우회 조치).

serialization/…​

변환 결과의 형식 지정 — WebSocket 및 HTTP JSON 페이로드에 적용됩니다.

클레유형제약 조건설명
serialization/explicit_fieldsbool—시리얼화된 출력 결과에 기본 정체 값과 동일한 값을 갖는 변환 필드를 포함합니다(예: position: {0,0,0}, rotation: {w:1,…}). 고객이 각 필드가 명시적으로 포함되어야 한다고 요구할 때 유용합니다. 기본값: false.
serialization/force_complete_transformsbool—항상 송신 position, rotation et scale 변환 출력 각각에서, 방향 조절 기능만 있는 기기(Verse Grip, Wireless Verse Grip)를 포함하여, 그렇지 않으면 오직 rotation. Englobe serialization/explicit_fields. 기본값: false.

session/…​

세션 플래너 및 명령어 파이프라인의 한계.

클레유형제약 조건설명
session/min_simulation_rate_hzint범위 20–500경보가 발령되기 전까지 기기에서 허용되는 최소 시뮬레이션 주파수(Hz).
session/commands/zoh_window_msint—제로 유지 시간 창 — 이 창(ms)에서 수신된 센서 데이터를 삭제합니다.
session/commands/drop_warning_thresholdint—경고가 표시되기 전 창에서 거부된 주문 수.
session/commands/drop_warning_window_msint—거절된 주문 수를 집계하기 위한 슬라이딩 윈도우 크기 (ms).
session/commands/tick_on_empty_batchbool—~의 일정을 계획하기 main_loop WebSocket 묶음 전체가 거부된 경우에도 마찬가지입니다.