UR E-Series (Polyscope 5.9 or Above)

This section introduces the process of setting up the Standard Interface communication with a Universal Robots (UR) E-series robot.

Plugin Installation and Setup

This section introduces the installation and setup of Mech-Mind 3D Vision Interface (URCap plugin) for UR E-series.

Prerequisites

Verify that you meet the minimum required versions for Mech-Mind vision-series software and Polyscope.

To view the version of Polyscope, press the hamburger menu in the upper-right corner of the UR teach pendant and select About.

../../../../_images/settings_e1.png

Install the URCap plugin

To install the URCap plugin, follow these steps:

  1. In the Mech-Center\Robot_Interface\Robot_Plugin\UR_URCAP directory of the Mech-Mind Software Suite installation path, copy the URCap plugin file to a USB drive according to the version of Polyscope.

    • If the version of Polyscope is 5.9 or above (below 6.0), copy the file with the file extension “1.5.0.urcap” to a USB drive.

    • If the version of Polyscope is 6.0 or above, copy the file with the file extension “1.5.0.urcapx” to a USB drive.

  2. Insert the USB drive into the UR teach pendant.

  3. Press the hamburger menu in the upper-right corner, and select Settings.

    ../../../../_images/settings_e1.png
  4. On the Settings screen, select System > URCap.

    ../../../../_images/system_urcaps_e1.png
  5. Press + to navigate to the USB drive to locate the URCap plugin.

  6. On the Select URCap to install screen, select the URCap plugin and press Open. The URCap plugin will be automatically installed.

  7. Press Restart for the change to take effect.

Till now, the URCap plugin is successfully installed on the UR teach pendant.

Attention

After installing the URCap plugin, you also need to set the IP address of the robot (select Setting > System > Network). Note that the robot’s IP address and the IPC’s IP address must be on the same subnet.

Use Mech-Mind 3D Vision Interface

Note

Before use, make sure that your Mech-Vision and Mech-Viz (if used) projects are ready to run, and the Mech-Mind IPC is connected to the robot’s network.

To use Mech-Mind 3D Vision Interface, you need to complete the following setup.

  1. Click Robot and Interface Configuration on the toolbar of Mech-Vision.

  2. Select Listed robot from the Select robot drop-down menu, and then click Select robot model.

  3. Select the following options and click Apply.

    • Interface Type: Standard Interface

    • Protocol: TCP Server, ASCII

    • Port Number: 50000 (Cannot be changed)

  4. Make sure the Interface Service is started: on the toolbar of Mech-Vision, the Interface Service switch on the far right is flipped and turned to blue.

After the TCP server interface has been started in Mech-Vision, you can connect to it on the UR teach pendant.

  1. On the UR teach pendant, press Installation on the top bar, and then select URCaps > Network Settings. The Network Settings window of the URCap plugin is displayed.

    ../../../../_images/network_settings_e1.png
  2. Set MechMind IPC IP Address and Port No. to the IP address and port number of the Mech-Mind IPC respectively, and press Apply.

  3. Press Connection Test.

  • When the connection to the TCP server interface is established successfully, the return status should look like this:

    ../../../../_images/connection_pass3.png
  • When the connection to the TCP server interface fails to be established, the return status should be like this:

    ../../../../_images/connection_failed3.png

Note

The connection test is just for testing. Once connected, it will disconnect automatically. Therefore, you will see client online and offline logs on the Console tab of Mech-Vision Log panel.

Hand-Eye Calibration Using the Plugin

This section introduces the process of calibrating the camera extrinsic parameters using the URCap plugin.

The calibration process consists of four steps:

  1. Create a calibration program.

  2. Teach the calibration start point.

  3. Run a calibration program.

  4. Perform calibration in Mech-Vision.

Prerequisites

Before proceeding, please make sure that:

  • You have successfully connected to the TCP server interface with the URCap plugin.

  • You are familiar with the contents of Hand-Eye Calibration Guide of Mech-Vision.

Create a Calibration Program

  1. On the top bar of the UR teach pendant, press New and select Program to create a new program.

  2. Press Program on the top bar, and then select URCaps > Mech-Mind Calibrate. An example program node Calibrate is automatically created under the Robot Program on the left panel.

    ../../../../_images/add_calibrate_node_e1.png

The created example program node is just a template. You need to further configure the calibration program and teach the calibration start point.

Teach the Calibration Start Point

  1. Select the Calibrate node in the program tree, and set the Type of point received from Mech-Vision parameter to “Joint Angle” or “Flange Pose” according to the actual needs on the Command tab of the right panel.

    ../../../../_images/add_calibrate_node_e1.png
  2. Select the MoveJ node in the program tree, set the motion type to “MoveJ”, “MoveL” or “MoveP”, and Set TCP to Ignore Active TCP on the right Move panel to ensure that the waypoint will be recorded as flange pose.

    ../../../../_images/set_movej_e1.png
  3. Manually control the robot to move to the start point for the calibration.

  4. On the UR teach pendant, select the start_pose node in the program tree, and press Set Waypoint on the right Waypoint panel. Then you can switch it to the Move tab.

    ../../../../_images/teach_startpoint_e1.png
  5. On the Move tab, confirm that the robot’s current flange pose is proper and press OK.

    ../../../../_images/confirm_waypoint_e1.png

Run a Calibration Program

  1. Select Robot Program on the left panel, and clear the Program Loops Forever checkbox on the right Program panel to ensure that the program is run just once.

    ../../../../_images/run_calibrate_e1.png
  2. On the bottom bar, lower the robot speed to a proper value, such as 10%, for safety concerns.

  3. Press run on the bottom bar to run the program.

When the calibration program runs successfully, The following message is displayed in the Console tab of Mech-Vision Log panel:

Entering the calibration process, please start the calibration in Mech-Vision.

Complete Calibration in Mech-Vision

  1. In Mech-Vision, click Camera Calibration (Standard) on the toolbar, or select Camera ‣ Camera Calibration ‣ Standard from the menu bar.

  2. Follow the instructions in Mech-Vision to complete the configuration.

To save the calibration program for future use, select Save > Save Program As… on the top bar to save it.

../../../../_images/save_program_e1.png

After you complete the hand-eye calibration, you can create pick-and-place programs to instruct UR robots to execute vision-guided pick-and-place tasks.

Create Pick and Place Programs

The URCap plugin provides an example Pick and Place program node for you to create pick-and-place programs with minimal programming efforts.

This Pick and Place program node provides three options:

The plugin provides a program template for each option to facilitate the programming.

Note

The following examples assume that the actually used gripper and its TCP have been set for the robot properly.

Create a Pick and Place with Mech-Vision (picking points) Program

To create a Pick and Place with Mech-Vision (picking points) program, follow these steps:

  1. Enable the Pick and Place With Vision (picking points) option.

    1. Press Program on the top bar, and then select URCaps > Mech-Mind Pick and Place. An example program node Pick and Place is automatically created under the Robot Program on the left panel.

    2. Select Structure > URCaps, and press Mech-Mind Pick and Place to add a Pick and Place program node to the Robot Program on the left panel.

      ../../../../_images/add_pick_place_node_e1.png
    3. On the Command tab of the right panel, press the With Vision (picking points) button. A program template is automatically created under the Pick and Place node in the program tree.

      ../../../../_images/select_with_vision_option_e1.png
  2. Select the Mech-Mind Connect node in the program tree, and verify that the Host IP setting is the IP address of the Mech-Mind IPC on the right Mech-Mind Connect panel.

    ../../../../_images/verify_host_ip_vision_e1.png
  3. Set the image-capturing pose.

    1. Manually move the robot to the proper location where Mech-Vision triggers to capture an image.

    Note

    • For Eye-In-Hand scenarios, the robot should be placed above the workpiece.

    • For Eye-To-Hand scenarios, the robot should not block the camera view.

    1. On the teach pendant, select the MoveJ in the program tree, set the motion type to “MoveJ”, “MoveL” or “MoveP”, and Set TCP to Use active TCP on the right Move panel.

      ../../../../_images/set_movej_capture_e1.png
    2. Select the Capture_image node in the program tree, press Set Waypoint on the right Waypoint panel. Then you can switch it to the Move tab.

      ../../../../_images/set_waypoint_capture_e1.png
    3. On the Move tab, confirm that the robot’s current TCP pose is proper and press OK.

      ../../../../_images/confirm_waypoint_e1.png
    4. Once the image-capturing pose is set, proceed to the next step.

  4. Trigger the Mech-Vision project to run.

    1. Set the parameters Type of robot pose to send, Mech-Vision Project ID, and Num of expected poses on the right Trigger Mech-Vision panel.

      ../../../../_images/trigger_vision_e1.png

    Parameter

    Description

    Type of robot pose to send

    Specify the type of robot pose to be sent to Mech-Vision.

    • Current Position: Send robot poses to Mech-Vision by “Current JPs + Flange”. It is recommended that the project is in Eye-In-Hand mode. In use, the “Path Planning” Step in the Mech-Vision project can send the JPs by the robot. If the flange pose is 0, the flange data will be ignored.

    • Predefined JPs: Send robot poses to Mech-Vision by predefined JPs (the JPs variable set by the users). It is recommended that the project is in Eye-In-Hand mode. In use, the “Path Planning” Step in the Mech-Vision project can use the JPs sent by the robot as the initial pose.

    Mech-Vision Project ID

    The index of the Mech-Vision project to trigger. You can find the project ID in the Project List panel of Mech-Vision.

    Num of expected poses

    The number of vision points that you expect Mech-Vision to output.

    • If it is set to 0, all detected object poses, but no more than 20, will be output.

    • If it is set to a number from 1 to 20, Mech-Vision will try to return the fixed number of vision points if the total detected number is greater than the number you expect.

    1. (Optional) Press Set the Recipe ID and a Set Recipe ID node are added under the Trigger Mech-Vision node in the program tree.

    2. Select the Set Recipe ID node in the program tree, and set Project parameter recipe ID on the right Set Recipe ID panel.

      ../../../../_images/set_receipe_id_e1.png
  5. Set how to receive Mech-Vision result.

    Select the Receive Mech-Vision Result node in the program tree, select Result type as Basic, and set variable names for Pose, Label, Total Received, and Status Code, which are used to save the vision result.

    ../../../../_images/receive_vision_result_e1.png

    Parameter

    Description

    Result type

    Basic: Receive vision point and label. Planned path: Recieve waypoint and label sent from the “Path Planning” Step. Custom: Receive vision point, label, and user-defined port data

    Pose

    The points of detected parts in XYZ format. The robot can directly move to the point with active TCP. By default, the received points are saved in the array variable “pose[]”, starting with array index 1.

    Label

    The object labels of detected parts. The label is an Integer. By default, the labels are saved in the array variable “label[]”, starting with array index 1. Labels and Poses are one-to-one paired.

    Total Received

    The total number of received object poses.

    Status Code

    The returned status code. See Status Codes and Troubleshooting for reference. 11xx indicates that the status is normal, while 10xx indicates that there is an error. By default, the status code is saved in the variable “status_code”.

    Starting at ID

    The start index of the array variables for poses and labels. By default, the index starts with 1.

    Picking point index

    This variable is only displayed in the interface if Result type is Planned path. The index of Vision Move in the received waypoints. For example, the “Path Planning” Step sends 3 points in the order of Relative Move_1, Vision Move_1, Relative Move_2, so the picking point index is 2. By default, the picking point index is saved in the variable “vision_point”.

    Custom data

    This variable is only displayed in the window if Result type is Custom. It is the user-defined data received from the Steps in Mech-Vision, namely, data of ports other than poses and labels. By default, custom data is stored in the variable “custom_data”.

  6. Set the pick task.

    Note

    A pick task consists of three motions: Pick_above, performs a linear approach to the pick point; Pick, picks the object, and Pick_depart, performs a linear departure away after picking.

    1. Set the parameters Dist and Coordinates for the Pick_above and Pick_depart respectively on the right Mech-Mind Pick panel.

      ../../../../_images/set_distance_coordinates_e1.png
    2. Select the MoveJ node under the pick node in the program tree, and keep the default settings on the right Move panel.

    3. Select the pick_above node in the program tree, and keep the default settings on the right Waypoint panel.

    4. Select the MoveL node in the program tree, and keep the default settings on the right Move panel.

    5. Select the pick node in the program tree, and keep the default settings on the right Waypoint panel.

    6. Add gripper control logic for picking after the pick node according to your actual conditions.

    7. Select the second MoveJ node in the program tree, and keep the default settings on the right Move panel.

    8. Select the pick_depart node in the program tree, and keep the default settings on the right Waypoint panel.

  7. Set the place task.

    1. Select the MoveJ node under the place node in the program tree, and keep the default settings on the right Move panel.

    2. Manually move the robot to the proper location to place the picked object.

    3. On the teach pendant, select the place node under the MoveJ node in the program tree, and press Set Waypoint on the right Waypoint panel. Then you can switch it to the Move tab.

      ../../../../_images/set_waypoint_place_e1.png
    4. On the Move tab, confirm that the robot’s current flange pose is proper and press OK.

      ../../../../_images/confirm_waypoint_e1.png
    5. Once the place pose is set, you can add gripper control logic for picking after the pick node according to your actual conditions.

Till now, a simple pick-and-place program with Mech-Vision (picking points) has been completed. You can run it by just pressing run on the bottom bar.

Create a Pick and Place with Mech-Vision (picking path) Program

To create a Pick and Place with Mech-Vision (picking path) program, follow these steps:

  1. Enable the Pick and Place With Vision (picking path) option.

    1. On the top bar of the UR teach pendant, press New and select Program to create a new program.

    2. Press Program on the top bar, and then select URCaps > Mech-Mind Pick and Place. An example program node Pick and Place is automatically created under the Robot Program program tree on the left panel.

      ../../../../_images/add_pick_place_node_e1.png
    3. On the Command tab of the right panel, press the With Vision (picking path) button. A program template is automatically created under the Pick and Place node in the program tree.

      ../../../../_images/select_with_vision_path_option_e.png
  2. Set the value of Host IP to the IP address of the Mech-Mind IPC by referring to step 2 in Pick and Place with Mech-Vision (picking points).

  3. Set the image-capturing pose by referring to step 3 in Pick and Place with Mech-Vision (picking points).

  4. See how to trigger the Mech-Vision project to run by referring to step 4 in Pick and Place with Mech-Vision (picking points).

  5. Set how to receive Mech-Vision result by referring to step 5 in Pick and Place with Mech-Vision (picking points).

    Attention

    • Select Receive Mech-Vision Result node in the program tree, and the Result type should be Planned path.

    • The variable of Picking point index indicates the index of Vision Move in the received waypoints. For example, the “Path Planning” Step sends 3 points in the order of Relative Move_1, Vision Move_1, Relative Move_2, so the picking point index is 2.

  6. Configure the motion loop, which drives the robot to follow the path planned by the “Path Planning” Step, that is, approach the object, pick the object, and depart from the pick point (not including placing the object). For how to set MoveL and MoveJ nodes, refer to step 6 in Pick and Place with Mech-Vision (picking points).

    Note

    In actual applications, the motion loop may contain several pick_above MoveJ nodes, a pick MoveL node, and several pick_depart MoveJ nodes.

  7. Set the place task by referring to step 7 in Pick and Place with Mech-Vision (picking points).

Till now, a simple pick-and-place program with Mech-Vision (picking path) has been completed. You can run it by just pressing run on the bottom bar.

Create a Pick and Place with Mech-Viz Program

To create a Pick and Place with Mech-Viz program, follow these steps:

  1. Enable the Pick and Place With Mech-Viz option.

    1. On the top bar of the UR teach pendant, press New and select Program to create a new program.

    2. Press Program on the top bar, and then select URCaps > Mech-Mind Pick and Place. An example program node Pick and Place is automatically created under the Robot Program on the left panel.

      ../../../../_images/add_pick_place_node_e1.png
    3. On the Command tab, and press the With Mech-Viz button on the right panel. A program template is automatically created under the Pick and Place node in the program tree.

      ../../../../_images/select_with_viz_option_e1.png
  2. Select the Mech-Mind Connect node in the program tree, and verify that the Host IP setting is the IP address of the Mech-Mind IPC on the right Mech-Mind Connect panel.

    ../../../../_images/verify_host_ip_viz_e1.png
  3. Set the image-capturing pose in reference to step 3 in Pick and Place with Mech-Vision (picking points).

    Note

    The point is where to trigger the Mech-Viz project.

  4. Trigger the Mech-Viz project to run.

    1. Select the Trigger Mech-Viz node in the program tree, and set the Type of robot pose to send on the right Trigger Mech-Viz panel.

      ../../../../_images/trigger_viz_e1.png

    Note

    • If the robot pose type is Current Position, the current JPs and flange pose will be sent to Mech-Viz, and the simulated robot of Mech-Viz will move to the first waypoint from the current position of robot JPs. If the robot pose type is Predefined JPs, a predefined JPs will be sent to Mech-Viz, and the simulated robot of Mech-Viz will move to the first waypoint from the current position set by the current robot joint variable.

    • If you use the branch task in the Mech-Viz project and want the robot to select the branch out port, press Set branch exit port, and proceed to step b to set the branch exit port.

    • If you use a move-class task that has the index parameter, press Set Index Value, and proceed to step c to set the index value.

    1. (Optional) Select the Set Branch Value node in the program tree, and set Branch Step ID and Exit port number on the right Set Branch Value panel.

      ../../../../_images/set_brach_value_e1.png
    2. (Optional) Select the Set Index Value node in the program tree, and set Move Step ID and Index value on the right Set Index Value panel.

      ../../../../_images/set_index_value_e1.png
  5. Set how to receive Mech-Viz result.

    Select the Receive Mech-Viz Result node in the program tree, and set variable names for Pose, Label, Speed (%), Total Received, Status Code, and Picking point index, which are used to save the planned path.

    ../../../../_images/receive_viz_result_e1.png

    Parameter

    Description

    Pose

    The planned waypoint pose in XYZ format. The robot can directly move to the point with active TCP. By default, the received points are saved in the array variable “pose[]”, starting with array index 1.

    Label

    The object labels of detected parts. The label is an integer. For non-vision point, the label should be 0. By default, the labels are saved in the array variable “label[]”, starting with array index 1. Labels and Poses are one-to-one paired.

    Speed

    The motion speed of the robot moving to the point in percentage.

    Total Received

    The total received number of waypoint pose.

    Status Code

    The returned status code. See Status Codes and Troubleshooting for reference. 21xx indicates that the status is normal, while 20xx indicates that there is an error. Default the status code is saved in the variable “status_code”.

    Picking point index

    The index of Vision Move in the received waypoints. For example, Mech-Viz sends 3 points in the order of Relative Move_1, Vision Move_1, Relative Move_2, so the picking point index is 2. By default, the picking point index is saved in the variable “vision_point”.

    Starting at ID

    The start index of the array variables for poses and labels. By default, the index starts with 1.

  6. Configure the motion loop, which drives the robot to follow the path planned by Mech-Viz, that is, approach the object, pick the object, and depart from the pick point (not including placing the object). For how to set MoveL and MoveJ nodes, refer to step 6 in Pick and Place with Mech-Vision (picking points).

    Note

    • In actual applications, the motion loop may contain several pick_above MoveJ nodes, a pick MoveL node, and several pick_depart MoveJ nodes.

    • If you change the default variable names of poses, labels, etc. in the node of Receive Mech-Viz Result, you need to change the variables used in this Step.

  7. Set the place task by referring to step 7 in Pick and Place with Mech-Vision (picking points).

Till now, a simple pick-and-place program collaborating with a Mech-Viz project has been completed. You can run it by just pressing run on the bottom bar.