本文へスキップ

イベントチャンネル

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

ポートは設定で変更できます。

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

このチャネルは、各イベントごとに1つのメッセージが確実に送信されるようにします。

標準形式​

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

{
  "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 または verse_grip.
device_idstringデバイスの固有識別子です。
{
  "name": "device-connected",
  "category": "device",
  "level": "notice",
  "data": {
    "device_family": "inverse",
    "device_id": "04BA"
  }
}

device-disconnected​

以前に接続されていたデバイスの接続が切断されたことを示しています。

フィールドタイプ説明
device_familystringデバイスの種類： inverse または 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 または verse_grip.
device_idstringデバイスの固有識別子です。
frequencyint現在の制御周波数（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_idint対象のシミュレーションセッションIDです。
device_familystringデバイスの種類： inverse または verse_grip.
device_idstringデバイスの固有識別子です。
frequencyint現在の制御周波数（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_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_idstring更新された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_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": ""
}