본문으로 이동

이벤트 채널

이벤트의 기본 웹소켓 URL은 다음과 같습니다. ws://localhost:10020.

설정에서 포트를 변경할 수 있습니다.

이 채널은 저주파의 단방향 통신 채널로, 이를 통해 시스템의 모든 이벤트를 수신할 수 있습니다. 입력 메시지는 지원되지 않습니다.

이 채널은 모든 이벤트 발생 시마다 메시지가 전송되도록 보장합니다.

표준 형식​

모든 이벤트는 아래에 제시된 표준 구조를 따릅니다:

{
  "name": "device-connected",
  "category": "device",
  "level": "notice",
  "data": {},
  "message": ""
}

필드 설명​

챔프유형설명
namestring이벤트의 고유 식별자.
categorystring필터링 및 정리에 사용되는 그룹화 태그(유효한 카테고리 참조).
levelstring사건의 중대성 또는 중요도 (적용 가능한 등급 참조).
dataobject해당 행사에 대한 구체적인 내용이 담긴 업무 지시서.
messagestring이벤트에 대한 선택적 설명 또는 배경 정보로, 사람이 읽을 수 있는 내용입니다.

행사 카테고리​

Le champ category 이벤트를 다음과 같은 범주로 분류합니다:

가치설명
system주요 시스템 또는 중앙 시스템, 전역 설정 등
input외부 입력(예: 명령어 등) 관리.
session특정 사용자 세션과 관련된 이벤트.
device기기 관리, 컨트롤러와의 상호작용, SerialPort 통신.
module하위 시스템 또는 모듈형 구성 요소의 이벤트.
feature서비스의 특정 기능이나 성능과 관련된 이벤트.

이벤트 등급​

Le champ level 사건의 성격은 그 심각성이나 중요성을 나타냅니다:

가치설명
info단순 정보: 신문 기사, 통계 자료 또는 비평적이지 않은 의견.
notice상태 변화 또는 주목할 만한 사건.
warning문제가 발생했거나 비정상적인 것으로 보이지만, 시스템은 안전하게 계속 작동할 수 있습니다.
error시스템의 동작이나 안정성에 영향을 미칠 수 있는 문제가 발생했습니다.
critical시스템 작동에 심각한 지장을 초래하는 중대한 오류입니다.
panic치명적인 오류: 시스템이 중단되거나 복구 불가능한 상태가 될 수 있습니다.

행사​

정보

이 목록은 현재 시스템에서 알림이 전송되고 있는 이벤트들을 보여줍니다. 저희는 이벤트 유형과 알림 방식을 적극적으로 기획하고 확대해 나가고 있습니다.

메인 요리​

invalid-io-channel​

I/O 채널이 지원되지 않거나 예상되지 않은 방식으로 사용될 때 발생합니다.

데이터

챔프유형설명
received_datastring수신된 원시 데이터.
{
  "name": "invalid-io-channel",
  "category": "input",
  "level": "warning",
  "data": {
    "received_data": "<raw_input_here>"
  }
}

http-route-deprecated​

HTTP 경로가 더 이상 사용되지 않으며 향후 버전에서 제거될 예정일 때 발생합니다.

데이터

챔프유형설명
routestring더 이상 쓰이지 않는 길.
substitutestring권장 우회 경로.
{
  "name": "http-route-deprecated",
  "category": "input",
  "level": "warning",
  "data": {
    "route": "/the/old/way",
    "substitute": "/the/new/way"
  }
}

settings-invalid-key​

매개변수 키가 유효하지 않을 때 발생합니다.

데이터

챔프유형설명
keystring찾지 못한 열쇠.
{
  "name": "settings-invalid-key",
  "category": "input",
  "level": "warning",
  "data": {
    "key": "devices/none-existent/key"
  }
}

command-deprecated​

들어오는 명령어가 더 이상 사용되지 않아 향후 버전에서 삭제될 예정일 때 발생합니다.

챔프유형설명
commandstring수신된 더 이상 사용되지 않는 주문
{
  "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_familystring기기 유형: inverse ou verse_grip.
device_idstring기기의 고유 식별자.
{
  "name": "device-connected",
  "category": "device",
  "level": "notice",
  "data": {
    "device_family": "inverse",
    "device_id": "04BA"
  }
}

device-disconnected​

이전에 연결되어 있던 기기가 연결이 끊어졌음을 나타냅니다.

챔프유형설명
device_familystring기기 유형: inverse ou verse_grip.
device_idstring기기의 고유 식별자.
{
  "name": "device-disconnected",
  "category": "device",
  "level": "notice",
  "data": {
    "device_family": "verse_grip",
    "device_id": "61548"
  }
}

세션​

device-low-control-rate​

장치에 대한 직접 제어 명령이 너무 낮은 빈도로 수신되어 안전 한계치에 도달했을 때 발생합니다. 이는 빈도가 한계치에 근접하고 있음을 알리는 경고입니다.

챔프유형설명
session_idint해당 시뮬레이션 세션의 식별자.
device_familystring기기 유형: inverse ou verse_grip.
device_idstring기기의 고유 식별자.
frequencyint현재 검사 주파수(헤르츠).
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_familystring기기 유형: inverse ou verse_grip.
device_idstring기기의 고유 식별자.
frequencyint현재 검사 주파수(헤르츠).
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_idstring기기의 고유 식별자.
hfx_idstring생성 시 사용된 FX 효과의 식별자입니다.
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_idstring기기의 고유 식별자.
hfx_idstring삭제된 FX 효과의 식별자.
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_idstring기기의 고유 식별자.
hfx_idstringFX 효과의 식별자가 업데이트되었습니다.
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_idstring기기의 고유 식별자.
hfx_idstringFX 효과의 식별자.
{
  "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_idint해당 시뮬레이션 세션의 식별자.
device_idstring기기의 고유 식별자.
hfx_idstringFX 효과의 식별자.
{
  "name": "sdf-sdf_hfx-range-exited",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}