構造体定義(CAN用)
本製品のCAN用の構造体定義を説明します。
主に使うAPI
- StMPXCANParam: MPXCANSetParam
- StMPXCANLog: MPXCANGetLogEx
- StMPXCANSlot: MPXCANSetSlot
- StMPXCANFrame: MPXCANChangeSlot
- StMPXCANDirect: MPXCANDirectSend
定義一覧
| 型名 | 意味合い |
|---|---|
| StMPXCANParam | CANパラメータ設定情報 |
| StMPXCANLog | CANログ取得API用ログ情報 |
| StMPXCANFrameOption | CANフレームオプション情報 |
| StMPXCANFrameType | CANフレーム属性情報 |
| StMPXCANID | CAN ID情報 |
| StMPXCANFrame | CANフレーム情報 |
| StMPXCANSlot | CANスロット情報 |
| StMPXCANDirect | CANダイレクト送信情報 |
定義詳細
StMPXCANParam
StMPXCANParam構造体(CANパラメータ設定情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| EnableTerminate | uint8_t | 終端抵抗有無 | 設定値については「CAN終端抵抗有無」を参照してください。 |
| Mode | uint8_t | 動作モード | 設定値については「CAN動作モード」を参照してください。 |
| ArbitrationBaudrate | uint8_t | アービトレーションボーレート | 設定値については「CANアービトレーションボーレート」を参照してください。 |
| ArbitrationSamplepoint | uint8_t | アービトレーションサンプルポイント | 設定値については「CANサンプルポイント」を参照してください。 |
| DataBaudrate | uint8_t | データボーレート | 設定値については「CANデータボーレート」を参照してください。 |
| DataSamplepoint | uint8_t | データサンプルポイント | 設定値については「CANサンプルポイント」を参照してください。 |
| Reserved | uint8_t [2] | 予約領域 |
ヒント
設定可能なサンプルポイントは、アービトレーションボーレートとデータボーレートの組み合わせによって異なります。
詳細については「ボーレートとサンプルポイントの設定値」を参照してください。
StMPXCANLog
StMPXCANLog構造体(CANログ取得API用ログ情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| mSec | uint32_t | タイムスタンプ(ミリ秒) | タイムスタンプは、mSecとuSecの値を組み合わせて表現します。 例えば12.345ms(12msと345us)の場合、mSecが12、uSecが345となります。 |
| uSec | uint16_t | タイムスタンプ(マイクロ秒) | |
| Protocol | uint8_t | プロトコル | 値の意味合いについては「ログ種別」を参照してください。 |
| Dir | uint8_t | 方向 | 値の意味合いについては「ログ方向」を参照してください。 |
| 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エラー情報」を参照してください。 |
| Data | uint8_t [64] | データ | 要素番号(0~63)は、データのD1~D64にそれぞれ対応します。 |
StMPXCANFrameOption
StMPXCANFrameOption構造体(CANフレームオプション情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| Protocol | uint8_t | プロトコル | 設定値については「CANプロトコル」を参照してください。 |
| BRS | uint8_t | ビットレートスイッチ(BRS) | 設定値については「CANビットレートスイッチ」を参照してください。 |
| ErrorAction | uint8_t | エラーの振る舞い | 設定値については「CANエラーの振る舞い」を参照してください。 |
| Reserved | uint8_t | 予約領域 |
StMPXCANFrameType
StMPXCANFrameType構造体(CANフレーム属性情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| isOneShot | uint8_t | ワンショット送信有効/無効 | 設定値については「CANワンショット送信」を参照してください。 |
| FrameType | uint8_t | フレーム種別 | 設定値については「CANフレーム種別」を参照してください。 |
| Enabled | uint8_t | スロット有効/無効 | 設定値については「CANスロット有効/無効」を参照してください。 |
| Reserved | uint8_t | 予約領域 | |
| Option | StMPXCANFrameOption | CANフレームオプション情報 |
StMPXCANID
StMPXCANID構造体(CAN ID情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| ID | uint32_t | CAN ID(標準IDまたは拡張ID) | 標準IDの場合は、下位11ビット(ビット10~ビット0)にセットしてください。 |
| RTR | uint8_t | リモート送信要求(RTR) | 設定値については「リモート送信要求」を参照してください。 |
| IDE | uint8_t | IDフォーマット(IDE) | 設定値については「CAN IDフォーマット」を参照してください。 |
| Reserved | uint8_t [2] | 予約領域 |
StMPXCANFrame
StMPXCANFrame構造体(CANフレーム情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| ID | StMPXCANID | CAN ID情報 | |
| DL | uint8_t | データ長(DL) | 設定可能な値は0~8、12、16、20、24、32、48、64です。 |
| Reserved | uint8_t [3] | 予約領域 | |
| Data | uint8_t [64] | データ(D1~D64) | 要素番号(0~63)は、データのD1~D64にそれぞれ対応します。 |
StMPXCANSlot
StMPXCANSlot構造体(スロット情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い | 備考 |
|---|---|---|---|
| SlotNo | uint8_t | スロット番号(1~28) | |
| TriggerType | uint8_t | 送信トリガ種別 | 設定値については「CAN送信トリガ種別」を参照してください。 |
| Reserved1 | uint8_t [2] | 予約領域 | |
| FrameType | StMPXCANFrameType | CANフレーム属性情報 | |
| TriggerID | StMPXCANID | 受信トリガID | |
| msSendDelay | uint32_t | イベント送信での遅延時間(ミリ秒) | イベント送信での遅延時間、送信オフセット、送信周期、送信最低保証間隔は、それぞれ以下の値を組み合わせて表現します。 【イベント送信での遅延時間】 msSendDelay、usSendDelay 【送信オフセット】 msSendOffset、usSendOffset 【送信周期】 msSendCycle、usSendCycle 【送信最低保証間隔】 usMinTransInterval、usMinTransInterval 例えば、送信オフセットに12.345ms(12msと345us)を設定する場合、msSendOffsetが12、usSendOffsetが345となります。 |
| msSendOffset | uint32_t | 送信オフセット(ミリ秒) | |
| msSendCycle | uint32_t | 送信周期(ミリ秒) | |
| msMinTransInterval | uint32_t | 送信最低保証間隔(ミリ秒) | |
| usSendDelay | uint16_t | イベント送信での遅延時間(マイクロ秒) | |
| usSendOffset | uint16_t | 送信オフセット(マイクロ秒) | |
| usSendCycle | uint16_t | 送信周期(マイクロ秒) | |
| usMinTransInterval | uint16_t | 送信最低保証間隔(マイクロ秒) | |
| SendCounter | uint16_t | 送信回数 | 0を設定した場合、送信回数は無制限になります。 |
| Reserved2 | uint8_t [2] | 予約領域 | |
| Frame | StMPXCANFrame | CANフレーム情報 | |
| Increment | uint8_t [64] | インクリメント有無 | 要素番号(0~63)は、データのD1~D64にそれぞれ対応します。 設定値については「CANインクリメント有無」を参照してください。 |
StMPXCANDirect
StMPXCANDirect構造体(CANダイレクト送信情報)のメンバは、以下の通りです。
| 変数名 | 型名 | 意味合い |
|---|---|---|
| FrameType | StMPXCANFrameType | CANフレーム属性情報 |
| Frame | StMPXCANFrame | CANフレーム情報 |