사건 채널

기본 이벤트 WebSocket 주소는 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`	현재 제어 주파수(헤르츠).

{
  "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`	현재 제어 주파수(헤르츠).

{
  "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": ""
}

표준 형식​

필드 설명​

사건 분류​

사건 등급​

사건​

입력​

invalid-io-channel​

http-route-deprecated​

settings-invalid-key​

command-deprecated​

장비​

device-connected​

device-disconnected​

대화​

device-low-control-rate​

device-critical-control-rate​

기능 및 특징​

sdf-sdf_hfx-created​

sdf-sdf_hfx-deleted​

sdf-sdf_hfx-updated​

sdf-sdf_hfx-range-entered​

sdf-sdf_hfx-range-exited​

표준 형식

필드 설명

사건 분류

사건 등급

사건

입력

`invalid-io-channel`

`http-route-deprecated`

`settings-invalid-key`

`command-deprecated`

장비

`device-connected`

`device-disconnected`

대화

`device-low-control-rate`

`device-critical-control-rate`

기능 및 특징

`sdf-sdf_hfx-created`

`sdf-sdf_hfx-deleted`

`sdf-sdf_hfx-updated`

`sdf-sdf_hfx-range-entered`

`sdf-sdf_hfx-range-exited`