주요 내용으로 이동

HTTP

기본적으로 HTTP 서비스는 다음 위치에서 시작됩니다:http://localhost:10001。

포트는 서비스구성에서수정할 수 있습니다.

개요​

이 절에서는 해당 서비스가 공개하는 HTTP 라우팅을 기록합니다.

다음의 모든 라우트는 기본 기본 URL을 기준으로 합니다. http://localhost:10001 을 전제로 한다.

표준 응답 구조​

모든 엔드포인트는 다음 두 가지 구조 중 하나를 반환합니다:

데이터 응답 없음(데이터만 수정하는 엔드포인트용):

{ "ok": true }
{ "ok": false, "error": "reason string" }

데이터 응답(GET 요청 및 적용된 값을 반환하는 구성 엔드포인트에 대한 POST/DELETE 요청에 사용됨):

{ "ok": true, "data": { "..." : "..." } }
{ "ok": false, "error": "reason string" }

장비 선택기 구문​

장비 수준 라우팅 사용 /{device_type}/{id_or_index}/... 형식. 경로 구간 {device_type} 와 {id_or_index} 대상 장치를 식별하는 데 사용됩니다.

예시 경로 구간의미
inverse3/0인덱스(0부터 시작)에 따라 선택된 첫 번째 항목 Inverse3
inverse3/A14장치 ID는 A14 의 Inverse3
inverse3/*모든 Inverse3 장치(와일드카드)
verse_grip/0색인에서 선택한 첫 번째 Verse Grip
wireless_verse_grip/*모든 Wireless Verse Grip
*inverse/*모든 Inverse 시리즈 기기(Inverse3, Inverse3x,Minverse)
*verse_grip/*모든 Verse Grip 시리즈 기기(Verse Grip, Wireless VG)

와일드카드 규칙:

  • GET 모호하거나 와일드카드를 포함하는 선택자는 거부됩니다(반환값: 400).
  • POST 와 DELETE 와일드카드가 지원되며, 해당 작업은 일치하는 모든 기기에 적용됩니다.

대화 선택기​

세션 수준 엔드포인트(basis, mount, preset, transform, filters)는 다음을 사용해야 합니다. ?session=<expr> 세션을 식별하기 위한 쿼리 매개변수.

식의미
(생략)모든 세션 (DELETE만 해당)
#123 또는 123ID가 123인 세션
:-1색인에서 선택한 마지막 세션
:0색인에서 선택한 첫 번째 세션

예시:GET /inverse3/0/config/basis?session=:0


버전​

방법: GET
URL: http://localhost:10001/version

응답 예시:

{
"build_time": "2024-08-07T16:01:53Z",
"git_branch": "main",
"git_describe": "3.5.0-2-gce34c39e",
"git_hash": "ce34c39e",
"git_tag": "3.5.0",
"project_name": "haply-inverse-service",
"project_version": "3.5.0"
}

전문가 상태​

방법: GET
URL: http://localhost:10001/expert/status

검출, 장치, 세션 및 전체 설정을 포함한 상세한 상태 정보를 반환합니다.


장비​

방법: GET
URL: http://localhost:10001/devices

현재 기기 목록을 반환하며, 다음을 포함합니다. config、state 와 status。

선택적으로 전달할 수 있습니다 ?session=<expr> 매개변수로, 스냅샷을 지정된 세션의 관점으로 필터링합니다(반환값에 해당 세션의 basis, mount 및 transform이 적용됩니다).

응답 예시:

{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}

대화​

방법경로설명
받기/sessionsv3.1 세션의 모든 활동을 나열합니다.
받기/sessions/{session_id}단일 세션 가져오기
받기/sessions/{session_id}/profile세션 프로필 이름 가져오기
게시물/sessions/{session_id}/profile세션 프로필 설정
삭제/sessions/{session_id}/profile구성 파일을 다음으로 재설정합니다. "default"

게시물 /sessions/{session_id}/profile 요청 본문:

{
"name": "my_profile"
}

포트​

방법: POST
URL: http://localhost:10001/ports/{port}/reset

막힌 시리얼 포트를 해제합니다. 반환 { "ok": true }。


장비 구성​

모든 구성 엔드포인트는 다음을 사용합니다. /{device_type}/{id_or_index}/config/{setting} 서식.

세션 수준 엔드포인트(basis, mount, preset)에는 또한 다음이 필요합니다. ?session=<expr> 쿼리 매개변수.

좌우 설정 ( Inverse3에서만 적용)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/handedness--"left" 또는 "right"
게시물/{device_type}/{id}/config/handedness"left" 또는 "right"반환값
삭제/{device_type}/{id}/config/handedness--"right"(기본값)

토크 스케일링 ( Inverse3에서만 지원)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/torque_scaling--{ "enabled": bool }
게시물/{device_type}/{id}/config/torque_scaling{ "enabled": bool }반환값
삭제/{device_type}/{id}/config/torque_scaling--{ "enabled": false }

중력 보정 ( Inverse3에서만 지원)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/gravity_compensation--{ "enabled": bool, "scaling_factor": float }
게시물/{device_type}/{id}/config/gravity_compensation{ "enabled": bool, "scaling_factor": float }반환값
삭제/{device_type}/{id}/config/gravity_compensation--{ "enabled": true, "scaling_factor": 1.0 }

기준(모든 장비, 세션 수준)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
게시물/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }반환값
삭제/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

마운트(모든 장치, 세션 수준)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/mount?session=--{ "transform": {...} }
게시물/{device_type}/{id}/config/mount?session={ "transform": {...} }반환값
삭제/{device_type}/{id}/config/mount?session=--항등 변환

Transform 구조체(mount 및 state/transform에 사용):

{
"transform": {
"position": { "x": 0, "y": 0, "z": 0 },
"rotation": { "x": 0, "y": 0, "z": 0, "w": 1 },
"scale": { "x": 1, "y": 1, "z": 1 }
}
}

사전 설정 (모든 기기, 세션 수준)​

방법경로요청 본문답변
받기/{device_type}/{id}/config/preset?session=--{ "preset": "arm_front_centered" }
게시물/{device_type}/{id}/config/preset?session={ "preset": "arm_front_centered" }반환값
삭제/{device_type}/{id}/config/preset?session=--{ "preset": "device_defaults" }

사용 가능한 값:device_defaults、arm_front、arm_front_centered、led_front、led_front_centered、custom。


장비 필터( Inverse3에만 적용되며, 세션 수준)​

필터 종단점 사용 /{device_type}/{id}/config/filters/{filter}?session=<expr>。

감쇠​

균일 감쇠와 방향성 감쇠를 동시에 제어합니다. POST 요청 본문에는 최소한 하나의 필드가 포함되어야 합니다.

방법경로요청 본문답변
받기/{device_type}/{id}/config/filters/damping?session=--{ "scalar": float, "vector": { "x": f, "y": f, "z": f } }
게시물/{device_type}/{id}/config/filters/damping?session={ "scalar": float } 또는 { "vector": {...} }, 또는 두 가지 모두를 동시에 제공반환값
삭제/{device_type}/{id}/config/filters/damping?session=--둘 다 0으로 재설정됩니다

전력 게이트 제어​

방법경로요청 본문답변
받기/{device_type}/{id}/config/filters/force_gate?session=--{ "gain": float }
게시물/{device_type}/{id}/config/filters/force_gate?session={ "gain": float }반환값
삭제/{device_type}/{id}/config/filters/force_gate?session=--설정에서 지정된 기본 게인

장비 상태​

변환 (모든 기기, 세션 수준)​

작업 공간 변환 (장치 공간에서 애플리케이션 공간으로).

방법경로요청 본문답변
받기/{device_type}/{id}/state/transform?session=--{ "transform": {...} }
게시물/{device_type}/{id}/state/transform?session={ "transform": {...} }반환값
삭제/{device_type}/{id}/state/transform?session=--항등 변환

설정 저장​

Inverse3 기기에만 적용됩니다. 경고: 단일 기기에서 수행할 수 있는 저장 횟수에는 제한이 있으므로(EEPROM 쓰기 약 10,000회), 구성을 지나치게 자주 저장하지 마십시오.

방법: POST
URL: http://localhost:10001/save_configuration

요청 본문 예시:

{
"device_id": "049D"
}

응답 예시:

{
"ok": true
}

설정​

엔드포인트 설정 시 다음과 같은 기능이 자동으로 제공됩니다:

  • 모든 설정(메타데이터 포함) 나열
  • 개별 설정값 읽기
  • 앱 설정 (개별 또는 일괄)
  • 특정 키를 기본값으로 재설정하기

모든 설정 버튼에 대한 설명은여기에서확인할 수 있습니다.

라우팅​

방법라우팅설명
받기/settings/모든설정 키, 값 및 메타데이터를 가져옵니다.
게시물/settings/여러설정을 한 번에 일괄 적용합니다.
받기/settings/{key}지정된 설정 키의현재 값을가져옵니다.
게시물/settings/{key}지정된 키에새로운 값을적용합니다.
삭제/settings/{key}특정 키를기본값으로 재설정합니다.

응답 구조​

받기 /settings/(모든 설정)​

설정 키를 키로 하는 객체를 반환합니다. 각 항목에는 다음이 포함됩니다:

  • value: 현재값
  • metadata: 유형 + 제약 조건 + 잠금 상태

항목 예시:

{
"devices/detection/timeout": {
"metadata": {
"constraint": {
"range": {
"max": 15,
"min": 1,
"step": 0
}
},
"locked": false,
"type_hint": "INT"
},
"value": 5
}
}

받기 /settings/{key}(개별 설정)​

요청된 키의값만반환합니다(메타데이터 제외).

앱 설정​

게시물 /settings/(일괄 적용)​

여러 키를 한 번에 일괄 적용합니다.

권장되는 요청 본문 형식: 키와 값을 매핑한 JSON 객체.

{
"devices/detection/timeout": 5,
"devices/detection/advanced/wvg_description_filter": ["Haply USB Transceiver", "Haply Handle"]
}

게시물 /settings/{key}(단일 애플리케이션)​

단일 키에 새 값을 적용합니다.

권장되는 요청 본문 형식: 원시 JSON 값 또는 래핑된 값(명확성을 위해 래핑된 형식을 사용하는 것이 좋습니다).

{
"value": 5
}

설정 초기화​

삭제 /settings/{key}​

해당 키를 기본값으로 재설정합니다.

이는 “기본값으로 재설정”하는 것과 같습니다.

유형 힌트​

서비스가 자동으로 추론합니다 type_hint. 복합 유형의 경우, 다음을 대신 사용합니다. GENERIC。

유용한 팁:

  • BOOL
  • INT
  • FLOAT
  • STRING
  • VEC2
  • VEC3
  • VEC4
  • TRANSFORM
  • ARR_INT
  • ARR_FLOAT
  • ARR_STRING
  • GENERIC

사용이 중단된 구버전 엔드포인트​

여전히 몇 가지가 POST 엔드포인트는 계속 사용할 수 있지만, 사용 중단 경고가 표시되며, 다음 날짜에 4.0 중간 부분을 삭제했습니다. 다음을 참조하십시오. 3.5 마이그레이션 가이드, 사용 중단된 경로와 대체 경로의 전체 대조표를 확인하세요.