API一覧（共通）
CAN専用APIはAPI一覧（CAN用）、LIN専用APIはAPI一覧（LIN用）を参照してください。
本製品で使用できる共通APIのリストと、各APIの呼び出し可能条件を説明します。
用途別クイックガイド
| 用途 | 先に見るAPI | 関連ページ |
|---|---|---|
| 初期化・接続 | MPXGetAPIVersion, MPXOpen, MPXClose | 共通APIの使い方（目的別） |
| 実行状態制御 | MPXGetStatus, MPXMonitorStart, MPXMonitorStop | 共通導入（最小フロー） |
| ログ取得 | MPXSetGetLogMode, MPXSetLogCallBack, MPXGetLog | 構造体定義（共通）, 定数定義（共通） |
APIリスト
| API名 | 機能 | 代表ユースケース |
|---|---|---|
| MPXGetAPIVersion | APIバージョン取得 | 接続前のバージョン確認 |
| MPXOpen | MicroPeckerX認識 | 初期化時のデバイス列挙 |
| MPXClose | MicroPeckerX認識解除 | アプリ終了処理 |
| MPXSetLED | LED制御 | 接続状態の可視化 |
| MPXGetStatus | MicroPeckerXステータス取得 | 遷移前の状態確認 |
| MPXMonitorStart | モニタリング開始 | 監視/シミュレーション開始 |
| MPXMonitorStop | モニタリング停止 | 監視/シミュレーション停止 |
| MPXGetTimeStamp | タイムスタンプ取得 | ログ時刻基準 の取得 |
| MPXSetLogCallBack | ログコールバック関数設定 | イベント駆動でログ取得 |
| MPXSetGetLogMode | ログ情報取得方法設定 | API/コールバック方式の切替 |
| MPXGetLog | ログ情報取得（バッファポインタ） | ポーリングでログ取得 |
APIの呼び出し可能条件
各APIは、以下の表においてMicroPeckerX本体の認識状態またはステータスが「○」印となっている時に呼び出し可能です。
それ以外の状態で呼び出した場合の動作は保証しておりません。
| API | ステータス | ||||||
|---|---|---|---|---|---|---|---|
| 未認識 | 認識中（ステータス：MPX_STATUS_***） | ||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | ||
| MPXGetAPIVersion | ○ | ○ | |||||
| MPXOpen | ○ | ||||||
| MPXClose | ○ | ||||||
| MPXSetLED | ○ | ○ | |||||
| MPXGetStatus | ○ | ○ | ○ | ○ | ○ | ○ | |
| MPXMonitorStart | ○ | ||||||
| MPXMonitorStop | ○ | ○ | ○ | ○ | ○ | ||
| MPXGetTimeStamp | ○ | ○ | ○ | ||||
| MPXSetGetLogMode | ○ | ○ | |||||
| MPXSetLogCallBack | ○ | ○ | |||||
| MPXGetLog | ○ | ○ | ○ | ||||