이벤트 채널
기본 이벤트 웹소켓 URL은 ws://localhost:10020입니다.
포트는 설정에서 변경할 수 있습니다.
이 채널은 저주파 단방향 통신 채널로, 시스템의 모든 이벤트를 수신할 수 있습니다. 입력 메시지는 지원되지 않습니다.
이 채널은 각 이벤트마다 메시지 하나를 전송하도록 보장합니다.
표준 형식
모든 이벤트는 다음과 같은 표준 구조를 따릅니다:
{
"name": "device-connected",
"category": "device",
"level": "notice",
"data": {},
"message": ""
}
필드 설명
| 필드 | 유형 | 설명 |
|---|---|---|
name | string | 이 이벤트의 고유 식별자입니다. |
category | string | 필터링 및 구성에 사용되는 그룹 레이블입니다(유효한 카테고리 참조). |
level | string | 이벤트의 심각도 또는 중요도입니다(유효한 레벨 참조). |
data | object | 이벤트별 세부 정보가 포함된 페이로드입니다. |
message | string | 이벤트에 대한 선택적 설명이나 배경 정보입니다. |
이벤트 카테고리
category 필드는 이벤트를 다음과 같은 그룹으로 분류합니다:
| 값 | 설명 |
|---|---|
system | 핵심 또는 중앙 시스템, 전역 설정 등입니다. |
input | 외부 입력 처리(예: 명령 등)입니다. |
session | 특정 사용자 세션과 관련된 이벤트입니다. |
device | 장치 관리, 컨트롤러 상호작용, SerialPort 통신입니다. |
module | 하위 시스템 또는 모듈형 구성 요소의 이벤트입니다. |
feature | 특정 서비스 기능이나 역량과 관련된 이벤트입니다. |
이벤트 레벨
이벤트의 level 필드는 이벤트의 심각도 또는 중요도를 나타냅니다:
| 값 | 설명 |
|---|---|
info | 정보 제공용 — 로그, 메트릭 또는 중요하지 않은 알림입니다. |
notice | 상태 변경 또는 주목할 만한 이벤트입니다. |
warning | 문제가 발생했거나 이상이 감지되었지만, 시스템은 안전하게 계속 작동할 수 있습니다. |
error | 시스템의 작동이나 안정성에 영향을 미칠 수 있는 문제가 발생했습니다. |
critical | 시스템 기능을 심각하게 저해하는 중대한 오류입니다. |
panic | 치명적인 오류 — 시스템 충돌이나 복구 불가능한 상태로 이어질 수 있습니다. |
이벤트
이 목록은 시스템에서 현재 보고되고 있는 이벤트의 최신 목록입니다. 당사는 이벤트 유형과 보고 방식을 지속적으로 설계하고 확장하고 있습니다.
입력
invalid-io-channel
I/O 채널이 지원되지 않거나 의도하지 않은 방식으로 사용될 때 발생합니다.
데이터
| 필드 | 유형 | 설명 |
|---|---|---|
received_data | string | 수신된 원시 데이터입니다. |
{
"name": "invalid-io-channel",
"category": "input",
"level": "warning",
"data": {
"received_data": "<raw_input_here>"
}
}
http-route-deprecated
HTTP 라우트가 지원이 중단되어 향후 버전에서 제거될 예정일 때 발생합니다.
데이터
| 필드 | 유형 | 설명 |
|---|---|---|
route | string | 이 경로는 지원이 중단되었습니다. |
substitute | string | 권장 대체 항목입니다. |
{
"name": "http-route-deprecated",
"category": "input",
"level": "warning",
"data": {
"route": "/the/old/way",
"substitute": "/the/new/way"
}
}
settings-invalid-key
설정 키가 유효하지 않을 때 발생합니다.
데이터
| 필드 | 유형 | 설명 |
|---|---|---|
key | string | 해당 키를 찾을 수 없습니다. |
{
"name": "settings-invalid-key",
"category": "input",
"level": "warning",
"data": {
"key": "devices/none-existent/key"
}
}
command-deprecated
수신된 명령이 더 이상 지원되지 않아 향후 버전에서 제거될 예정일 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
command | string | 수신된 지원 중단 명령 |
{
"name": "command-deprecated",
"category": "input",
"level": "warning",
"data": {
"command": "example_cmd"
},
"message": "The command `example_cmd` is deprecated and is replaced by `this_one`."
}
디바이스
device-connected
장치가 연결되어 정상적으로 작동 중임을 나타냅니다.
| 필드 | 유형 | 설명 |
|---|---|---|
device_family | string | 장치 유형: inverse 또는 verse_grip. |
device_id | string | 이 기기의 고유 식별자입니다. |
{
"name": "device-connected",
"category": "device",
"level": "notice",
"data": {
"device_family": "inverse",
"device_id": "04BA"
}
}
device-disconnected
이전에 연결되어 있던 기기의 연결이 해제되었음을 나타냅니다.
| 필드 | 유형 | 설명 |
|---|---|---|
device_family | string | 장치 유형: inverse 또는 verse_grip. |
device_id | string | 이 기기의 고유 식별자입니다. |
{
"name": "device-disconnected",
"category": "device",
"level": "notice",
"data": {
"device_family": "verse_grip",
"device_id": "61548"
}
}
세션
device-low-control-rate
장치에 대한 수신 직접 제어 명령의 속도가 너무 낮아 안전 한계에 도달했을 때 발생합니다. 이는 속도가 차단 속도에 근접하고 있음을 알리는 경고입니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_family | string | 장치 유형: inverse 또는 verse_grip. |
device_id | string | 이 기기의 고유 식별자입니다. |
frequency | int | 현재 제어 주파수(Hz 단위)입니다. |
{
"name": "device-low-control-rate",
"category": "session",
"level": "warning",
"data": {
"session_id": 3,
"device_family": "inverse",
"device_id": "1A2B",
"frequency": 260
},
"message": ""
}
device-critical-control-rate
디바이스에 대한 수신 직접 제어 명령의 속도가 너무 낮아 안전 한계에 도달했을 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_family | string | 장치 유형: inverse 또는 verse_grip. |
device_id | string | 이 기기의 고유 식별자입니다. |
frequency | int | 현재 제어 주파수(Hz 단위)입니다. |
{
"name": "device-critical-control-rate",
"category": "session",
"level": "error",
"data": {
"session_id": 3,
"device_family": "inverse",
"device_id": "1A2B",
"frequency": 82
},
"message": ""
}
기능
sdf-sdf_hfx-created
SDF 엔티티 FX가 생성될 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_id | string | 이 기기의 고유 식별자입니다. |
hfx_id | string | 생성 시 사용된 FX ID입니다. |
{
"name": "sdf-sdf_hfx-created",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}
sdf-sdf_hfx-deleted
SDF 엔티티 FX가 삭제될 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_id | string | 이 기기의 고유 식별자입니다. |
hfx_id | string | 삭제된 FX ID입니다. |
{
"name": "sdf-sdf_hfx-deleted",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}
sdf-sdf_hfx-updated
SDF 엔티티 FX가 업데이트될 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_id | string | 이 기기의 고유 식별자입니다. |
hfx_id | string | 업데이트된 FX ID입니다. |
{
"name": "sdf-sdf_hfx-updated",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}
sdf-sdf_hfx-range-entered
지정된 디바이스의 커서가 SDF 엔티티의 범위에 진입할 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_id | string | 이 기기의 고유 식별자입니다. |
hfx_id | string | FX ID입니다. |
{
"name": "sdf-sdf_hfx-range-entered",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}
sdf-sdf_hfx-range-exited
지정된 디바이스의 커서가 SDF 엔티티의 범위를 벗어날 때 발생합니다.
| 필드 | 유형 | 설명 |
|---|---|---|
session_id | int | 대상 시뮬레이션 세션 ID입니다. |
device_id | string | 이 기기의 고유 식별자입니다. |
hfx_id | string | FX ID입니다. |
{
"name": "sdf-sdf_hfx-range-exited",
"category": "feature",
"level": "notice",
"data": {
"session_id": 3,
"device_id": "1A2B",
"hfx_id": "my_fx_name"
},
"message": ""
}