構造体定義(共通)
本製品の共通の構造体定義を説明します。
主に使うAPI
定義一覧
| 型名 | 意味合い |
|---|---|
| StMPXAPIVersion | APIのバージョン情報 |
| StMPXDeviceInfo | MicroPeckerXのデバイス情報 |
| StMPXLog | ログ取得API用ログ情報 |
定義詳細
StMPXAPIVersion
StMPXAPIVersion構造体(APIのバージョン情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| APIVersion | int8_t [32] | APIのバージョン番号 |
StMPXDeviceInfo
StMPXDeviceInfo構造体(MicroPeckerXのデバイス情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| Serial | uint32_t | シリアル番号 | MicroPeckerXに貼付されているシリアルNoシールの記載と同じです。 |
| Model | int8_t [64] | 製品型名(例:S810-MX-FD2) |
StMPXLog
StMPXLog構造体(ログ取得API用ログ情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| mSec | uint32_t | タイムスタンプ(ミリ秒) | タイムスタンプは、mSecとuSecの値を組み合わせて表現します。 例えば12.345ms(12msと345us)の場合、mSecが12、uSecが345となります。 |
| uSec | uint16_t | タイムスタンプ(マイクロ秒) | |
| Protocol | uint8_t | プロトコル | 値の意味合いについては「ログ種別」を参照してください。 |
| Dir | uint8_t | 方向 | 値の意味合いについては「ログ方向」を参照してください。 |
| Misc | union | 雑多情報 | CAN通信とLIN通信で異なる情報を集めた共用体です(詳細は「StMPXLog構造体のMisc」を参照)。 |
| Data | uint8_t [64] | データ | 要素番号(0~63)は、データのD1~D64にそれぞれ対応します。 LIN通信では、DLと同じ要素番号がチェックサムとなります。 |
補足情報
StMPXLog構造体のMisc
StMPXLog構造体のMiscは、プロトコル(CAN/LIN)に応じて「有効な枝」が切り替わる共用体となっています。
以下のようにProtocolの値からプロトコルを判定し、その結果に応じて有効な枝を読んでください(共用体は同一メモリを共有しますので、同時に複数の枝を読むことはできません)。
| 判定条件(Protocol) | 有効メンバ |
|---|---|
| 以下のいずれか MPX_LOG_TYPE_CAN, MPX_LOG_TYPE_CANFD, MPX_LOG_TYPE_CANFD_NOBRS | Misc.CAN |
| MPX_LOG_TYPE_LIN | Misc.LIN |
StMPXLog構造体のMisc.CAN
StMPXLog構造体のMisc.CANは、以下のメンバを有する構造体となっています。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| ID | uint32_t | CAN ID(標準IDまたは拡張ID) | 標準IDの場合は、下位11ビット(ビット10~ビット0)にセットされます。 |
| RTR | uint8_t | リモート送信要求(RTR) | 値の意味合いについては「CANリモート送信要求」を参照してください。 |
| IDE | uint8_t | IDフォーマット(IDE) | 値の意味合いについては「CAN IDフォーマット」を参照してください。 |
| DL | uint8_t | データ長(DL) | |
| Error | uint8_t | エラーフラグ | 値の意味合いについては「CANエラーフラグ」を参照してください。 |
| ErrorInfo | uint32_t | エラー情報 | 値の意味合いについては「CANエラー情報」を参照してください。 |
StMPXLog構造体のMisc.LIN
StMPXLog構造体のMisc.LINは、以下のメンバを有する構造体となっています。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| ID | uint8_t | LIN ID | |
| SBLen | uint8_t | SyncBreak幅 | |
| WakeupWidth | uint16_t | ウェイクアップパルス幅 | |
| Type | uint8_t | LINログ種別 | 値の意味合いについては「LINログ種別」を参照してください。 |
| DL | uint8_t | データ長(DL) | |
| Reserved1 | uint8_t [2] | 予約領域1 | |
| ErrorCode | uint8_t | エラーコード | 値の意味合いについては「LINエラーコード」を参照してください。 |
| Reserved2 | uint8_t [3] | 予約領域2 |