メインコンテンツへ移動

イベント情報

イベントのデフォルトのWebSocket URLは ws://localhost:10020.

ポート番号は設定画面で変更可能です。

これは、低周波数の単方向通信チャネルであり、このチャネルを通じてシステムのすべてのイベントを受信することができます。 送信メッセージはサポートされていません。

このチャネルでは、イベントが発生するたびにメッセージが確実に送信されます。

標準形式​

すべてのイベントは、以下に示す標準的な構成に従っています：

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

各フィールドの説明​

チャンピオンタイプ説明
namestringイベントの一意の識別子。
categorystringフィルタリングや整理に使用されるグループ化ラベル（有効なカテゴリを参照）。
levelstring事象の重大性または重要性（有効なレベルを参照）。
dataobject当該イベントに関する詳細情報が記載されたデータセット。
messagestringイベントに関する説明または背景（任意）。人間が読める形式のもの。

イベントのカテゴリー​

ル・シャン category イベントを以下のカテゴリに分類します：

ヴァルール説明
system主要システムまたは中央システム、グローバルパラメータなど。
input外部からの入力（注文など）の管理。
session特定のユーザーセッションに関連するイベント。
deviceデバイスの管理、コントローラとの連携、SerialPortによる通信。
moduleサブシステムまたはモジュール型コンポーネントのイベント。
feature本サービスの特定の機能や性能に関連するイベント。

イベントレベル​

ル・シャン 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対象となるシミュレーションセッションのID。
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対象となるシミュレーションセッションのID。
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対象となるシミュレーションセッションのID。
device_idstringその端末の一意の識別子。
hfx_idstring作成時に使用された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_idint対象となるシミュレーションセッションのID。
device_idstringその端末の一意の識別子。
hfx_idstring削除された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_idint対象となるシミュレーションセッションのID。
device_idstringその端末の一意の識別子。
hfx_idstringFXエフェクトの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_idint対象となるシミュレーションセッションのID。
device_idstringその端末の一意の識別子。
hfx_idstringFXエフェクトの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_idint対象となるシミュレーションセッションのID。
device_idstringその端末の一意の識別子。
hfx_idstringFXエフェクトのID。
{
  "name": "sdf-sdf_hfx-range-exited",
  "category": "feature",
  "level": "notice",
  "data": {
    "session_id": 3,
    "device_id": "1A2B",
    "hfx_id": "my_fx_name"
  },
  "message": ""
}