メインコンテンツまでスキップ
バージョン: 4.00

API詳細(LIN用)

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

先に確認する導線​

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

APIこのAPIで使う定数このAPIで使う構造体呼び出し前提ステータス最小コード例(C++/C#/VBA)
MPXLINSetParamLIN動作モード, LINリビジョンStMPXLINParamRUNLINモニタ(C++), LINシミュレーション(C#), LINシミュレーション(VBA)
MPXLINGetLogExバッファオーバーラン有無StMPXLINLogNONE/MON/SIMLINモニタ(C++)
MPXLINSetStatusLINステータス-PARAM/SYNC/SIMLINマスタ(C++), LINスレーブ(C++)
MPXLINSetMasterSimLINフレーム種別StMPXLINMasterSimPARAM/SYNCLINマスタ(C++)
MPXLINSetMasterItemLINシミュレーション設定有効/無効-SIMLINマスタ(C++)
MPXLINChangeMasterItemLINフレーム種別StMPXLINMasterSimItemSIMLINマスタ(C++)
MPXLINSetMasterScheduleLINシミュレーション設定有効/無効-PARAM/SYNC/SIMLINマスタ(C++)
MPXLINChangeMasterScheduleAPI戻り値-PARAM/SYNC/SIMLINマスタ(C++)
MPXLINPauseMasterScheduleLINシミュレーション設定有効/無効-SIMLINマスタ(C++)
MPXLINMasterInterruptLINフレーム種別StMPXLINMasterSimItemSIMLINマスタ(C++)
MPXLINSetSlaveSimLINフレーム種別StMPXLINSlaveSimPARAM/SYNCLINスレーブ(C++)
MPXLINSetSlaveItemLINシミュレーション設定有効/無効-SIMLINスレーブ(C++)
MPXLINChangeSlaveItemLINフレーム種別StMPXLINSlaveSimItemSIMLINスレーブ(C++)
MPXLINSlaveWakeupLINフレーム種別-SIMLINスレーブ(C++)

凡例​

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

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

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

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

API詳細​

MPXLINSetParam​

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

形式ER MPXLINSetParam(uint32_t Serial, StMPXLINParam * Param)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
StMPXLINParam *Paraminパラメータ設定情報構造体のポインタ
戻り値ERE_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(uint32_t Serial, StMPXLINLog * Log, uint16_t Num, uint16_t * Count, uint8_t * BufferOver)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
StMPXLINLog *Login/outログ情報構造体配列
uint16_tNuminログ情報構造体配列の要素数
uint16_t *Countout取得したログ情報件数
uint8_t *BufferOveroutバッファオーバーラン
(セットされる値は「バッファオーバーラン有無」を参照)
戻り値ERE_OK正常終了
E_PARAMパラメータ異常
E_DEVICEデバイスが見つからない
機能Serialに指定したMicroPeckerX本体のCH1から送られるLINログ情報を取得します。
Logには取得したLINログ情報をセットするための構造体配列を、Numには配列の要素数を、それぞれ指定してください。
取得したログ情報の件数はCountにセットされます。
CountがNumより大きい場合はバッファオーバーランが発生し、BufferOverにMPX_LOG_BUFOVER_TRUEがセットされます。
補足本APIでは、取得したログ情報を格納するための構造体配列を呼び出し元で用意する必要があります。

MPXLINSetStatus​

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

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

MPXLINSetMasterSim​

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

形式ER MPXLINSetMasterSim(uint32_t Serial, uint8_t SchNo, StMPXLINMasterSim * MasterSim, uint8_t Num)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
uint8_tSchNoinスケジュール番号(0~31)
StMPXLINMasterSim *MasterSiminLINマスタシミュレーション情報リスト構造体のポインタ
uint8_tNuminLINマスタシミュレーション情報構造体配列の要素数
戻り値ERE_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(uint32_t Serial, uint8_t SchNo, uint8_t ItemNo, uint8_t Ena)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
uint8_tSchNoinスケジュール番号(0~31)
uint8_tItemNoinアイテム番号(0~63)
uint8_tEnainアイテムの有効/無効
(指定可能な値は「LINシミュレーション設定有効/無効」を参照)
戻り値ERE_OK正常終了
E_PARAMパラメータ異常
E_DEVICEデバイスが見つからない
E_COMM通信異常
E_STATUSステータス異常
E_TIMEOUT通信タイムアウト
機能Serialに指定したMicroPeckerX本体のCH1に対して、SchNoで指定したスケジュールのうち、ItemNoで指定したアイテムの有効/無効を設定します。
補足本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。
本APIは、マスタシミュレーション設定の有効/無効をアイテム単位で変更するためのものです。有効/無効以外の設定を変更したい場合は「MPXLINChangeMasterItem」を呼び出してください。

MPXLINChangeMasterItem​

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

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

MPXLINSetMasterSchedule​

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

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

MPXLINChangeMasterSchedule​

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

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

MPXLINPauseMasterSchedule​

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

形式ER MPXLINPauseMasterSchedule(uint32_t Serial, uint8_t Ena)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
uint8_tEnainスケジュール停止の有効/無効
(指定可能な値は「LINシミュレーション設定有効/無効」を参照)
戻り値ERE_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(uint32_t Serial, StMPXLINMasterSimItem * MasterSimItem)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
StMPXLINMasterSimItem *MasterSimIteminLINマスタシミュレーション情報構造体のポインタ
戻り値ERE_OK正常終了
E_PARAMパラメータ異常
E_DEVICEデバイスが見つからない
E_COMM通信異常
E_STATUSステータス異常
E_TIMEOUT通信タイムアウト
機能Serialに指定したMicroPeckerX本体のCH1に対して、マスタシミュレーションの割り込み送信を行います。
補足本APIは、LIN動作モードにマスタシミュレーションモードを設定した場合のみ有効です。

MPXLINSetSlaveSim​

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

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

MPXLINSetSlaveItem​

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

形式ER MPXLINSetSlaveItem(uint32_t Serial, uint8_t ResponseID, uint8_t Ena)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
uint8_tResponseIDin対象のLIN ID
uint8_tEnainアイテムの有効/無効
(指定可能な値は「LINシミュレーション設定有効/無効」を参照)
戻り値ERE_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(uint32_t Serial, uint8_t ResponseID, StMPXLINSlaveSimItem * SlaveSimItem)
引数uint32_tSerialin対象のMicroPeckerX本体のシリアル番号
uint8_tResponseIDin対象のLIN ID
StMPXLINSlaveSimItem *SlaveSimIteminLINスレーブシミュレーション情報構造体のポインタ
戻り値ERE_OK正常終了
E_PARAMパラメータ異常
E_DEVICEデバイスが見つからない
E_COMM通信異常
E_STATUSステータス異常
E_TIMEOUT通信タイムアウト
機能Serialに指定したMicroPeckerX本体のCH1に対して、Response IDで指定したLIN IDのアイテムの設定を変更します。
補足本APIは、LIN動作モードにスレーブシミュレーションモードを設定した場合のみ有効です。

MPXLINSlaveWakeup​

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

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