KUKA標準インターフェースコマンド
本節では、KUKAロボットとMech-Mindインライン測定システム間でTCPプロトコル通信を行うための標準インターフェースコマンドについて説明します。そのうち、ロボット（クライアント側）はMech-Mindインライン測定システム（サーバー）にコマンドを送信し、Mech-Mindインライン測定システムは処理後のデータをロボットに返します。
コマンド一覧
| コマンド | 呼び出し必須か | 説明 |
|---|---|---|
必須 |
ロボットと通信するIPCのIPアドレス、ポート番号、および通信タイムアウトの待ち時間を設定する |
|
任意 |
ロボットがMech-Metricsにプロジェクトの切り替え開始を通知する |
|
必須 |
ロボットが Mech-Metrics に新しいワークの測定開始を通知し、ワーク名、ワークSN、およびその他のワーク情報を Mech-Metrics に送信する |
|
必須 |
対応する測定特徴の Mech-MSR プロジェクトの実行をトリガーする。複数回の測定を行う必要がある場合は、このコマンドを複数回呼び出す可能 |
|
必須 |
ロボットが Mech-Metrics に測定終了を通知し、ワークの測定結果を問い合わせる |
|
任意 |
一部のユースケースでは、測定開始時にワークSNを取得できない。例えば、測定中にバーコードやQRコードをスキャンして取得しなければならない。このコマンドは、ワーク測定中にワークSNを入力するために使用する |
|
任意 |
ワークSNを入力することで、Mech-Metrics ソフトウェアのメイン画面を対応するワークのデータビューに切り替える |
|
必須（自動キャリブレーションプログラムの場合） |
ロボットのハンドアイキャリブレーション（外部パラメータキャリブレーション）に使用する |
注意事項
これらのコマンドを使用する前に、以下の事項に注意してください。
-
KUKAロボットコマンドの呼び出しに関する説明：
-
コマンドの仮引数リスト内の各パラメータは半角カンマで区切ります。
-
各仮引数変数はローカル変数として定義され、該当するコマンド内でのみ有効です。
-
コマンドの仮引数リストは、入力パラメータおよび出力パラメータの定義に対応しています。
-
KUKAロボットの場合、通信初期化を除き、その他のコマンド内部にTCPプロトコル通信接続の確立および切断のロジックがすでに含まれており、実行前後に自動で接続・切断が行われます。
-
-
コマンドのデータ単位：
-
関節角度の単位は度（°）です。
-
ロボットのフランジ位置姿勢またはロボットのツール位置姿勢は位置と姿勢で構成されています。位置（XYZ座標値）の単位はミリメートル（mm）、姿勢はオイラー角で表され、単位は度（°）です。
-
通信初期化
このコマンドは、インライン測定システムとロボット間のTCPプロトコルによる通信接続を確立するために使用します。
コマンド形式
MM_Init_Socket(XML_Name,Alive_Flag,Recv_Flag,Time_Out)入力パラメータ
XML_Nameこのパラメータはネットワーク設定ファイルの名前を表し、文字列で指定され、大文字と小文字が区別されます。ここでのネットワーク構成ファイルは「XML_Kuka_MSR.xml」です。このファイルは、通信設定時にロボットに書き込まれており、ファイルの具体的な内容は以下の通りです。
<ETHERNETKRL>
<CONFIGURATION>
<EXTERNAL>
<IP>192.168.174.1</IP>
<PORT>4000</PORT>
</EXTERNAL>
<INTERNAL>
<ALIVE Set_Flag="20"/>
<BUFFERING Mode="FIFO" Limit="256"/>
<BUFFSIZE Limit="65534"/>
<TIMEOUT Connect="2000" Receive="5000"/>
<MESSAGES Display="enable" Logging="warning"/>
</INTERNAL>
</CONFIGURATION>
<RECEIVE>
<RAW>
<ELEMENT Tag="Buffer" Type="STREAM" Set_Flag="30" EOS="13,10|13|10"/>
</RAW>
</RECEIVE>
</ETHERNETKRL>このファイルでは、ユーザーは<IP>の値をIPCのIPアドレスに、<PORT>の値をロボット通信設定（Mech-MSRソフトウェアのツールバーで行われる）で設定されたホストポート番号に設定する必要があります。
Alive_Flagこのパラメータは、XML_Kuka_MSR.xmlファイル内の<ALIVE>における「Set_Flag」の値を表します。上記のファイルを例にとると、このパラメータ値は20に設定する必要があります。このパラメータ値に対応する信号がONであることは、インライン測定システムとロボットの通信が成功したことを示します。
Recv_Flagこのパラメータは、XML_Kuka_MSR.xmlファイル内の<RECEIVE>要素におけるSet_Flagの値を表します。上記のファイルを例にとると、このパラメータ値は30に設定する必要があります。このパラメータ値に対応する信号がONであることは、ロボットがインライン測定システムから送信されたデータを受信したことを示します。
Time_Outこのパラメータは通信タイムアウトの待ち時間を表し、単位は秒です。
サンプル
MM_Init_Socket("XML_Kuka_MSR",20,30,60)上記のサンプルは、XML_Kuka_MSR.xmlファイル内の設定情報に基づいて、インライン測定システムとロボット間のTCPプロトコルによる通信接続を確立することを示しています。
プロジェクトの切り替え
ロボットが Mech-Metrics にプロジェクト切り替えの開始を通知します。
呼び出しのタイミング
プロジェクト切り替えを開始する前。
コマンド形式
MSR_SW_PROJ(Robot_Id:IN,Job:IN,MSR_Status:OUT)入力パラメータ
Robot_Idこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。指定するワーク番号は、ワーク番号を設定画面で既に設定されている必要があります。データ型はnumです。
Jobこのパラメータはプロジェクト番号を示します。指定するプロジェクト番号は、あらかじめプロジェクト切り替え管理で設定されている必要があります。データ型はnumです。
出力パラメータ
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8105：コマンドの実行に成功しました。
-99：ロボット通信異常。
サンプル
MSR_SW_PROJ(1,1,MSR_Status)上記のサンプルは、ワーク番号1、プロジェクト番号1のプロジェクトに切り替え、コマンドのステータスコードをMSR_Statusに保存することを示しています。
測定タスクの開始
ロボットが Mech-Metrics に新しいワークの測定開始を通知し、ワーク名、ワークSN、およびその他のワーク情報を Mech-Metrics に送信します。
呼び出しのタイミング
新しいワークの測定を開始する時点。
コマンド形式
MSR_Start_Measure(RobotID:IN,Piece_Name:IN,Piece_SN:IN,Qc_Mode:IN,Custom_int1:IN,Custom_int2:IN,Custom_int3:IN,Custom_int4:IN,Custom_int5:IN,Custom_int6:IN,Custom_int7:IN,Custom_int8:IN,MSR_Continuous_Mode:OUT,MSR_Status:OUT)入力パラメータ
RobotIDこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。指定するワーク番号は、ワーク番号を設定画面で既に設定されている必要があります。データ型はnumです。
Piece_Nameこのパラメータは測定するワークの名称を示します。ワーク名には英数字を含めることができ、長さは20文字以内です。データ型はstringです。
Piece_SNこのパラメータはワークSNを示します。ワークSNとは、ワークのシリアル番号のことであり、そのワークの一意の識別子（ID）です。ワークSNには英数字を含めることができ、長さは30文字以内です。データ型はstringです。
Qc_Modeこのパラメータはワークの品質検査モードを示します。データ型はnumです。各パラメータ値の意味は以下の通りです：
-
1：全数検査
-
2：抜取検査
-
その他：既存の設定を使用
Custom_int1-Custom_int8このパラメータはオプションパラメータであり、ワークのカスタム情報を提供するために使用します。データ型はnumです。カスタムパラメータは、Mech-Metrics により多くのワーク情報を提供する必要がある場合にのみ使用されます。このコマンドでは、最大8つのカスタムパラメータを指定でき、各カスタムパラメータの値は1から8までの整数です。
カスタムパラメータを使用する場合：
-
Mech-Metrics ソフトウェア設定画面の上部にある機能エリアでを選択し、指定のカスタムパラメータ（例：カスタムパラメータ1）に対してその数値（1〜8）の意味を設定します。
-
このコマンドで指定のカスタムパラメータを設定します。
出力パラメータ
MSR_Continuous_Modeこのパラメータは、今回の実行が連続実行か通常の実行かを示します。データ型はnumです。
0：実行
1：連続実行
実行が指定された場合、ロボット側は以下のコマンドを1回実行します：測定タスクの開始→特徴測定の実行→測定タスクの終了。複数の特徴を測定する場合は、特徴測定の実行コマンドを複数回実行してください。例えば、ユーザーが2つの特徴を測定したい場合、1回の実行において、ロボット側で以下のようにコマンドを実行する必要があります：プログラム開始→測定タスクの開始→特徴測定の実行→特徴測定の実行→測定タスクの終了→プログラム終了。
連続実行が指定された場合、ロボット側は1ラウンドのコマンドを実行した後、測定タスクの開始に戻って繰り返し実行します。あるラウンドにおいて測定タスクの開始が1回実行が返された場合、ロボットプログラムは現在のラウンドのコマンド実行完了後に停止します。
|
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8100：コマンドの実行に成功しました。
-99：ロボット通信異常。
サンプル
MSR_Start_Measure(1,"zcl","ABC",2,10,20,30,40,50,60,70,80,MSR_Continuous_Mode,MSR_Status)上記のサンプルは、番号1、名前「zcl」、SN「ABC」のワークの測定を開始し、8つのカスタムパラメータを指定することを示しています。
特徴測定の実行
対応する特徴測定の Mech-MSR プロジェクト実行をトリガーします。
呼び出しのタイミング
ロボットが測定対象特徴の撮影位置に到達した時点。
コマンド形式
MSR_Measure_Feature("RobotID:IN","Index_Num:IN","MSR_Status:OUT")入力パラメータ
RobotIDこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。指定するワーク番号は、ワーク番号を設定画面で既に設定されている必要があります。データ型はnumです。
Index_Numこのパラメータは、測定対象となる特徴の測定番号を示します。データ型はnumです。測定番号はその特徴の一意の識別子（ID）です。測定特徴番号は1から999までの整数です。
出力パラメータ
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8101：コマンドの実行に成功しました。
-99：ロボットの通信に異常が発生しました。
サンプル
MSR_Measure_Feature(1,1,MSR_Status)上記のサンプルは、ロボット側からワーク番号1、測定対象特徴の測定番号1となる Mech-MSR プロジェクトの実行をトリガーし、ステータスコードをMSR_Statusに保存することを示しています。
測定タスクの終了
ロボットが Mech-Metrics に測定終了を通知し、ワークの測定結果を問い合わせます。
呼び出しのタイミング
最後の測定対象特徴の撮影が完了し、ワークの測定が完了した時点。
コマンド形式
MSR_End_Measure(Robot_ID:IN,Judge:OUT,Failed_Count[]:OUT,MSR_Status:OUT)入力パラメータ
Robot_IDこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。指定するワーク番号は、ワーク番号を設定画面で既に設定されている必要があります。データ型はnumです。
出力パラメータ
Judgeこのパラメータはワークの判定結果を保存します。1はOK、0はNGを表します。データ型はnumです。
Failed_Count[]このパラメータは、ワークの測定項目数を保存するための数值レジスタ番号を示します。データ型はnumです。詳細は以下の通りです：
-
Failed_Count[1]ワークが公差1を超えた測定項目数を保存します。
-
Failed_Count[2]ワークが公差1を超えた測定項目数を保存します。
-
Failed_Count[3]ワークが公差1を超えた測定項目数を保存します。
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8102：コマンドの実行に成功しました。
-99：ロボットの通信に異常が発生しました。
サンプル
MSR_End_Measure(1,MSR_Judge,Failed_Count[],MSR_Status)上記のサンプルは、ロボットが Mech-Metrics に測定終了（ワーク番号1）を通知し、同時にワークの判定結果了をMeasure_Resultに、測定項目数をFailed_Count[]に保存し、コマンドのステータスコードをMSR_Statusに保存することを示しています。
測定中のワークSN入力
一部のユースケースでは、測定開始時にワークSNを取得できない。例えば、測定中にバーコードやQRコードをスキャンして取得しなければなりません。このコマンドは、ワーク測定中にワークSNを入力するために使用する
呼び出しのタイミング
現在のワーク測定中の任意時点。
コマンド形式
MSR_Set_Piece_Info(Robot_Id:IN,Piece_Sn:IN,MSR_Status:OUT)入力パラメータ
Robot_Idこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。指定するワーク番号は、ワーク番号を設定画面で既に設定されている必要があります。データ型はnumです。
Piece_SnこのパラメータはワークSNを示します。ワークSNとは、ワークのシリアル番号のことであり、そのワークの一意の識別子（ID）です。ワークSNには英数字を含めることができ、長さは30文字以内です。データ型はstringです。
出力パラメータ
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8103：コマンド実行成功。
-99：ロボット通信異常。
サンプル
MSR_Set_Piece_Info(1,"ert",MSR_Status)上記のサンプルは、ロボットが Mech-Metrics にワークSN「ert」のワーク（ワーク番号1）を入力することを示しています。
ワーク履歴データの照会
外部からワークSNを入力することにより、Mech-Metrics ソフトウェアのメイン画面を入力された番号のワークに切り替えます。
呼び出しのタイミング
非測定中の任意時点。
コマンド形式
MSR_View_Piece_Data(Robot_Id,Piece_Sn:IN,MSR_Status:OUT)入力パラメータ
Robot_Idこのパラメータはワーク番号を示します。ワーク番号は1から99までの整数です。データ型はnumです。
Piece_SnこのパラメータはワークSNを示します。ワークSNとは、ワークのシリアル番号のことであり、そのワークの一意の識別子（ID）です。ワークSNには英数字を含めることができ、長さは30文字以内です。データ型はstringです。
出力パラメータ
MSR_Statusこのパラメータは、コマンドのステータスコードを保存するために使用します。
8104：コマンドの実行に成功しました。
-99：ロボット通信異常。
サンプル
MSR_View_Piece_Data(1,"ert",MSR_Status)上記のサンプルは、ロボットがワークSNを Mech-Metrics に入力し（ワーク番号は1）、Mech-Metrics ソフトウェアのメイン画面を該当ワークのデータビューに切り替え、コマンドのステータスコードをMSR_Statusに保存することを示しています。
キャリブレーション
このコマンドは、ロボットのハンドアイキャリブレーション（外部パラメータのキャリブレーション）に使用します。このコマンドは、Mech-MSRカメラメニューの3Dカメラキャリブレーションツールと組み合わせて使用する必要があります。
呼び出し順序
正式な測定を開始する前に、このコマンドを呼び出してロボットのハンドアイキャリブレーションを行う必要があります。
コマンド形式
MM_Calib(Move_Type,PosJps,WaitTime,E1)入力パラメータ
{Move_Type}
このパラメータはロボットの移動タイプを示し、値の範囲が1または2です。
-
1：直線運動
-
2：関節運動
{Pos_Jps}
このパラメータは、キャリブレーションポイントの位置姿勢形式を指定するために使用し、値は1または2です。
-
1：ツール位置姿勢
-
2：関節角度
{Wait_time}
このパラメータは、ロボットがキャリブレーションポイントに移動した後の待ち時間（ロボットの振動・ブレを防止するため）を示します。単位は秒で、デフォルトは2秒です。データ型はnumです。
{Ext}
このパラメータは外部軸のデータを示し、単位はミリメートル（mm）です。現場に第7軸のレールがあり、ロボットがそのレールの動きを制御する場合は、このパラメータを具体的な外部軸データ値に設定する必要があります。そうでない場合、このパラメータは0に設定してください。
出力パラメータ
TOP_Status
コマンドのステータスコードを保存するために使用します。
サンプル
MM_Calib(2,1,2,0)上記のサンプルは、キャリブレーションポイントの位置姿勢形式がツール位置姿勢であり、ロボットが関節角度形式でキャリブレーションポイントに移動した後の待ち時間が2秒であることを示しています。