API詳細
本製品で使用できる各APIの詳細を説明します。
凡例
このページでは、各APIの詳細を以下の形式で説明します。
| 形式 | [関数の型] [関数名]([引数], ...) | |||
|---|---|---|---|---|
| 引数 | [引数の型] | [引数名] | [in/out] | [引数の説明] |
| 戻り値 | [戻り値の型] | [戻り値(エラーコード)] | [戻り値(エラーコード)の説明] | |
| 機能 | [関数の機能の説明] | |||
| 補足 | [関数の補足説明] | |||
[引数の型]が構造体となっている場合、構造体にセットする値、またはセットされる値については「構造体定義(struct)」を参照してください。
[in/out]は、関数の呼び出し時にセットする場合はin、関数の処理でセットされる場合はoutになります。
API詳細
MPXGetAPIVersion
本APIのバージョン情報を取得します。
| 形式 | ER MPXGetAPIVersion(StMPCANVersion * Version) | |||
|---|---|---|---|---|
| 引数 | StMPXAPIVersion * | Version | out | APIのバージョン情報 |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常(NULLポインタ指定など) | |||
| 機能 | 本APIのバージョン情報を取得します。 | |||
MPXOpen
MicroPeckerX本体を認識させます。
| 形式 | ER MPXOpen(StMPXDeviceInfo * Devices, unsigned char * Count) | |||
|---|---|---|---|---|
| 引数 | StMPXDeviceInfo * | Devices | out | 認識したMicroPeckerX本体のデバイス情報 |
| unsigned char * | Count | out | 認識したMicroPeckerX本体の台数 | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | PCに接続しているMicroPeckerX本体を認識させ、認識したMicroPeckerX本体の台数とデバイス情報を取得します。 | |||
| 補足 | 複数のMicroPeckerX本体をPCに接続している場合、その中から最大4台まで同時に認識させることができます。ただし、認識させるMicroPeckerX本体を任意で指定することはできません。 | |||
MPXClose
MicroPeckerX本体の認識を解除します。
| 形式 | ER MPXClose(void) | |||
|---|---|---|---|---|
| 戻り値 | ER | E_OK | 正常終了 | |
| 機能 | 認識中のMicroPeckerX本体の認識を全て解除します。 | |||
MPXSetLED
MicroPeckerXのLEDを制御します。
| 形式 | ER MPXSetLED(unsigned long Serial, unsigned char LEDRed, unsigned char LEDGreen, unsigned char LEDGreenBlink, unsigned char LEDYellow, unsigned char LEDYellowBlink) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | LEDRed | in | 赤色LED点灯 (指定可能な値は「LED設定」を参照) | |
| unsigned char | LEDGreen | in | 緑色LED点灯 (指定可能な値は「LED設定」を参照) | |
| unsigned char | LEDGreenBlink | in | 緑色LED点滅 (指定可能な値は「LED設定」を参照) | |
| unsigned char | LEDYellow | in | 黄色LED点灯 (指定可能な値は「LED設定」を参照) | |
| unsigned char | LEDYellowBlink | in | 黄色LED点滅 (指定可能な値は「LED設定」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerX本体のLEDを制御します。 赤色LEDは、LEDRedにMPX_LED_ONを指定すると点灯し、MPX_LED_OFFを指定すると消灯します。 緑色LEDは、LEDGreenにMPX_LED_ONを指定すると点灯し、MPX_LED_OFFを指定すると消灯します。また、LEDGreenBlinkにMPX_LED_ONを指定すると、LEDGreenの指定値に関わらず点滅します。 黄色LEDは、LEDYellowにMPX_LED_ONを指定すると点灯し、MPX_LED_OFFを指定すると消灯します。また、LEDYellowBlinkにMPX_LED_ONを指定すると、LEDYellowの指定値に関わらず点滅します。 | |||
MPXGetStatus
MicroPeckerX本体のステータスを取得します。
| 形式 | ER MPCANGetStatus(unsigned long Serial, unsigned short * StatusCh1, unsigned short * StatusCh2) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned short * | StatusCh1 | out | CH1のステータス (セットされる値は「MicroPeckerXステータス」を参照) | |
| unsigned short * | StatusCh2 | out | CH2のステータス (セットされる値は「MicroPeckerXステータス」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerX本体の各CHのステータスを取得します。 | |||
MPXMonitorStart
モニタリングを開始します。
| 形式 | ER MPXMonitorStart(unsigned long Serial, unsigned char SyncMode) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | SyncMode | in | 同期モード (指定可能な値は「同期モード」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerXのモニタリングを開始します。 SyncModeにMPX_SYNC_MASTERを指定した場合はマスタモード、MPX_SYNC_SLAVEを指定した場合はスレーブモードでそれぞれ 動作します。 「MPXSetSlot」でスロット情報を設定していた場合は、フレーム種別にMPX_CAN_FRAME_TYPE_PERIODICまたはMPX_CAN_FRAME_TYPE_EVENTPERIODICを指定しているスロットのフレーム送信も開始します。 | |||
| 補足 | 本APIを呼び出してモニタリングを開始する前に、「MPXSetCANParam」を呼び出して通信パラメータを設定する必要があります。 複数のMicroPeckerX本体を動作させる場合は、スレーブモードで動作させる全てのMicroPeckerX本体のモニタリングを開始してから、マスタモードで動作させるMicroPeckerX本体のモニタリングを開始してください。 | |||
MPXMonitorStop
モニタリングを停止します。
| 形式 | ER MPXMonitorStop(unsigned long Serial, unsigned long * mSec, unsigned short * uSec) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned long * | mSec | out | タイムスタンプ(ミリ秒) | |
| unsigned short * | uSec | out | タイムスタンプ(マイクロ秒) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerX本体のモニタリングを停止し、その時点でのタイムスタンプを取得します。 mSecとuSecにセットされたタイムスタンプは、その時点までに受信したログの内容が保証されることを意味します。 | |||
| 補足 | 複数のMicroPeckerX本体を動作させている場合は、マスタモードで動作しているMicroPeckerX本体のモニタリングを停止させてから、スレーブモードで動作しているMicroPeckerX本体のモニタリングを順次停止させてください。 | |||
MPXGetTimeStamp
タイムスタンプを取得します。
| 形式 | ER MPXGetTimeStamp(unsigned long Serial, unsigned long * mSec, unsigned short * uSec) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned long * | mSec | out | タイムスタンプ(ミリ秒) | |
| unsigned short * | uSec | out | タイムスタンプ(マイクロ秒) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerX本体の現在のタイムスタンプを取得します。 取得したタイムスタンプはmSecとuSecにセットされます。 | |||
| 補足 | mSecとuSecにセットされるタイムスタンプの値は、本APIを呼び出したタイミングとのタイムラグがあることに注意してください。 | |||
MPXSetGetLogMode
モニタリング中のログ情報(送受信データ)を取得する方法を設定します。
| 形式 | ER MPXSetGetLogMode(unsigned long Serial, unsigned char InnerCh, unsigned char Mode) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| unsigned char | Mode | in | ログ取得モード (指定可能な値は「ログ取得モード」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報の受信方法を設定します。 ModeにMPX_GETLOG_CALLBACKを指定するとコールバック関数モード、MPX_GETLOG_GETLOGAPIを指定するとログ取得APIモードで、それぞれ動作します。 | |||
| 補足 | コールバック関数モードに設定した場合は、「MPXSetLogCallBack」を呼び出してログ情報の取得に使用するコールバック関数を設定する必要があります。 ログ取得APIモードに設定した場合は、「MPXGetLog」または「MPXGetLogEx」を呼び出してログ情報を定期的に取得する必要があります。 | |||
MPXSetLogCallBack
モニタリング中のログ情報(送受信データ)を取得するためのコールバック関数を設定します。
| 形式 | ER MPXSetLogCallBack(unsigned long Serial, unsigned char InnerCh, void * Self, unsigned char ** Log1, unsigned char ** Log2, void (* CallBack) (unsigned long, unsigned char, void *, unsigned char, unsigned short)) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| void * | Self | in | 呼び出し元クラスポインタ | |
| unsigned char ** | Log1 | in | ログ情報を格納する配列のポインタ | |
| unsigned char ** | Log2 | in | ログ情報を格納する配列のポインタ | |
| 関数ポインタ | CallBack | in | コールバック関数のポインタ | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報を取得するためのコールバック関数を設定します。 CallBackで指定するコールバック関数の引数は、それぞれ以下の通りです。 【第1引数:unsigned long型】 対象のMicroPeckerXのシリアル番号 【第2引数:unsigned char型】 対象のCH番号(1または2) 【第3引数:void *型】 呼び出し元クラスポインタ 【第4引数:unsigned char型】 ログ情報の格納先(Log1の場合は1、Log2の場合は2) 【第5引数:unsigned short型】 有効なログの件数(サイズではありません) | |||
| 補足 | 本APIは、コールバック関数モードでログ情報を取得する場合のみ有効です。 | |||
MPXGetLog
モニタリング中のログ情報(送受信データ)を、DLL内に確保されているログ情報構造体バッファから取得します。
| 形式 | ER MPXGetLog(unsigned long Serial, unsigned char InnerCh, StMPXCANLog ** Log, unsigned short * Count, unsigned char * BufferOver) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANLog ** | Log | out | ログ情報構造体配列のポインタ | |
| uunsigned short * | Count | out | 取得したログ情報件数 | |
| unsigned char * | BufferOver | out | バッファオーバーラン (セットされる値は「バッファオーバーラン有無」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報を取得します。 取得したログ情報は、DLL内に確保されているログ情報構造体バッファの先頭ポインタがLogに、件数がCountにそれぞれセットされます。 バッファオーバーランが発生した場合は、BufferOverにMPX_LOG_BUFOVER_TRUEがセットされます。 | |||
| 補足 | 本APIは、ログ取得APIモードでログ情報を取得する場合のみ有効です。 本APIでは、取得したログ情報を格納するための構造体配列を呼び出し元で用意する必要はありません。 | |||
MPXGetLogEx
モニタリング中のログ情報(送受信データ)を、呼び出し元で用意したログ情報構造体配列に取得します。
| 形式 | ER MPXGetLog(unsigned long Serial, unsigned char InnerCh, StMPXCANLog * Log, unsigned short Num, unsigned short * Count, unsigned char * BufferOver) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANLog * | Log | in/out | ログ情報構造体配列 | |
| unsigned short | Num | in | ログ情報構造体配列の要素数 | |
| uunsigned short * | Count | out | 取得したログ情報件数 | |
| unsigned char * | BufferOver | out | バッファオーバーラン (セットされる値は「バッファオーバーラン有無」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報を取得します。 Logには取得したログ情報をセットするための構造体配列を、Numには配列の要素数を、それぞれ指定してください。 取得したログ情報の件数はCountにセットされます。 CountがNumより大きい場合はバッファオーバーランが発生し、BufferOverにMPX_LOG_BUFOVER_TRUEがセットされます。 | |||
| 補足 | 本APIは、ログ取得APIモードでログ情報を取得する場合のみ有効です。 本APIでは、取得したログ情報を格納するための構造体配列を呼び出し元で用意する必要があります。 | |||
MPXSetCANParam
CANまたはCAN FDの通信パラメータを、既定の選択肢から設定します。
| 形式 | ER MPXSetCANParam(unsigned long Serial, unsigned char InnerCh, StMPXCANParam * Param) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANParam * | Param | in | パラメータ設定情報構造体のポインタ | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、CANまたはCAN FDの通信パラメータをParamの指定値で設定します。 | |||
| 補足 | 本APIの呼び出しにより、MicroPeckerXステータスがMPX_STATUS_PARAM(パラメータ設定待ち状態)に変化します。 | |||
MPXSetSlot
CANまたはCAN FDのスロット情報を、モニタリング開始前に設定します。
| 形式 | ER MPXSetSlot(unsigned long Serial, unsigned char InnerCh, StMPXCANSlot * Slots, unsigned char SlotCount) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANSlot * | Slots | in | スロット情報 | |
| unsigned char | SlotCount | in | 設定スロット数 | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、CANまたはCAN FDのスロット情報を設定します。 Slotsには設定したいスロット数分のスロット情報構造体配列を、SlotCountには配列の要素数を、それぞれセットしてください。 | |||
| 補足 | 本APIは、モニタリングの開始前にスロット情報を設定するためのものです。 モニタリング中にスロット情報を設定したい場合は、「MPXChangeSlot」を呼び出してください。 | |||
MPXChangeSlot
CANまたはCAN FDのスロット情報を 、モニタリング中に設定します。
| 形式 | ER MPCANChangeSlotData(unsigned long Serial, unsigned char InnerCh, unsigned char SlotNo, unsigned char SlotEnabled, unsigned char ReqInfo, StMPXCANFrame * Frame) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| unsigned char | SlotNo | in | 対象のスロット番号(1~28) | |
| unsigned char | SlotEnabled | in | スロットの有効/無効 (指定可能な値は「スロット有効/無効」を参照) | |
| unsigned char | ReqInfo | in | スロット変更の要求情報 (指定可能な値は「スロット変更の要求情報」を参照) | |
| StMPXCANFrame * | Frame | in | フレーム属性情報構造体のポインタ | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TRG_BUSY | トリガ設定失敗 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、SlotNoに指定したCANまたはCAN FDのスロット情報をモニタリング中に設定します。 | |||
| 補足 | 本APIは、モニタリング中にスロットの有効/無効、CAN/CAN FDのフレーム情報の設定を変更するためのものです。 モニタリングの開始前にスロット情報を設定したい場合は、「MPXSetSlot」を呼び出してください。 | |||
MPXSendSlot
CANまたはCAN FDのスロットへの送信要求を行います。
| 形式 | ER MPXSendSlot(unsigned long Serial, unsigned char Inner_Ch, unsigned char SlotNo) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| unsigned char | SlotNo | in | 対象のスロット番号(1~28) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TRG_BUSY | トリガ設定失敗 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、SlotNoに指定したCANまたはCAN FDのスロットへの送信要求を行います。 | |||
| 補 足 | 本APIは、「MPXSetSlot」で設定したスロット情報において、SlotNoに指定したスロットのフレーム種別がMPX_CAN_FRAME_TYPE_PERIODICまたはMPX_CAN_FRAME_TYPE_EVENTPERIODICの場合のみ有効です。 | |||
MPXDirectSend
スロットを介さずに直接CANまたはCAN FDのフレームを送信します。
| 形式 | ER MPXDirectSend(unsigned long Serial, unsigned char InnerCh, StMPXCANDirect Frame) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANDirect | Frame | in | 送信フレーム | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_DCT_FULL | ダイレクト送信バッファ空きなし | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、スロットを介さずにFrameで指定したフレームの送信要求を行います。 | |||
MPXSetLogRequestCallBack
ログ再生モード、またはバースト転送モード(ログ再生)での動作中に、MicroPeckerX本体からログ再生用データを要求された時のコールバック関数を設定します。
| 形式 | ER MPXSetLogRequestCallBack(unsigned long Serial, unsigned char InnerCh, void * Self, void (* CallBack ) (unsigned long, unsigned char, void *, unsigned char, unsigned short)) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| void * | Self | in | 呼び出し元クラスポインタ | |
| 関数ポインタ | CallBack | in | コールバック関数のポインタ | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHからログ再生用データの送信を促された時のコールバック関数を設定します。 コールバック関数の引数は、それぞれ以下の通りです。 【第1引数:unsigned long型】 対象のMicroPeckerXのシリアル番号 【第2引数:unsigned char型】 対象のCH番号(1または2) 【第3引数:void *型】 呼び出し元クラスポインタ 【第4引数:unsigned char型】 ログ枯渇発生フラグ 【第5引数:unsigned short型】 受け入れ可能なログのサイズ(バイト数) | |||
| 補足 | 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_LOGREPLAYまたはMPX_MODE_CAN_BURST_LOGの場合のみ有効です。 | |||
MPXSetLogReplayData
ログ再生モード、またはバースト転送モード(ログ再生)で使用するログ再生用データをMicroPeckerX本体に送信します。
| 形式 | ER MPXSetLogReplayData (unsigned long Serial, unsigned char InnerCh, unsigned char * Log, unsigned long LogCount) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| unsigned char * | Log | in | ログ再生用データ | |
| unsigned long | LogCount | in | ログ再生用データのサイズ(バイト数) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_LOG_OVER | ログ再生データ数オーバー | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、ログ再生用データを送信します。 Logには送信するログ再生用データ配列の先頭番地を、LogCountには配列のサイズを、それぞれセットしてください。 | |||
| 補足 | ログ再生用データは、複数のフレーム情報が連続した配列となります。フレーム情報の構造体については「StMPXCANReplayLog」を参照してください。ただし、データ(D1~D64)は可変長となります。 各々のフレーム情報において、データ長が奇数の場合は、最終データの後に1バイトのパディング(値は不定でかまいません)が必要となります。 一度に送信可能なログ再生用データのサイズは、最大16384バイトです。 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_LOGREPLAYまたはMPX_MODE_CAN_BURST_LOGの場合のみ有効です。 | |||
MPXSetBurstLog
バースト転送モード(1フレーム)で使用するフレーム情報を設定します。
| 形式 | ER MPXSetBurstLog(unsigned long Serial, unsigned char InnerCh, StMPXCANSlot * Frame) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXCANSlot * | Frame | in | フレーム情報 | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、Frameで指定したバースト転送モード(1フレーム)用のフレーム情報を設定します。 | |||
| 補足 | 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_BURST_FRMの場合のみ有効です。 | |||
MPXSetLogReplayTrigger
ログ再生モード、またはバースト転送モード(ログ再生)において、ログ再生用データの送信を開始するトリガ条件を設定します。
| 形式 | ER MPXSetLogReplayTrigger(unsigned long Serial, unsigned char InnerCh, unsigned char TriggerType, StMPXCANId TriggerID) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| unsigned char | TriggerType | in | トリガ種別 (指定可能な値は「トリガ種別」を参照) | |
| StMPXCANId | TriggerID | in | トリガID | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、ログ再生用データの送信を開始するトリガ条件を設定します。 | |||
| 補足 | 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_LOGREPLAYまたはMPX_MODE_CAN_BURST_LOGの場合のみ有効です。 動作モードがMPX_MODE_CAN_BURST_FRMの場合は、本APIを呼び出さないでください。 | |||
MPXLogReplayStart
ログ再生モード、またはバースト転送モードでの送信を開始します。
| 形式 | ER MPXLogReplayStart(unsigned long Serial, unsigned char InnerCh) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TRG_BUSY | トリガ設定失敗 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、ログ再生用データまたはバースト転送モード用フレームの送信を開始します。 | |||
| 補足 | モニタリングの開始直後から送信を開始したい場合は、先に本APIを呼び出してからモニタリングを開始してください。 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_LOGREPLAY、MPX_MODE_CAN_BURST_FRM、MPX_MODE_CAN_BURST_LOGのいずれかである場合のみ有効です。 | |||
MPXLogReplayStop
ログ再生モード、またはバースト転送モードでの送信を停止します。
| 形式 | ER MPXLogReplayStop(unsigned long Serial, unsigned char InnerCh) | |||
|---|---|---|---|---|
| 引数 | unsigned long | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| unsigned char | InnerCh | in | 対象のCH番号(1または2) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHに対して、ログ再生用データまたはバースト転送モード用フレームの送信を停止します。 | |||
| 補足 | 本APIは、「MPXSetCANParam」で設定した通信パラメータにおいて、動作モードがMPX_MODE_CAN_LOGREPLAY、MPX_MODE_CAN_BURST_FRM、MPX_MODE_CAN_BURST_LOGのいずれかである場合のみ有効です。 | |||