본문으로 이동

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} et {id_or_index} 대상 기기를 식별합니다.

경로 세그먼트 예시의미
inverse3/0인덱스(0을 기준으로)에 따른 프리미어 Inverse3
inverse3/A14Inverse3 기기 식별자는 A14
inverse3/*Inverse3 의 모든 기기 (범용 문자)
verse_grip/0인덱스에 따른 프리미어 버스 그립
wireless_verse_grip/*모든 Wireless Verse Grip
*inverse/*Inverse 제품군에 속하는 모든 기기 (Inverse3, Inverse3x, Minverse)
*verse_grip/*Verse Grip 제품군에 속하는 모든 기기 (Verse Grip, Wireless VG)

ワ일드카드에 관한 규칙:

  • GET 모호하거나 와일드카드가 포함된 선택자를 거부합니다(반환값: 400).
  • POST et DELETE ワ일드카드를 허용합니다: 해당 조건에 맞는 모든 기기에 이 작업이 적용됩니다.

세션 선택기​

세션 범위 내의 종단점(basis, mount, preset, transform, filters)에는 쿼리 매개변수가 필요합니다. ?session=<expr> 세션을 식별하기 위해.

표현의미
(생략)모든 세션 (DELETE만 해당)
#123 ou 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 et status.

또한 다음을 전달하실 수도 있습니다. ?session=<expr> 특정 세션의 관점에서 스냅샷을 필터링하기 위해 (반환된 값에 해당 세션의 베이스, 마운트 및 변환을 적용합니다).

답변 예시:

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

세션​

방법Chemin설명
받기/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 에서만 해당)​

방법Chemin군단답변
받기/{device_type}/{id}/config/handedness--"left" ou "right"
게시물/{device_type}/{id}/config/handedness"left" ou "right"반환값
삭제/{device_type}/{id}/config/handedness--"right" (기본값)

토크 스케일링 (Inverse3 에만 해당)​

방법Chemin군단답변
받기/{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 에만 해당)​

방법Chemin군단답변
받기/{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 }

기준 (모든 기기, 세션 범위 내)​

방법Chemin군단답변
받기/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }
게시물/{device_type}/{id}/config/basis?session={ "permutation": "ZXY" }반환값
삭제/{device_type}/{id}/config/basis?session=--{ "permutation": "XYZ" }

마운트 (세션 범위 내의 모든 기기)​

방법Chemin군단답변
받기/{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 }
}
}

사전 설정 (모든 기기, 해당 세션에 한함)​

방법Chemin군단답변
받기/{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 요청 본문에는 적어도 하나의 필드가 포함되어야 합니다.

방법Chemin군단답변
받기/{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 } ou { "vector": {...} } 혹은 둘 다반환값
삭제/{device_type}/{id}/config/filters/damping?session=--두 가지 초기화

포르트 드 포스​

방법Chemin군단답변
받기/{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=--설정에서 정의된 기본값

기기 상태​

변환 (모든 기기에서 가능, 해당 세션으로 제한됨)​

작업 공간의 전환 (기기 공간에서 애플리케이션 공간으로).

방법Chemin군단답변
받기/{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 버전 마이그레이션 가이드 사용 중단된 경로와 대체 경로 간의 전체 대응표를 보려면.