イベントチャンネル
デフォルトのイベントウェブソケットURLは ws://localhost:10020.
設定でポートを変更できます。
これは低周波の単方向通信チャンネルで、すべてのシステム・イベントを受信することができます。 入力メッセージはサポートされていません。
このチャンネルは、イベントごとに1つのメッセージを送信することを保証する。
正規フォーマット
すべてのイベントは以下のような標準的な構成になっている：
{
"name": "device-connected",
"category": "device",
"level": "notice",
"data": {},
"message": ""
}
フィールドの説明
| フィールド | タイプ | 説明 |
|---|---|---|
name | string | イベントの一意識別子。 |
category | string | フィルタリングや整理に使用されるグループ化ラベル（有効なカテゴリーを参照）。 |
level | string | イベントの重大性または重要性（有効レベルを参照）。 |
data | object | イベント固有の詳細を含むペイロード。 |
message | string | オプションで、イベントの人間が読める説明またはコンテキスト。 |
イベントカテゴリー
について category フィールドはイベントを以下のグループに分類している：
| 価値 | 説明 |
|---|---|
system | コアシステムやセントラルシステム、グローバル設定など。 |
input | 外部入力処理（コマンドなど）。 |
session | 特定のユーザーセッションに関連するイベント。 |
device | デバイス管理、コントローラとの相互作用、シリアルポート通信。 |
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": ""
}