API詳細(共通)
本製品で使用できる各APIのうち、共通のAPIの詳細を説明します。
先に確認する導線
- 目的別の呼び出し順を先に確認する場合: 共通APIの使い方(目的別)
- 共通の定数を確認する場合: 定数定義(共通)
- 共通の構造体を確認する場合: 構造体定義(共通)
- CAN/LINの実装対応表を確認する場合: CAN API対応表, LIN API対応表
APIクイック参照(定数/構造体/前提/最小例)
| API | このAPIで使う定数 | このAPIで使う構造体 | 呼び出し前提ステータス | 最小コード例(C++/Python) |
|---|---|---|---|---|
| MPXGetAPIVersion | API戻り値 | StMPXAPIVersion | 未認識/認識中 | 共通導入 |
| MPXOpen | API戻り値 | StMPXDeviceInfo | 未認識 | 共通導入 |
| MPXClose | API戻り値 | - | 認識中 | 共通導入 |
| MPXSetLED | LED設定 | - | RUN/PARAM | 共通導入 |
| MPXGetStatus | MicroPeckerXステータス | - | 認識中 | 共通導入 |
| MPXMonitorStart | 同期モード, MicroPeckerXステータス | - | PARAM | 共通導入 |
| MPXMonitorStop | API戻り値 | - | SYNC/NONE/MON/SIM | 共通導入 |
| MPXGetTimeStamp | API戻り値 | - | NONE/MON/SIM | 共通導入 |
| MPXSetGetLogMode | ログ取得モード | - | RUN/PARAM | - |
| MPXGetLog | バッファオーバーラン有無 | StMPXLog | NONE/MON/SIM | CAN G++サンプル, LIN G++サンプル |
凡例
このページでは、各APIの詳細を以下の形式で説明します。
| 形式 | [関数の型] [関数名]([引数], ...) | |||
|---|---|---|---|---|
| 引数 | [引数の型] | [引数名] | [in/out] | [引数の説明] |
| 戻り値 | [戻り値の型] | [戻り値(エラーコード)] | [戻り値(エラーコード)の説明] | |
| 機能 | [関数の機能の説明] | |||
| 補足 | [関数の補足説明] | |||
[引数の型]が構造体となっている場合、構造体にセットする値、またはセットされる値については「構造体定義(struct)」を参照してください。
[in/out]は、関数の呼び出し時にセットする場合はin、関数の処理でセットされる場合はoutになります。
API詳細
MPXGetAPIVersion
本APIのバージョン情報を取得します。
| 形式 | ER MPXGetAPIVersion(StMPXAPIVersion * Version) | |||
|---|---|---|---|---|
| 引数 | StMPXAPIVersion * | Version | out | APIのバージョン情報 |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常(NULLポインタ指定など) | |||
| 機能 | 本APIのバージョン情報を取得します。 | |||
MPXOpen
MicroPeckerX本体を認識させます。
| 形式 | ER MPXOpen(StMPXDeviceInfo * Devices, uint8_t Num, uint8_t * Count) | |||
|---|---|---|---|---|
| 引数 | StMPXDeviceInfo * | Devices | in/out | デバイス情報構造体配列 |
| uint8_t | Num | in | デバイス情報構造体配列の要素数 | |
| uint8_t * | Count | out | 認識したMicroPeckerX本体の台数 | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | PCに接続しているMicroPeckerX本体を認識させます。 Devicesには認識したMicroPeckerX本体のデバイス情報をセットするための構造体配列を、Numには配列の要素数を、それぞれ指定してください。 取得したデバイス情報の件数はCountにセットされます。 | |||
| 補足 | 複数のMicroPeckerX本体をPCに接続している場合、その中からNumに指定した台数(最大4台)まで同時に認識させることができます。ただし、認識させるMicroPeckerX本体を任意で指定することはできません。 | |||
MPXClose
MicroPeckerX本体の認識を解除します。
| 形式 | ER MPXClose(void) | |||
|---|---|---|---|---|
| 戻り値 | ER | E_OK | 正常終了 | |
| 機能 | 認識中のMicroPeckerX本体の認識を全て解除します。 | |||
MPXSetLED
MicroPeckerXのLEDを制御します。
| 形式 | ER MPXSetLED(uint32_t Serial, uint8_t LEDRed, uint8_t LEDGreen, uint8_t LEDGreenBlink, uint8_t LEDYellow, uint8_t LEDYellowBlink) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint8_t | LEDRed | in | 赤色LED点灯 (指定可能な値は「LED設定」を参照) | |
| uint8_t | LEDGreen | in | 緑色LED点灯 (指定可能な値は「LED設定」を参照) | |
| uint8_t | LEDGreenBlink | in | 緑色LED点滅 (指定可能な値は「LED設定」を参照) | |
| uint8_t | LEDYellow | in | 黄色LED点灯 (指定可能な値は「LED設定」を参照) | |
| uint8_t | 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 MPXGetStatus(uint32_t Serial, uint16_t * StatusCh1, uint16_t * StatusCh2) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint16_t * | StatusCh1 | out | CH1のステータス (セットされる値は「MicroPeckerXステータス」を参照) | |
| uint16_t * | StatusCh2 | out | CH2のステータス (セットされる値は「MicroPeckerXステータス」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerX本体の各CHのステータスを取得します。 | |||
MPXMonitorStart
モニタリングを開始します。
| 形式 | ER MPXMonitorStart(uint32_t Serial, uint8_t SyncMode) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint8_t | SyncMode | in | 同期モード (指定可能な値は「同期モード」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| E_COMM | 通信異常 | |||
| E_STATUS | ステータス異常 | |||
| E_TIMEOUT | 通信タイムアウト | |||
| 機能 | Serialに指定したMicroPeckerXのモニタリングを開始します。 SyncModeにMPX_SYNC_MASTERを指定した場合はマスタモード、MPX_SYNC_SLAVEを指定した場合はスレーブモードでそれぞれ動作します。 CAN通信では、「MPXCANSetSlot」でスロット情報を設定していた場合、フレーム種別にMPX_CAN_FRAME_TYPE_PERIODICまたはMPX_CAN_FRAME_TYPE_EVENTPERIODICを指定しているスロットのフレーム送信も開始します。 LIN通信では、「MPXLINSetMasterSim」でマスタシミュレーションを設定していた場合、「MPXLINChangeMasterSchedule」で指定したスケジュールでのフレーム送信も開始します。 | |||
| 補足 | 本APIを呼び出してモニタリングを開始する前に、「MPXCANSetParam」または「MPXLINSetParam」を呼び出して通信パラメータを設定する必要があります。 複数のMicroPeckerX本体を動作させる場合は、スレーブモードで動作させる全てのMicroPeckerX本体のモニタリングを開始してから、マスタモードで動作させるMicroPeckerX本体のモニタリングを開始してください。 | |||
MPXMonitorStop
モニタリングを停止します。
| 形式 | ER MPXMonitorStop(uint32_t Serial, uint32_t * mSec, uint16_t * uSec) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint32_t * | mSec | out | タイムスタンプ(ミリ秒) | |
| uint16_t * | 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(uint32_t Serial, uint32_t * mSec, uint16_t * uSec) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint32_t * | mSec | out | タイムスタンプ(ミリ秒) | |
| uint16_t * | 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(uint32_t Serial, uint8_t InnerCh, uint8_t Mode) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint8_t | InnerCh | in | 対象のCH番号(1または2) | |
| uint8_t | Mode | in | ログ取得モード (指定可能な値は「ログ取得モード」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報の受信方法を設定します。 ModeにはMPX_GETLOG_GETLOGAPI(ログ取得APIモード)のみ指定可能ですので、本APIの呼び出しは省略しても問題ありません。 | |||
| 補足 | ログ取得APIモードでは、「MPXGetLog」、「MPXCANGetLogEx」「MPXLINGetLogEx」のいずれかを呼び出してログ情報を定期的に取得する必要があります。 | |||
MPXGetLog
モニタリング中のログ情報(送受信データ)を、DLL内に確保されているログ情報構造体バッファから取得します。
| 形式 | ER MPXGetLog(uint32_t Serial, uint8_t InnerCh, StMPXLog ** Log, uint16_t * Count, uint8_t * BufferOver) | |||
|---|---|---|---|---|
| 引数 | uint32_t | Serial | in | 対象のMicroPeckerX本体のシリアル番号 |
| uint8_t | InnerCh | in | 対象のCH番号(1または2) | |
| StMPXLog ** | Log | out | ログ情報構造体配列のポインタ | |
| uint16_t * | Count | out | 取得したログ情報件数 | |
| uint8_t * | BufferOver | out | バッファオーバーラン (セットされる値は「バッファオーバーラン有無」を参照) | |
| 戻り値 | ER | E_OK | 正常終了 | |
| E_PARAM | パラメータ異常 | |||
| E_DEVICE | デバイスが見つからない | |||
| 機能 | SerialとInnerChに指定したMicroPeckerX本体のCHから送られるログ情報を取得します。 取得したログ情報は、DLL内に確保されているログ情報構造体バッファの先頭ポインタがLogに、件数がCountにそれぞれセットされます。 バッファオーバーランが発生した場合は、BufferOverにMPX_LOG_BUFOVER_TRUEがセットされます。 | |||
| 補足 | 本APIでは、取得したログ情報を格納するための構造体配列を呼び出し元で用意する必要はありません。 | |||