構造体定義（struct）

本製品の構造体定義を説明します。

定義一覧​

構造体型名	意味合い
StMPXAPIVersion	APIのバージョン情報
StMPXCoreVersion	MicroPeckerXのバージョン情報
StMPXDeviceInfo	MicroPeckerXのデバイス情報
StMPXCANParam	パラメータ設定情報
StMPXCANLogCB	コールバック用ログ情報
StMPXCANLog	ログ取得API用ログ情報
StMPXCANFrameOption	CAN/CAN FDフレームオプション情報
StMPXCANFrameType	CAN/CAN FDフレーム属性情報
StMPXCANID	CAN ID情報
StMPXCANFrame	CAN/CAN FDフレーム情報
StMPXCANSlot	スロット情報
StMPXCANDirect	ダイレクト送信情報
StMPXCANReplayLog	ログ再生送信情報

定義詳細​

StMPXAPIVersion​

StMPXAPIVersion構造体（APIのバージョン情報）のメンバは、以下の通りです。

変数名	型名	意味合い
APIVersion	char [32]	APIのバージョン番号

StMPXCoreVersion​

StMPXCoreVersion構造体（MicroPeckerXのバージョン情報）のメンバは、以下の通りです。

変数名	型名	意味合い
BootVersion	char [16]	Bootのバージョン番号
APPVersion	char [32]	APPのバージョン番号
FPGAVersion	char [32]	FPGA-IPのバージョン番号

StMPXDeviceInfo​

StMPXDeviceInfo構造体（MicroPeckerXのデバイス情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
Serial	unsigned long	シリアル番号	MicroPeckerXに貼付されているシリアルNoシールの記載と同じです。
Model	char [64]	製品型名（例：S810-MX-FD2）

StMPXCANParam​

StMPXCANParam構造体（パラメータ設定情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
EnableTerminate	unsigned char	終端抵抗有無	設定値については「終端抵抗有無」を参照してください。
Mode	unsigned char	動作モード	設定値については「動作モード」を参照してください。
ArbitrationBaudrate	unsigned char	アービトレーションボーレート	設定値については「アービトレーションボーレート」を参照してください。
ArbitrationSamplepoint	unsigned char	アービトレーションサンプルポイント	設定値については「サンプルポイント」を参照してください。
DataBaudrate	unsigned char	データボーレート	設定値については「データボーレート」を参照してください。
DataSamplepoint	unsigned char	データサンプルポイント	設定値については「サンプルポイント」を参照してください。
Reserved	unsigned char [2]	予約領域

StMPXCANLogCB​

StMPXCANLogCB構造体（コールバック用ログ情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
mSec	unsigned long	タイムスタンプ（ミリ秒）	タイムスタンプは、mSecとuSecの値を組み合わせて表現します。 例えば12.345ms（12msと345us）の場合、mSecが12、uSecが345となります。
uSec	unsigned short	タイムスタンプ（マイクロ秒）
LogType	unsigned char	ログ種別	ビットフィールドによる構造体です（詳細は「LogType」を参照）。
DL	unsigned char	データ長	ビットフィールドによる構造体です（詳細は「DL」を参照）。
CAN	unsigned long	CAN情報	ID（ID情報）とErrorInfo（エラー情報）の共用体です。 ErrorInfoとして扱う場合はunsigned long型となります（値の意味合いは「エラー情報」を参照）。 IDとして扱う場合はビットフィールドによる構造体となります（詳細は「ID」を参照）。
Data	unsigned char [64]	データ（D1～D64）	配列の要素番号0～63が、データのD1～D64にそれぞれ対応します。

StMPXCANLog​

StMPXCANLog構造体（ログ取得API用ログ情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
mSec	unsigned long	タイムスタンプ（ミリ秒）	タイムスタンプは、mSecとuSecの値を組み合わせて表現します。 例えば12.345ms（12msと345us）の場合、mSecが12、uSecが345となります。
uSec	unsigned short	タイムスタンプ（マイクロ秒）
Protocol	unsigned char	プロトコル	値の意味合いについては「ログ種別」を参照してください。
Dir	unsigned char	方向	値の意味合いについては「ログ方向」を参照してください。
ID	unsigned long	CAN ID（標準IDまたは拡張ID）	標準IDの場合は、下位11ビット（ビット10～ビット0）にセットされます。
RTR	unsigned char	リモート送信要求（RTR）	値の意味合いについては「リモート送信要求」を参照してください。
IDE	unsigned char	IDフォーマット（IDE）	値の意味合いについては「IDフォーマット」を参照してください。
DL	unsigned char	データ長（DL）
Error	unsigned char	エラーフラグ	値の意味合いについては「エラーフラグ」を参照してください。
ErrorInfo	unsigned long	エラー情報	値の意味合いについては「エラー情報」を参照してください。
Data	unsigned char [64]	データ（D1～D64）	配列の要素番号0～63が、データのD1～D64にそれぞれ対応します。

StMPXCANFrameOption​

StMPXCANFrameOption構造体（CAN/CAN FDフレームオプション情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
Protocol	unsigned char	プロトコル	設定値については「プロトコル」を参照してください。
BRS	unsigned char	ビットレートスイッチ（BRS）	設定値については「ビットレートスイッチ」を参照してください。
ErrorAction	unsigned char	エラーの振る舞い	設定値については「エラーの振る舞い」を参照してください。
Reserved	unsigned char	予約領域

StMPXCANFrameType​

StMPXCANFrameType構造体（CAN/CAN FDフレーム属性情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
isOneShot	unsigned char	ワンショット送信有効/無効	設定値については「ワンショット送信有効/無効」を参照してください。
FrameType	unsigned char	フレーム種別	設定値については「フレーム種別」を参照してください。
Enabled	unsigned char	スロット有効/無効	設定値については「スロット有効/無効」を参照してください。
isLastData	unsigned char	最終フレーム判定	動作モードがログ再生モード、またはバースト転送モード（ログ再生）の場合のみ有効です。 設定値については「最終フレーム判定」を参照してください。
Option	StMPXCANFrameOption	CAN/CAN FDフレームオプション情報

StMPXCANID​

StMPXCANID構造体（CAN ID情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
ID	unsigned long	CAN ID（標準IDまたは拡張ID）	標準IDの場合は、下位11ビット（ビット10～ビット0）にセットしてください。
RTR	unsigned char	リモート送信要求（RTR）	設定値については「リモート送信要求」を参照してください。
IDE	unsigned char	IDフォーマット（IDE）	設定値については「IDフォーマット」を参照してください。
Reserved	unsigned char [2]	予約領域

StMPXCANFrame​

StMPXCANFrame構造体（CAN/CAN FDフレーム情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
ID	StMPXCANID	CAN ID情報
DL	unsigned char	データ長（DL）
Reserved	unsigned char [3]	予約領域
Data	unsigned char [64]	データ（D1～D64）	配列の要素番号0～63が、データのD1～D64にそれぞれ対応します。

StMPXCANSlot​

StMPXCANSlot構造体（スロット情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
SlotNo	unsigned char	スロット番号（1～28）
TriggerType	unsigned char	送信トリガ種別	設定値については「トリガ種別」を参照してください。
Reserved1	unsigned char [2]	予約領域
FrameType	StMPXCANFrameType	フレーム属性情報
TriggerID	StMPXCANID	受信トリガID
msSendDelay	unsigned long	イベント送信での遅延時間（ミリ秒）	イベント送信での遅延時間、送信オフセット、送信周期、送信最低保証間隔は、それぞれ以下の値を組み合わせて表現します。 【イベント送信での遅延時間】 msSendDelay、usSendDelay 【送信オフセット】 msSendOffset、usSendOffset 【送信周期】 msSendCycle、usSendCycle 【送信最低保証間隔】 usMinTransInterval、usMinTransInterval 例えば、送信オフセットに12.345ms（12msと345us）を設定する場合、msSendOffsetが12、usSendOffsetが345となります。
msSendOffset	unsigned long	送信オフセット（ミリ秒）
msSendCycle	unsigned long	送信周期（ミリ秒）
msMinTransInterval	unsigned long	送信最低保証間隔（ミリ秒）
usSendDelay	unsigned short	イベント送信での遅延時間（マイクロ秒）
usSendOffset	unsigned short	送信オフセット（マイクロ秒）
usSendCycle	unsigned short	送信周期（マイクロ秒）
usMinTransInterval	unsigned short	送信最低保証間隔（マイクロ秒）
SendCounter	unsigned short	送信回数	0を設定した場合、送信回数は無制限になります。
Reserved2	unsigned char [2]	予約領域
Frame	StMPXCANFrame	送信フレーム情報
Increment	unsigned char [64]	インクリメント有無	配列の要素番号0～63が、データのD1～D64にそれぞれ対応します。 設定値については「インクリメント有無」を参照してください。

StMPXCANDirect​

StMPXCANDirect構造体（ダイレクト送信情報）のメンバは、以下の通りです。

変数名	型名	意味合い
FrameType	StMPXCANFrameType	フレーム属性情報
Frame	StMPXCANFrame	送信フレーム情報

StMPXCANReplayLog​

StMPXCANReplayLog構造体（ログ再生送信情報）のメンバは、以下の通りです。

変数名	型名	意味合い	備考
mSec	unsigned long	タイムスタンプ（ミリ秒）	タイムスタンプは、mSecとuSecの値を組み合わせて表現します。 例えば12.345ms（12msと345us）の場合、mSecが12、uSecが345となります。
uSec	unsigned short	タイムスタンプ（マイクロ秒）
ID	unsigned long	ID情報	ビットフィールドによる構造体です（詳細は「ID」を参照）。
DL	unsigned char	データ長(DL)	ビットフィールドによる構造体です（詳細は「DL」を参照）。
FrameType	unsigned char	フレーム属性情報	ビットフィールドによる構造体です（詳細は「FrameType」を参照）。
Data	unsigned char [64]	データ（D1～D64）	配列の要素番号0～63が、データのD1～D64にそれぞれ対応します。

補足情報​

ビットフィールド構造体​

LogType​

LogTypeは、unsigned char型のビットフィールドによる構造体となっています。
メンバは以下の通りです。

変数名	ビット数	意味合い	備考
Type	6	ログ種別	値の意味合いについては「ログ種別」を参照してください。
Dir	1	方向	値の意味合いについては「ログ方向」を参照してください。
Error	1	エラーフラグ	値の意味合いについては「エラーフラグ」を参照してください。

DL​

DLは、unsigned char型のビットフィールドによる構造体となっています。
メンバは以下の通りです。

変数名	ビット数	意味合い	備考
NotUsed	4	未使用
DLC	4	データレングスコード（DLC）	データレングスコードとデータ長の関係については「データレングスコードとデータ長」を参照してください。

ID​

IDは、unsigned long型のビットフィールドによる構造体となっています。
メンバは以下の通りです。

変数名	ビット数	意味合い	備考
ID	29	CAN ID（標準IDまたは拡張ID）	標準IDの場合は、下位11ビット（ビット10～ビット0）にセットされます。
Reserved	1	予約領域
RTR	1	リモート送信要求（RTR）	値の意味合いについては「リモート送信要求」を参照してください。
IDE	1	IDフォーマット（IDE）	値の意味合いについては「IDフォーマット」を参照してください。

FrameType​

FrameTypeは、unsigned char型のビットフィールドによる構造体となっています。
メンバは以下の通りです。

変数名	ビット数	意味合い	備考
ErrorPassive	1	エラーの振る舞い	設定値については「エラーの振る舞い」を参照してください。
BRS	1	ビットレートスイッチ（BRS）	設定値については「ビットレートスイッチ」を参照してください。
FDF	1	FDフォーマット（FDF）	設定値については「FDフォーマット」を参照してください。
Terminator	1	最終フレーム判定	設定値については「最終フレーム判定」を参照してください。
Reserved	4	未使用（予約領域）

データレングスコードとデータ長​

データレングスコード（DLC）とデータ長（DL）の関係は以下の通りです。

データレングスコード	データ長
0 (0x0)	0
1 (0x1)	1
2 (0x2)	2
3 (0x3)	3
4 (0x4)	4
5 (0x5)	5
6 (0x6)	6
7 (0x7)	7
8 (0x8)	8
9 (0x9)	12
10 (0xA)	16
11 (0xB)	20
12 (0xC)	24
13 (0xD)	32
14 (0xE)	48
15 (0xF)	64