TCP ASCII 通信コマンド

現在ご覧いただいているのは最新版の内容です(V2.2.1)。異なるバージョンを参照する場合は、画面右上のボタンから切り替えが可能です。

■ ご利用中のバージョンが分からない場合や、サポートが必要な場合はお気軽にサポート窓口までご連絡ください。

TCP ASCII 通信を使用する際、外部機器は以下の種類のコマンドを使用してMech-MSRプロジェクトの実行をトリガーし、対応する結果を取得します。

  • triggerコマンド:プロジェクトの実行をトリガーするために使用されます。

  • returnコマンド:指定したプロジェクトの判定結果と測定結果を取得するために使用されます。

  • executeコマンド:プロジェクトの実行をトリガーし、そのプロジェクトの判定結果と測定結果を取得するために使用されます。

  • judgeコマンド:指定したプロジェクトの全体品質判定結果または個別の測定項目の品質判定結果を取得するために使用されます。

  • valueコマンド:指定したプロジェクトの測定値を取得するために使用されます。

  • recipeコマンド:指定したプロジェクトのパラメータレシピを切り替えるために使用されます。

  • solutionコマンド:ソリューションを切り替えるために使用されます。

  • SetNumVarコマンド:数値型のグローバル変数に値を設定するために使用されます。

  • SetStrVarコマンド:文字列型のグローバル変数に値を設定するために使用されます。

  • GetNumVarコマンド:数値型のグローバル変数の値を読み取るために使用されます。

  • GetStrVarコマンド:文字列型のグローバル変数の値を読み取るために使用されます。

  • プロジェクトで使用するパラメータレシピを切り替える場合は、まず recipe コマンドを送信し、その後 trigger または execute コマンドを送信してプロジェクトの実行をトリガーしてください。

  • return/judge/valueコマンド は、triggerコマンド を送信してプロジェクトが正常にトリガーされた後にのみ送信できます。

  • Mech-MSRの 出力管理 画面で変更を行った後は、再度 triggerコマンド を送信してプロジェクトを実行し直し、その後に他のコマンドを送信して関連する結果を取得する必要があります。プロジェクトを再実行しない場合、取得される結果は変更を反映したものにはなりません。

triggerコマンド

triggerコマンドは、Mech-MSRプロジェクトの実行をトリガーするために使用され、複数のプロジェクトを同時にトリガーすることもサポートしています。

手順1:プロジェクト番号を確認

Mech-MSRのプロジェクトリストから実行をトリガーするプロジェクトの番号を確認します。

project number
プロジェクトの順序を調整するために上下にドラッグしてから、ソリューションを右クリックし、プロジェクト番号をリセット を選択すると、番号が更新されます。

手順2:コマンドを送信

送信される triggerコマンド は、triggerプロジェクト番号文字列の区切り文字 の3つの部分で構成されます。

  • trigger:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:Mech-MSRソリューションでトリガーする必要があるプロジェクトの番号です。

  • 文字列の区切り文字:triggerとプロジェクト番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。文字列の区切り文字は、Mech-MSRの 通信設定 画面で その他のデータ形式 のパラメータから変更することができます。

triggerコマンド の送信形式と例は、下表に示されています。

コマンド形式 説明

trigger,プロジェクト番号

プロジェクトをトリガーして実行します。

番号1のプロジェクトをトリガーする場合:

trigger, 1

trigger, プロジェクト番号1, プロジェクト番号2, プロジェクト番号3

複数のプロジェクトをトリガーして実行します。

番号1、2、3のプロジェクトをそれぞれトリガーする場合:

trigger, 1, 2, 3

手順3:返された結果を確認

triggerコマンド を送信した後、受信したステータスコードが 1 であれば、コマンドの実行が成功したことを意味します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

returnコマンド

triggerコマンド でプロジェクトの実行をトリガーした後、returnコマンド を使用してそのプロジェクトの実行結果を取得します。returnコマンド は、一度に1つのMech-MSRプロジェクトの結果のみを取得できます。

手順1:返された結果の形式を確認

Mech-MSRの 通信設定 画面で、実際のニーズに応じて returnコマンドのデータ形式 を設定します。

デフォルトの形式は %judge,%value[%id],%judge[%id] です。

return command format

手順2:コマンドを送信

送信される returnコマンド は、returnプロジェクト番号文字列の区切り文字 の3つの部分で構成されます。

  • return:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:Mech-MSRソリューション内で triggerコマンド で実行をトリガーしたプロジェクトの番号です。

  • 文字列の区切り文字:returnとプロジェクト番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

returnコマンド の送信形式と例は、下表に示されています。

コマンド形式 説明

return, プロジェクト番号

プロジェクトの実行結果を取得します。

番号1のプロジェクトの実行結果を取得する場合:

return, 1

指定されたプロジェクトが triggerコマンド で実行されていることを確認する必要があります。そうでない場合、returnコマンド を送信しても、正常に結果を取得することはできません。

手順3:返された結果を確認

プロジェクト番号1を例に取ると、外部機器が return, 1 コマンドを送信した後、Mech-MSRは 通信設定 画面で設定された returnコマンドのデータ形式 に基づいて結果を返します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

returnコマンドのデータ形式 返された結果(例) 説明

%judge

1

プロジェクト1の全体品質判定結果がOKであることを示します。

%judge

0

プロジェクト1の全体品質判定結果がNGであることを示します。

%judge,%value[%id],%judge[%id]

1,0.0224,1,54.0000,0

プロジェクト1の全体品質判定結果がOKで、指定された2つの測定項目が順番に出力されます。最初の測定項目の値は0.0224で判定はOK、2番目の測定項目の値は54.0000で判定はNGです。

0,invalid,0

プロジェクト1の全体品質判定結果がNGであり、このプロジェクトは1つの測定項目のみを指定し、その測定項目には測定結果がなく、invalid(無効値) として返されたため、測定項目はNGと判定されます。

%judge,%value[2],%judge[2]

1,invalid,invalid

プロジェクト1の全体品質判定結果はOKですが、測定項目2の値と判定結果は無効です。

考えられる原因:

  • Mech-MSRの 出力管理 画面の 通信出力 タブでID値が2の測定項目が追加されていないことがあります。

解決策:

  • Mech-MSRの 出力管理 画面の 通信出力 タブでID値が2の測定項目が存在することを確認します。

  • returnコマンドのデータ形式 を変更して、ソフトウェアが有効な結果を正常に返せるようにします。

測定値と判定結果 を確認し、Mech-MSRが外部機器に結果を返すための基本条件を理解してください。

executeコマンド

executeコマンド は、triggerコマンドreturnコマンド の機能を組み合わせたもので、プロジェクトの実行をトリガーし、その判定結果と測定結果を取得するために使用できます。

手順1:コマンドを送信

送信される executeコマンド は、executeプロジェクト番号文字列の区切り文字 の3つの部分で構成されます。

  • execute:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:Mech-MSRソリューション内で実行をトリガーするプロジェクトの番号です。

  • 文字列の区切り文字:executeとプロジェクト番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

executeコマンド の送信形式と例は、下表に示されています。

コマンド形式 説明

execute, プロジェクト番号

プロジェクトの実行をトリガーし、そのプロジェクトの判定結果と測定結果を取得するために使用されます。

番号1のプロジェクトをトリガーし、プロジェクトの判定結果と測定結果を取得する場合:

execute, 1

executeコマンド(コマンドコード1)は、1つのプロジェクトの実行をトリガーし、その判定結果と測定結果を取得するためにのみ使用できます。

手順2:返された結果を確認

プロジェクト番号1を例に取ると、外部機器が execute, 1 コマンドを送信した後、Mech-MSRは 通信設定 画面で設定された returnコマンドのデータ形式 に基づいて結果を返します。詳細については、returnコマンドの返される結果 をご参照ください。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

judgeコマンド

triggerコマンド でプロジェクトの実行をトリガーした後、judgeコマンド は指定したMech-MSRプロジェクトの全体判定結果または個別の測定項目の判定結果を取得するために使用されます。

手順1:コマンドを送信

送信される judgeコマンド は、judgeプロジェクト番号文字列の区切り文字 の3つの部分で構成されます。

  • judge:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:Mech-MSRソリューション内で triggerコマンド で実行をトリガーしたプロジェクトの番号です。

  • 文字列の区切り文字:judgeとプロジェクト番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

judgeコマンド の送信形式と例は、下表に示されています。

コマンド形式 説明

judge, プロジェクト番号

指定したプロジェクトの全体判定結果または個別の測定項目の判定結果を取得するために使用されます。

番号1のプロジェクトの全体判定結果または個別の測定項目の判定結果を取得する場合:

judge, 1

手順2:返された結果を確認

プロジェクト番号1を例に取ると、外部機器が judge, 1 コマンドを送信した後、Mech-MSRは 出力管理 画面で設定された 品質判定ルール通信出力内容 に基づいて、プロジェクトの全体品質判定結果と個別の測定項目の品質判定結果を返します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

返された結果 説明

1,1,1

(例)

最初の 1 はプロジェクト1の全体判定結果がOKであることを示し、続く2つの 1 は、このプロジェクトで出力する2つの測定項目が両方とも合格(OK)であることを示します。

0,0,0

(例)

最初の 0 はプロジェクト1の全体判定結果がNGであることを示し、続く2つの 0 は、このプロジェクトで出力する2つの測定項目が両方とも不合格(NG)であることを示します。

判定結果 を確認し、Mech-MSRが外部機器に結果を返すための基本条件を理解してください。

valueコマンド

triggerコマンド でプロジェクトの実行をトリガーした後、valueコマンド は指定したプロジェクトの測定値を取得するために使用されます。

手順1:コマンドを送信

送信される valueコマンド は、valueプロジェクト番号文字列の区切り文字 の3つの部分で構成されます。

  • value:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:Mech-MSRソリューション内で triggerコマンド で実行をトリガーしたプロジェクトの番号です。

  • 文字列の区切り文字:valueとプロジェクト番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

valueコマンド の送信形式と例は、下表に示されています。

コマンド形式 説明

value, プロジェクト番号

指定されたプロジェクトの測定値を取得するために使用されます。

番号1のプロジェクトの測定値を取得する場合:

value, 1

手順2:返された結果を確認

プロジェクト番号1を例に取ると、外部機器が value, 1 コマンドを送信した後、Mech-MSRは 出力管理 画面で設定された 品質判定ルール通信出力内容 に基づいて、プロジェクトの全体品質判定結果と各測定項目の測定値を返します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

返された結果 説明

1,54.0000

(例)

1はプロジェクト1の全体判定結果がOKであることを示し、測定項目1の値は54.000です。このプロジェクトは1つの測定項目のみを出力するように指定されています。

0,54.0000

(例)

0はプロジェクト1の全体判定結果がNGであることを示し、測定項目1の値は54.0000です。このプロジェクトは1つの測定項目のみを出力するように指定されています。

0,invalid

(例)

0はプロジェクト1の全体判定結果がNGであることを示します。このプロジェクトは1つの測定項目のみを出力するように指定されていますが、その測定項目には測定結果がなく、invalid(無効値) として返されます。

考えられる原因:その測定項目には測定結果がありません。

解決策:測定項目を確認し、プロジェクトが実行された後、その測定項目の有効な結果が出力されることを確認してください。

測定値と判定結果 を確認し、Mech-MSRが外部機器に結果を返すための基本条件を理解してください。

recipeコマンド

recipe コマンドは、プロジェクトに使用するパラメータレシピを切り替えるために使用されます。プロジェクトのパラメータレシピの設定方法とパラメータレシピ番号の確認方法については、パラメータレシピ をご参照ください。

recipe コマンドでパラメータレシピを切り替えた後、triggerコマンド または executeコマンド を送信して対応するプロジェクトの実行をトリガーする必要があります。

手順1:コマンドを送信

送信される recipe コマンドは、recipeプロジェクト番号パラメータレシピ番号文字列の区切り文字 の4つの部分で構成されます。

  • recipe:正確なコマンド名で、大小文字の変更はできません。

  • プロジェクト番号:パラメータレシピを切り替えるプロジェクトの Mech-MSR ソリューション内の番号です。

  • パラメータレシピ番号:切り替え先のパラメータレシピ番号です。

  • 文字列の区切り文字:recipe、プロジェクト番号、パラメータレシピ番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

recipe コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

recipe, プロジェクト番号, パラメータレシピ番号

指定したプロジェクトに使用するパラメータレシピを切り替えるために使用されます。

番号1のプロジェクトを番号2のパラメータレシピに切り替える場合:

recipe, 1, 2

手順2:返された結果を確認

recipe コマンドを送信した後、受信したステータスコードが 1 であれば、コマンドの実行が成功したことを意味します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

solutionコマンド

solution コマンドは、ソリューションを切り替えるために使用されます。

手順1:コマンドを送信

送信される solution コマンドは、solutionソリューションID文字列の区切り文字 の3つの部分で構成されます。

  • solution:正確なコマンド名で、大小文字の変更はできません。

  • ソリューションID:切り替え先のソリューションIDです。ソリューションIDの確認と調整方法については、ソリューション番号を調整 をご参照ください。

  • 文字列の区切り文字:solutionとソリューションIDを区切るための記号で、デフォルトでは英語のカンマ(,)です。

solution コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

solution, ソリューションID

ソリューションを切り替えるために使用されます。

IDが1のソリューションに切り替える場合:

solution, 1

手順2:返された結果を確認

solution コマンドを送信した後、受信したステータスコードが 1 であれば、コマンドの実行が成功したことを意味します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

SetNumVarコマンド

SetNumVar コマンドは、数値型のグローバル変数に値を設定するために使用されます。

グローバル変数は、現在のソリューション内でプロジェクト間で共有できる変数です。グローバル変数の設定方法とグローバル変数番号の確認方法については、グローバル変数管理ツール をご参照ください。

手順1:コマンドを送信

送信される SetNumVar コマンドは、SetNumVarグローバル変数番号グローバル変数値文字列の区切り文字 の4つの部分で構成されます。

  • SetNumVar:正確なコマンド名で、大小文字の変更はできません。

  • グローバル変数番号:値を設定する数値型グローバル変数の番号です。

  • グローバル変数値:設定するグローバル変数の値です。

  • 文字列の区切り文字:SetNumVar、グローバル変数番号、グローバル変数値を区切るための記号で、デフォルトでは英語のカンマ(,)です。

SetNumVar コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

SetNumVar, グローバル変数番号, グローバル変数値

指定した数値型グローバル変数に値を設定するために使用されます。

番号1の数値型グローバル変数を10に設定する場合:

SetNumVar, 1, 10

手順2:返された結果を確認

SetNumVar コマンドを送信した後、受信したステータスコードが 1 であれば、コマンドの実行が成功したことを意味します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

SetStrVarコマンド

SetStrVar コマンドは、文字列型のグローバル変数に値を設定するために使用されます。

グローバル変数は、現在のソリューション内でプロジェクト間で共有できる変数です。グローバル変数の設定方法とグローバル変数番号の確認方法については、グローバル変数管理ツール をご参照ください。

手順1:コマンドを送信

送信される SetStrVar コマンドは、SetStrVarグローバル変数番号グローバル変数値文字列の区切り文字 の4つの部分で構成されます。

  • SetStrVar:正確なコマンド名で、大小文字の変更はできません。

  • グローバル変数番号:値を設定する文字列型グローバル変数の番号。

  • グローバル変数値:設定するグローバル変数の値です。

  • 文字列の区切り文字:SetStrVar、グローバル変数番号、グローバル変数値を区切るための記号で、デフォルトでは英語のカンマ(,)です。

SetStrVar コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

SetStrVar, グローバル変数番号, グローバル変数値

指定した文字列型グローバル変数に値を設定するために使用されます。

番号1の文字列型グローバル変数を test に設定する場合:

SetStrVar, 1, test

手順2:返された結果を確認

SetStrVar コマンドを送信した後、受信したステータスコードが 1 であれば、コマンドの実行が成功したことを意味します。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

GetNumVarコマンド

GetNumVar コマンドは、数値型のグローバル変数の値を読み取るために使用されます。

グローバル変数は、現在のソリューション内でプロジェクト間で共有できる変数です。グローバル変数の設定方法とグローバル変数番号の確認方法については、グローバル変数管理ツール をご参照ください。

手順1:コマンドを送信

送信される GetNumVar コマンドは、GetNumVarグローバル変数番号文字列の区切り文字 の3つの部分で構成されます。

  • GetNumVar:正確なコマンド名で、大小文字の変更はできません。

  • グローバル変数番号:値を読み取る数値型グローバル変数の番号です。

  • 文字列の区切り文字:GetNumVarとグローバル変数番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

GetNumVar コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

GetNumVar, グローバル変数番号

指定した数値型グローバル変数の値を読み取るために使用されます。

番号1の数値型グローバル変数の値を読み取る場合:

GetNumVar, 1

手順2:返された結果を確認

GetNumVar コマンドを送信した後、読み取りに成功した場合、対応する数値型グローバル変数の値が返されます。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

GetStrVarコマンド

GetStrVar コマンドは、文字列型のグローバル変数の値を読み取るために使用されます。

グローバル変数は、現在のソリューション内でプロジェクト間で共有できる変数です。グローバル変数の設定方法とグローバル変数番号の確認方法については、グローバル変数管理ツール をご参照ください。

手順1:コマンドを送信

送信される GetStrVar コマンドは、GetStrVarグローバル変数番号文字列の区切り文字 の3つの部分で構成されます。

  • GetStrVar:正確なコマンド名で、大小文字の変更はできません。

  • グローバル変数番号:値を読み取る文字列型グローバル変数の番号です。

  • 文字列の区切り文字:GetStrVarとグローバル変数番号を区切るための記号で、デフォルトでは英語のカンマ(,)です。

GetStrVar コマンドの送信形式と例は、下表に示されています。

コマンド形式 説明

GetStrVar, グローバル変数番号

指定した文字列型グローバル変数の値を読み取るために使用されます。

番号1の文字列型グローバル変数の値を読み取る場合:

GetStrVar, 1

手順2:返された結果を確認

GetStrVar コマンドを送信した後、読み取りに成功した場合、対応する文字列型グローバル変数の値が返されます。

コマンドの実行に失敗した場合は、エラーステータスコードが返されます。エラーコードの説明 を参照して、考えられる原因と解決策を確認してください。

この情報は役に立ちましたか?

ご意見・ご要望がございましたら、以下よりお寄せください:

Mech-Mindは、お客様のプライバシーを重視しています

このサイトでは最高の体験を提供するために Cookie を使用しています。サイトの閲覧を続ける場合、Cookie の使用に同意したことになります。「拒否する」を選択すると、このサイトを訪れた際に追跡や記憶が行われないように単独の Cookie が使用されます。