API一覧
本製品で使用できるAPIのリストと、各APIの呼び出し可能条件を説明します。
APIリスト
| API名 | 機能 |
|---|---|
| MPXGetAPIVersion | APIバージョン取得 |
| MPXOpen | MicroPeckerX認識 |
| MPXClose | MicroPeckerX認識解除 |
| MPXSetLED | LED制御 |
| MPXGetStatus | MicroPeckerXステータス取得 |
| MPXMonitorStart | モニタリング開始 |
| MPXMonitorStop | モニタリング停止 |
| MPXGetTimeStamp | タイムスタンプ取得 |
| MPXSetGetLogMode | ログ情報取得方法設定 |
| MPXSetLogCallBack | ログ情報取得用のコールバック関数設定 |
| MPXGetLog | ログ情報取得（バッファポインタ） |
| MPXGetLogEx | ログ情報取得（構造体配列格納） |
| MPXSetCANParam | 通信パラメータ設定 |
| MPXSetSlot | モニタリング前のスロット情報設定 |
| MPXChangeSlot | モニタリング中のスロット情報設定 |
| MPXSendSlot | スロット送信要求 |
| MPXDirectSend | フレーム送信 |
| MPXSetLogRequestCallBack | ログ再生用データ要求時のコールバック関数設定 |
| MPXSetLogReplayData | ログ再生用データ送信 |
| MPXSetBurstLog | バースト転送モード（1フレーム）用のフレーム情報設定 |
| MPXSetLogReplayTrigger | ログ再生用データの送信開始トリガ条件設定 |
| MPXLogReplayStart | ログ再生モードまたはバースト転送モードの送信開始 |
| MPXLogReplayStop | ログ再生モードまたはバースト転送モードの送信停止 |
APIの呼び出し可能条件
各APIは、以下の表においてMicroPeckerX本体の認識状態またはステータスが「○」印となっている時に呼び出し可能です。
それ以外の状態で呼び出した場合の動作は保証しておりません。
| API | ステータス | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| 未認識 | 認識中（ステータス：MPX_STATUS_***） | |||||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | LOG | BUR_LOG | BUR | ||
| MPXGetAPIVersion | ○ | ○ | - | - | - | - | - | - | - | - |
| MPXOpen | ○ | - | - | - | - | - | - | - | - | - |
| MPXClose | - | ○ | - | - | - | - | - | - | - | - |
| MPXSetLED | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXGetStatus | - | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXMonitorStart | - | - | ○ | - | - | - | - | - | - | - |
| MPXMonitorStop | - | - | ○ | ○ | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXGetTimeStamp | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXSetGetLogMode | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogCallBack | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXGetLog | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXGetLogEx | - | - | - | - | ○ | ○ | ○ | ○ | ○ | ○ |
| MPXSetCANParam | - | ○ | - | - | - | - | - | - | - | - |
| MPXSetSlot | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXChangeSlot | - | - | - | - | - | - | ○ | - | - | - |
| MPXSendSlot | - | - | - | - | - | - | ○ | - | - | - |
| MPXDirectSend | - | - | - | - | - | - | ○ | - | - | - |
| MPXSetLogRequestCallBack | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogReplayData | - | - | - | - | - | - | ○ | - | - | - |
| MPXSetBurstLog | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXSetLogReplayTrigger | - | ○ | ○ | - | - | - | - | - | - | - |
| MPXLogReplayStart | - | - | - | - | - | - | ○ | ○ | ○ | ○ |
| MPXLogReplayStop | - | - | - | - | - | - | ○ | ○ | ○ | ○ |