メインコンテンツへスキップ

事件窓口

WebSocket のデフォルトのイベントアドレスは 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現在の制御周波数（ヘルツ）。
{
  "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現在の制御周波数（ヘルツ）。
{
  "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": ""
}