API詳細（LIN用）

本製品で使用できる各APIのうち、LIN用のAPIの詳細を説明します。

先に確認する導線

目的別のAPI対応を確認する場合: LIN API対応表
共通APIの前提を確認する場合: 共通APIの使い方（目的別）
LINの定数を確認する場合: 定数定義（LIN用）
LINの構造体を確認する場合: 構造体定義（LIN用）

APIクイック参照（定数/構造体/前提/最小例）

API	このAPIで使う定数	このAPIで使う構造体	呼び出し前提ステータス	最小コード例（C++/C#/VBA）
MPXLINSetParam	LIN動作モード, LINリビジョン	StMPXLINParam	RUN	LINモニタ（C++）, LINシミュレーション（C#）, LINシミュレーション（VBA）
MPXLINGetLogEx	バッファオーバーラン有無	StMPXLINLog	NONE/MON/SIM	LINモニタ（C++）
MPXLINSetStatus	LINステータス	-	PARAM/SYNC/SIM	LINマスタ（C++）, LINスレーブ（C++）
MPXLINSetMasterSim	LINフレーム種別	StMPXLINMasterSim	PARAM/SYNC	LINマスタ（C++）
MPXLINSetMasterItem	LINシミュレーション設定有効/無効	-	SIM	LINマスタ（C++）
MPXLINChangeMasterItem	LINフレーム種別	StMPXLINMasterSimItem	SIM	LINマスタ（C++）
MPXLINSetMasterSchedule	LINシミュレーション設定有効/無効	-	PARAM/SYNC/SIM	LINマスタ（C++）
MPXLINChangeMasterSchedule	API戻り値	-	PARAM/SYNC/SIM	LINマスタ（C++）
MPXLINPauseMasterSchedule	LINシミュレーション設定有効/無効	-	SIM	LINマスタ（C++）
MPXLINMasterInterrupt	LINフレーム種別	StMPXLINMasterSimItem	SIM	LINマスタ（C++）
MPXLINSetSlaveSim	LINフレーム種別	StMPXLINSlaveSim	PARAM/SYNC	LINスレーブ（C++）
MPXLINSetSlaveItem	LINシミュレーション設定有効/無効	-	SIM	LINスレーブ（C++）
MPXLINChangeSlaveItem	LINフレーム種別	StMPXLINSlaveSimItem	SIM	LINスレーブ（C++）
MPXLINSlaveWakeup	LINフレーム種別	-	SIM	LINスレーブ（C++）

凡例

このページでは、各APIの詳細を以下の形式で説明します。

形式	[関数の型] [関数名]([引数], ...)
引数	[引数の型]	[引数名]	[in/out]	[引数の説明]
戻り値	[戻り値の型]	[戻り値(エラーコード)]		[戻り値(エラーコード)の説明]
機能	[関数の機能の説明]
補足	[関数の補足説明]

[引数の型]が構造体となっている場合、構造体にセットする値、またはセットされる値については「構造体定義（struct）（LIN用）および構造体定義（struct）（共通）」を参照してください。

[in/out]は、関数の呼び出し時にセットする場合はin、関数の処理でセットされる場合はoutになります。

API詳細

MPXLINSetParam

LINの通信パラメータを設定します。

形式	ER MPXLINSetParam(unsigned long Serial, StMPXLINParam * Param)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	StMPXLINParam *	Param	in	パラメータ設定情報構造体のポインタ
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、LINの通信パラメータをParamの指定値で設定します。
補足	本APIの呼び出しにより、MicroPeckerXステータスがMPX_STATUS_PARAM（パラメータ設定待ち状態）に変化します。

MPXLINGetLogEx

モニタリング中のログ情報（送受信データ）を、呼び出し元で用意したLINログ情報構造体配列に取得します。

形式	ER MPXLINGetLogEx(unsigned long Serial, StMPXLINLog * Log, unsigned short Num, unsigned short * Count, unsigned char * BufferOver)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	StMPXLINLog *	Log	in/out	ログ情報構造体配列
	unsigned short	Num	in	ログ情報構造体配列の要素数
	unsigned short *	Count	out	取得したログ情報件数
	unsigned char *	BufferOver	out	バッファオーバーラン（セットされる値は「バッファオーバーラン有無」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
機能	Serialに指定したMicroPeckerX本体のCH1から送られるLINログ情報を取得します。 Logには取得したLINログ情報をセットするための構造体配列を、Numには配列の要素数を、それぞれ指定してください。取得したログ情報の件数はCountにセットされます。 CountがNumより大きい場合はバッファオーバーランが発生し、BufferOverにMPX_LOG_BUFOVER_TRUEがセットされます。
補足	本APIは、ログ取得APIモードでログ情報を取得する場合のみ有効です。本APIでは、取得したログ情報を格納するための構造体配列を呼び出し元で用意する必要があります。

MPXLINSetStatus

LINステータスを設定します。

形式	ER MPXLINSetStatus(unsigned long Serial, unsigned char Status)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	unsigned char	Status	in	LINステータス（指定可能な値は「LINステータス」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、LINステータスを設定します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINSetMasterSim

LINのマスタシミュレーションの設定をスケジュール単位で行います。

形式	ER MPXLINSetMasterSim(unsigned long Serial, unsigned char SchNo, StMPXLINMasterSim * MasterSim, unsigned char Num)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	SchNo	in	スケジュール番号（0～31）
	StMPXLINMasterSim *	MasterSim	in	LINマスタシミュレーション情報リスト構造体のポインタ
	unsigned char	Num	in	LINマスタシミュレーション情報構造体配列の要素数
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、SchNoで指定したスケジュール番号に対するLINのマスターシミュレーション設定を行います。 NumにはLINマスタシミュレーション情報リスト構造体に含まれるLINマスタシミュレーション情報構造体配列の要素数を指定してください。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINSetMasterItem

LINのマスタシミュレーション設定について、アイテム単位での有効/無効を変更します。

形式	ER MPXLINSetMasterItem(unsigned long Serial, unsigned char SchNo, unsigned char ItemNo, unsigned char Ena)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	SchNo	in	スケジュール番号（0～31）
	unsigned char	ItemNo	in	アイテム番号（0～63）
	unsigned char	Ena	in	アイテムの有効/無効（指定可能な値は「LINシミュレーション設定有効/無効」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、SchNoで指定したスケジュールのうち、ItemNoで指定したアイテムの有効/無効を設定します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。本APIは、マスタシミュレーション設定の有効/無効をアイテム単位で変更するためのものです。有効/無効以外の設定を変更したい場合は「MPXLINChangeMasterItem」を呼び出してください。

MPXLINChangeMasterItem

LINのマスタシミュレーション設定について、指定したアイテムの設定を変更します。

形式	ER MPXLINChangeMasterItem(unsigned long Serial, unsigned char SchNo, unsigned char ItemNo, StMPXLINMasterSimItem * MasterSimItem)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	SchNo	in	スケジュール番号（0～31）
	unsigned char	ItemNo	in	アイテム番号（0～63）
	StMPXLINMasterSimItem *	MasterSimItem	in	LINマスタシミュレーション情報構造体のポインタ
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、SchNoで指定したスケジュールのうち、ItemNoで指定したアイテムの設定を変更します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINSetMasterSchedule

LINのマスタシミュレーション設定について、スケジュール単位での有効/無効とワンタイム送信の設定を変更します。

形式	ER MPXLINSetMasterSchedule(unsigned long Serial, unsigned char SchNo, unsigned char Ena, unsigned char OneTime)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	SchNo	in	スケジュール番号（0～31）
	unsigned char	Ena	in	スケジュールの有効/無効（指定可能な値は「LINシミュレーション設定有効/無効」を参照）
	unsigned char	OneTime	in	ワンタイム送信の有効/無効（指定可能な値は「LINシミュレーション設定有効/無効」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、SchNoで指定したスケジュールの有効/無効と、ワンタイム送信の設定を変更します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINChangeMasterSchedule

LINのマスタシミュレーションについて、実行対象のスケジュールを変更します。

形式	ER MPXLINChangeMasterSchedule(unsigned long Serial, unsigned char SchNo)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	unsigned char	SchNo	in	スケジュール番号（0～31）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、実行対象のスケジュールをSchNoで指定したスケジュール番号に変更します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINPauseMasterSchedule

LINのマスタシミュレーションについて、実行中のスケジュールの停止または再開を変更します。

形式	ER MPXLINPauseMasterSchedule(unsigned long Serial, unsigned char Ena)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	unsigned char	Ena	in	スケジュール停止の有効/無効（指定可能な値は「LINシミュレーション設定有効/無効」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、実行中のスケジュールの停止または再開を変更します。 EnaにMPX_LIN_SIM_ENAを指定すると実行中のスケジュールが停止し、MPX_LIN_SIM_DISを指定するとスケジュールの実行を再開します。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINMasterInterrupt

LINのマスタシミュレーションの割り込み送信を行います。

形式	ER MPXLINMasterInterrupt(unsigned long Serial, StMPXLINMasterSimItem * MasterSimItem)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	StMPXLINMasterSimItem *	MasterSimItem	in	LINマスタシミュレーション情報構造体のポインタ
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、マスタシミュレーションの割り込み送信を行います。
補足	本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINSetSlaveSim

LINのスレーブシミュレーションの設定を全てのアイテムに対して行います。

形式	ER MPXLINSetSlaveSim(unsigned long Serial, StMPXLINSlaveSim * SlaveSim)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
引数	StMPXLINSlaveSim *	SlaveSim	in	LINマスタシミュレーション情報リスト構造体のポインタ
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、LINのスレーブシミュレーション設定を全てのアイテムに対して行います。
補足	本APIは、LIN動作モードにスレーブシミュレーションモードを設定した場合のみ有効です。

MPXLINSetSlaveItem

LINのスレーブシミュレーション設定について、アイテム単位での有効/無効を変更します。

形式	ER MPXLINSetSlaveItem(unsigned long Serial, unsigned char ResponseID, unsigned char Ena)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	ResponseID	in	対象のLIN ID
	unsigned char	Ena	in	アイテムの有効/無効（指定可能な値は「LINシミュレーション設定有効/無効」を参照）
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、Response IDで指定したLIN IDのアイテムの有効/無効を設定します。
補足	本APIは、LIN動作モードにスレーブシミュレーションモードを設定した場合のみ有効です。本APIは、スレーブシミュレーション設定の有効/無効をアイテム単位で変更するためのものです。有効/無効以外の設定を変更したい場合は「MPXLINChangeSlaveItem」を呼び出してください。

MPXLINChangeSlaveItem

LINのスレーブシミュレーション設定について、指定したアイテムの設定を変更します。

形式	ER MPXLINChangeSlaveItem(unsigned long Serial, unsigned char ResponseID, StMPXLINSlaveSimItem * SlaveSimItem)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
	unsigned char	ResponseID	in	対象のLIN ID
	StMPXLINSlaveSimItem *	SlaveSimItem	in	LINスレーブシミュレーション情報構造体のポインタ
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、Response IDで指定したLIN IDのアイテムの設定を変更します。
補足	本APIは、LIN動作モードにスレーブシミュレーションモードを設定した場合のみ有効です。

MPXLINSlaveWakeup

LINのマスタシミュレーションのウェイクアップ送信を行います。

形式	ER MPXLINSlaveWakeup(unsigned long Serial)
引数	unsigned long	Serial	in	対象のMicroPeckerX本体のシリアル番号
戻り値	ER	E_OK		正常終了
		E_PARAM		パラメータ異常
		E_DEVICE		デバイスが見つからない
		E_COMM		通信異常
		E_STATUS		ステータス異常
		E_TIMEOUT		通信タイムアウト
機能	Serialに指定したMicroPeckerX本体のCH1に対して、スレーブシミュレーションのウェイクアップ送信を行います。
補足	本APIは、LIN動作モードにスレーブシミュレーションモードを設定した場合のみ有効です。

先に確認する導線​

APIクイック参照（定数/構造体/前提/最小例）​

凡例​

API詳細​

MPXLINSetParam​

MPXLINGetLogEx​

MPXLINSetStatus​

MPXLINSetMasterSim​

MPXLINSetMasterItem​

MPXLINChangeMasterItem​

MPXLINSetMasterSchedule​

MPXLINChangeMasterSchedule​

MPXLINPauseMasterSchedule​

MPXLINMasterInterrupt​

MPXLINSetSlaveSim​

MPXLINSetSlaveItem​

MPXLINChangeSlaveItem​

MPXLINSlaveWakeup​