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 | Inverse3 기기 ID 포함 A14 |
inverse3/* | 모든 Inverse3 기기 (자리 표시자) |
verse_grip/0 | 인덱스에 따른 첫 번째 버스 그립 |
wireless_verse_grip/* | 모든 Wireless Verse 그립 |
*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 또는 123 | 번호 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> 특정 세션의 관점으로 스냅샷을 필터링하기 위해 전달합니다(이때 해당 세션의 베이스, 마운트 및 변환이 반환된 값에 적용됩니다).
답변 예시:
{
"inverse3": [
{
"device_id": "04BA",
"config": { "...": "..." },
"state": { "...": "..." },
"status": { "...": "..." }
}
]
}
회의
| 방법 | Pfad | 설명 |
|---|---|---|
| 받기 | /sessions | v3.1의 모든 활성 세션을 나열합니다. |
| 받기 | /sessions/{session_id} | 단일 세션을 불러옵니다 |
| 받기 | /sessions/{session_id}/profile | 세션 프로필의 이름을 조회합니다 |
| 게시물 | /sessions/{session_id}/profile | 세션 프로필을 설정합니다 |
| 삭제 | /sessions/{session_id}/profile | 프로필을 설정하세요 "default" 뒤로 |
POST 본문 /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 만 해당)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{device_type}/{id}/config/handedness | -- | "left" 또는 "right" |
| 게시물 | /{device_type}/{id}/config/handedness | "left" 또는 "right" | 반환된 값 |
| 삭제 | /{device_type}/{id}/config/handedness | -- | "right" (표준) |
토크 스케일링 ( Inverse3 에서만 지원)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{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 에서만 해당)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{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 } |
기준 (모든 기기, 세션별)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
| 게시물 | /{device_type}/{id}/config/basis?session= | { "permutation": "ZXY" } | 반환된 값 |
| 삭제 | /{device_type}/{id}/config/basis?session= | -- | { "permutation": "XYZ" } |
마운트 (모든 기기, 세션별)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{device_type}/{id}/config/mount?session= | -- | { "transform": {...} } |
| 게시물 | /{device_type}/{id}/config/mount?session= | { "transform": {...} } | 반환된 값 |
| 삭제 | /{device_type}/{id}/config/mount?session= | -- | 정체성의 변형 |
변환 구조 (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 }
}
}
사전 설정 (모든 기기, 세션별)
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{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-Body에는 최소한 하나의 필드가 있어야 합니다.
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{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으로 재설정됨 |
포스 게이트
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{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= | -- | 기본 설정으로 얻는 이점 |
기기 상태
변환 (모든 기기, 세션별)
작업 공간 전환 (하드웨어 영역에서 애플리케이션 영역으로).
| 방법 | Pfad | 본문 | 답변 |
|---|---|---|---|
| 받기 | /{device_type}/{id}/state/transform?session= | -- | { "transform": {...} } |
| 게시물 | /{device_type}/{id}/state/transform?session= | { "transform": {...} } | 반환된 값 |
| 삭제 | /{device_type}/{id}/state/transform?session= | -- | 정체성의 변형 |
설정 저장
Inverse3 기기에서만 작동합니다. 주의: 기기당 저장 횟수가 제한되어 있으므로(약 10,000회의 EEPROM 쓰기 작업), 설정을 너무 자주 저장하지 마십시오 .
방법: 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 복잡한 유형에 대한 대체 솔루션으로 사용됩니다.
지원되는 힌트:
BOOLINTFLOATSTRINGVEC2VEC3VEC4TRANSFORMARR_INTARR_FLOATARR_STRINGGENERIC
구식 레거시 엔드포인트
일부 POST-엔드포인트는 여전히 허용되지만, 사용 중단 예정 경고가 표시되며
다음에 4.0 제거되었습니다. 다음을 참조하십시오. 3.5 버전 마이그레이션 가이드
구 경로 → 대체 경로의 전체 매핑 표를 보려면.