メインコンテンツまでスキップ

API一覧

本製品で使用できるAPIのリストと、各APIの呼び出し可能条件を説明します。

APIリスト​

API名機能
MPXGetAPIVersionAPIバージョン取得
MPXOpenMicroPeckerX認識
MPXCloseMicroPeckerX認識解除
MPXSetLEDLED制御
MPXGetStatusMicroPeckerXステータス取得
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_***)
RUNPARAMSYNCNONEMONSIMLOGBUR_LOGBUR
MPXGetAPIVersion○○--------
MPXOpen○---------
MPXClose-○--------
MPXSetLED-○○-------
MPXGetStatus-○○○○○○○○○
MPXMonitorStart--○-------
MPXMonitorStop--○○○○○○○○
MPXGetTimeStamp----○○○○○○
MPXSetGetLogMode-○○-------
MPXSetLogCallBack-○○-------
MPXGetLog----○○○○○○
MPXGetLogEx----○○○○○○
MPXSetCANParam-○--------
MPXSetSlot-○○-------
MPXChangeSlot------○---
MPXSendSlot------○---
MPXDirectSend------○---
MPXSetLogRequestCallBack-○○-------
MPXSetLogReplayData------○---
MPXSetBurstLog-○○-------
MPXSetLogReplayTrigger-○○-------
MPXLogReplayStart------○○○○
MPXLogReplayStop------○○○○