Ver.3.00 からの移行ガイド
本ページは、S810-MX-ADL2N の Ver.3.00 から Ver.4.00 へ移行する際の実装差分を、既存コードの置換観点で整理したガイドです。
関連リンク
- 移行時の問題切り分け: よくある問題と対処
- 他製品からの移行: ADL1N からの移行, SDK2N からの移行, SDK3N からの移行
移行の全体像
Ver.3.00 から Ver.4.00 の移行で、実装に影響するポイントは次の2点です。
- C/C++ で使用する API 引数および構造体メンバの型表記を固定幅整数型へ更新する
- コールバック関数モードでログを取得している場合は、APIモードに変更する
型表記の変更
C/C++ で MPXCtrlFree.h を使用して実装する場合、Ver.4.00 の API 引数および構造体メンバの型表記は、次の固定幅整数型に変更されています。
| Ver.3.00 の型表記 | Ver.4.00 の型表記 |
|---|---|
char | int8_t |
unsigned char | uint8_t |
unsigned short | uint16_t |
unsigned long | uint32_t |
MPXCtrlFree.h をインクルードして使用している場合は、ヘッダーファイルの定義に従います。ヘッダーファイルを使用せずに API 宣言または構造体定義を独自に記述している場合は、MPXCtrlFree.h と同じ型表記に更新してください。
ポインタ型を含め、API 宣言や構造体メンバで旧表記と新表記を混在させないでください。
API仕様差分(旧->新)
Info
API 引数の固定幅整数型への表記変更は「型表記の変更」で説明していますので、本節の仕様差分からは省略します。
共通API
引数型の固定幅整数型への変更は省略します。
| Ver.3.00 | Ver.4.00 | 互換性影響 |
|---|---|---|
MPXGetAPIVersion(StMPXAPIVersion*) | 同じ | 変更なし |
MPXOpen(...) | 同じ | 変更なし |
MPXClose() | 同じ | 変更なし |
MPXSetLED(...) | 同じ | 変更なし |
MPXGetStatus(...) | 同じ | 変更なし |
MPXMonitorStart(...) | 同じ | 変更なし |
MPXMonitorStop(...) | 同じ | 変更なし |
MPXGetTimeStamp(...) | 同じ | 変更なし |
MPXSetLogCallBack(...) | 廃止 | ログAPIモードに変更 |
MPXSetGetLogMode(...) | 同じ | ログAPIモードの場合は変更なし、コールバックモードの場合はログAPIモードに変更 省略可 |
MPXGetLog(...) | 同じ | 変更なし |
CAN/CAN FD API
変更点はありません。
LIN API
変更点はありません。
定数・構造体の移行ポイント
ログ取得フローとログ構造体変更
Ver.4.00 では、ログ取得モードからコールバック関数モードを廃止していますので、コールバック関数モードを使用している場合はAPIモードに置き換える必要があります。
なお、これによりログ取得モードはAPIモード固定となりますので、 MPXSetGetLogMode の呼び出しは省略可能です。
戻り値(ER)差分
ERコードは Ver.3.00 と Ver.4.00 で同一です。
| 定数 | 値 |
|---|---|
E_OK | 0 |
E_PARAM | 1 |
E_DEVICE | 2 |
E_COMM | 3 |
E_TGT | 4 |
E_TRG_BUSY | 11 |
E_DCT_FULL | 12 |
E_STATUS | 105 |
E_TIMEOUT | 202 |
E_OTHER | 255 |
実装手順(既存アプリ置換フロー)
- C/C++でAPI 引数および構造体メンバにセットする変数の型表記を固定幅整数型に変更
- ログの取得モードをコールバック関数モードからAPIモードに変更
言語別 置換例
C/C++ 置換例
// Ver.3.00
StMPXDeviceInfo devs[8] = {};
unsigned char count = 0;
ER er = MPXOpen(devs, 8, &count);
unsigned long serial = (count > 0) ? devs[0].Serial : 0;
er = MPXCANSetParam(serial, innerCh, ¶m);
er = MPXCANGetLogEx(serial, innerCh, logs, num, &got, &over);
// ADL2N
StMPXDeviceInfo devs[8] = {};
uint8_t count = 0;
ER er = MPXOpen(devs, 8, &count);
uint32_t serial = (count > 0) ? devs[0].Serial : 0;
er = MPXCANSetParam(serial, innerCh, ¶m);
er = MPXCANGetLogEx(serial, innerCh, logs, num, &got, &over);
移行チェックリスト
- C/C++ の API 宣言、構造体定義、および関連変数の型表記を固定幅整数型へ更新した
- ログ取得モードをコールバック関数モードからAPIモードに変更した
関連ページ
- 共通 API 一覧: /S810-MX-ADL2N/Common/api_list_common
- 共通 API 詳細: /S810-MX-ADL2N/Common/api_detail_common