イベントチャネル
イベント用のデフォルトのWebSocket 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 イベントを以下のグループに分類しました：
| Wert | 説明 |
|---|---|
system | 主要なコアシステム、グローバル設定など |
input | 外部入力（コマンドなど）の処理。 |
session | 特定のユーザーセッションに関連するイベント。 |
device | デバイス管理、コントローラとの連携、シリアルポート通信。 |
module | サブシステムまたはモジュール型コンポーネントにおける事象。 |
feature | 特定のサービス機能に関連付けられているイベント。 |
イベントレベル
その野原 level ある事象の深刻度や重要度を示す：
| Wert | 説明 |
|---|---|
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 oder 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 oder 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 | シミュレーションセッションのZiel-ID。 |
device_family | string | 機器の種類： inverse oder 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 | シミュレーションセッションのZiel-ID。 |
device_family | string | 機器の種類： inverse oder 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 | シミュレーションセッションのZiel-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 | シミュレーションセッションのZiel-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 | シミュレーションセッションのZiel-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 | シミュレーションセッションのZiel-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 | シミュレーションセッションのZiel-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": ""
}