API一覧(CAN用)
共通APIはAPI一覧(共通)を参照してください。
本製品で使用できるCAN用APIのリストと、各APIの呼び出し可能条件を説明します。
用途別クイックガイド
| 用途 | 先に見るAPI | 関連ページ |
|---|---|---|
| 通信条件を設定する | MPXCANSetParam | CAN API対応表, 定数定義(CAN用) |
| スロット送信を使う | MPXCANSetSlot, MPXCANChangeSlot, MPXCANSendSlot | 構造体定義(CAN用) |
| ログ取得/解析 | MPXCANGetLogEx | 共通API詳細, CAN監視サンプル |
| ダイレクト送信 | MPXCANDirectSend | CANシミュレーションサンプル |
APIリスト
| API名 | 機能 | 代表ユースケース |
|---|---|---|
| MPXCANSetParam | CAN通信パラメータ設定 | 監視/シミュレーション開始前の条件設定 |
| MPXCANGetLogEx | CANログ情報取得(構造体配列格納) | 監視ログの定期取得 |
| MPXCANSetSlot | CANスロット情報設定 | 周期/Event送信シナリオの初期定義 |
| MPXCANChangeSlot | CANスロット情報変更 | 実行中の送信条件変更 |
| MPXCANSendSlot | CANスロット送信要求 | イベント送信の即時要求 |
| MPXCANDirectSend | CANフレーム送信 | スロット非依存の単発送信 |
APIの呼び出し可能条件
各APIは、以下の表においてMicroPeckerX本体の認識状態またはステータスが「○」印となっている時に呼び出 し可能です。
それ以外の状態で呼び出した場合の動作は保証しておりません。
| API | ステータス | ||||||
|---|---|---|---|---|---|---|---|
| 未認識 | 認識中(ステータス:MPX_STATUS_***) | ||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | ||
| MPXCANSetParam | ○ | ||||||
| MPXCANGetLogEx | ○ | ○ | ○ | ||||
| MPXCANSetSlot | ○ | ○ | |||||
| MPXCANChangeSlot | ○ | ||||||
| MPXCANSendSlot | ○ | ||||||
| MPXCANDirectSend | ○ | ||||||