API一覧(LIN用)
共通APIはAPI一覧(共通)を参照してください。
本製品で使用できるLIN用APIのリストと、各APIの呼び出し可能条件を説明します。
用途別クイックガイド
| 用途 | 先に見るAPI | 関連ページ |
|---|---|---|
| 通信条件を設定する | MPXLINSetParam | LIN API対応表, 定数定義(LIN用) |
| マスタシミュレーション | MPXLINSetMasterSim, MPXLINSetMasterSchedule, MPXLINChangeMasterSchedule | 構造体定義(LIN用), LINマスタサンプル |
| スレーブシミュレーション | MPXLINSetSlaveSim, MPXLINSetSlaveItem, MPXLINChangeSlaveItem | LINスレーブサンプル |
| ログ取得/解析 | MPXLINGetLogEx | 共通API詳細, LINモニタサンプル |
APIリスト
| API名 | 機能 | 代表ユースケース |
|---|---|---|
| MPXLINSetParam | LIN通信パラメータ設定 | 監視/マスタ/スレーブ開始前の条件設定 |
| MPXLINGetLogEx | LINログ情報取得(構造体配列格納) | LINログの定期取得 |
| MPXLINSetStatus | LINステータス設定 | Run/Sleep状態の制御 |
| MPXLINSetMasterSim | LINマスタシミュレーション設定 | スケジュール内容の初期設定 |
| MPXLINSetMasterItem | LINマスタシミュレーションアイテム設定 | アイテムの有効/無効切替 |
| MPXLINChangeMasterItem | LINマスタシミュレーションアイテム変更 | アイテム内容の動的変更 |
| MPXLINSetMasterSchedule | LINマスタスケジュール設定 | スケジュール有効化/OneTime設定 |
| MPXLINChangeMasterSchedule | LINマスタスケジュール変更 | 実行スケジュール切替 |
| MPXLINPauseMasterSchedule | LINマスタスケジュール停止 | 一時停止/再開 |
| MPXLINMasterInterrupt | LIN割り込み送信 | マスタからの即時割り込み送信 |
| MPXLINSetSlaveSim | LINスレーブシミュレーション設定 | 応答定義の初期設定 |
| MPXLINSetSlaveItem | LINスレーブシミュレーションアイテム設定 | 応答IDごとの有効/無効切替 |
| MPXLINChangeSlaveItem | LINスレーブシミュレーションアイテム変更 | 応答データの動的変更 |
| MPXLINSlaveWakeup | LINスレーブWakeup送信 | バス復帰要求の送信 |
APIの呼び出し可能条件
各APIは、以下の表においてMicroPeckerX本体の認識状態またはステータスが「○」印となっている時に呼び出し可能です。
それ以外の状態で呼び出した場合の動作は保証しておりません。
| API | ステータス | ||||||
|---|---|---|---|---|---|---|---|
| 未認識 | 認識中(ステータス:MPX_STATUS_***) | ||||||
| RUN | PARAM | SYNC | NONE | MON | SIM | ||
| MPXLINSetParam | ○ | ||||||
| MPXLINGetLogEx | ○ | ○ | ○ | ||||
| MPXLINSetStatus | ○ | ○ | ○ | ||||
| MPXLINSetMasterSim | ○ | ○ | |||||
| MPXLINSetMasterItem | ○ | ||||||
| MPXLINChangeMasterItem | ○ | ||||||
| MPXLINSetMasterSchedule | ○ | ○ | |||||
| MPXLINChangeMasterSchedule | ○ | ○ | ○ | ||||
| MPXLINPauseMasterSchedule | ○ | ||||||
| MPXLINMasterInterrupt | ○ | ||||||
| MPXLINSetSlaveSim | ○ | ○ | |||||
| MPXLINSetSlaveItem | ○ | ||||||
| MPXLINChangeSlaveItem | ○ | ||||||
| MPXLINSlaveWakeup | ○ | ||||||