EtherNet/IP–KEYENCE PLC Setup Instructions

This topic provides two methods on setting up the Standard Interface communication based on the EtherNet/IP protocol between a KEYENCE PLC and Mech-Mind Vision System.

  • Use PCI-e card.

  • Configure the software. No card required.

You should choose one of the methods to set up the communication. You cannot choose both methods.

Hardware and Software Requirements

Hardware

If you configure the software to set up the EtherNet/IP communication, click this line to view the required hardware and hardware connection settings.

  • KEYENCE PLC: KV-8000 series, or other models with a KV-EP21V or KV-NC1EP EtherNet/IP Unit

    A KV-8000 model is used in the example below.

  • USB Type A Male to Type B Male cable

  • AC 220V to DC 24V power adapter

  • Network switch and Ethernet cables

  • IPC

hardware connection soft
If you use a PCI-e card to set up the EtherNet/IP communication, click this line to view the required hardware and hardware connection settings.

  • KEYENCE PLC: KV-8000 series, or other models with a KV-EP21V or KV-NC1EP EtherNet/IP Unit

    A KV-8000 model is used in the example below.

  • USB Type A Male to Type B Male cable

  • AC 220V to DC 24V power adapter

  • Network switch and Ethernet cables

  • HMS IXXAT INpact EIP Slave PCIe interface card installed on the IPC or host computer

hardware connection

Software

If you configure the software to set up the EtherNet/IP communication, click this line to view the required software.

  • KEYENCE PLC programming software KV STUDIO V11.41

  • Mech-Vision & Mech-Viz versions: 2.0.0 or above

  • Mech-Mind EDS file: Software EIP.eds. Location: Communication Component/Robot_Interface/EthernetIP in the directory where Mech-Vision and Mech-Viz are installed

  • PLC routine files:

    • CameraSignalsMove.mod (used to send signals of the vision system)

    • CameraTest.mod (used for testing of the vision system)

    • MM_XXX_XXX.kfb (used to implement the features of various interface functions)

    The files are stored in Communication Component/Robot_Interface/EthernetIP/Programming Samples/Keyence KV-8000 PLC EthernetIP in the installation directory where Mech-Vision & Mech-Viz are installed. Please copy and paste all files to the computer with KV STUDIO installed.

If you use a PCI-e card to set up the EtherNet/IP communication, click this line to view the required software.

  • KEYENCE PLC programming software KV STUDIO V11.41

  • Mech-Vision & Mech-Viz versions: 2.0.0 or above

  • VCI V4 (driver software for HMS IXXAT INpact 40 interface card)

  • HMS IPconfig software

  • Mech-Mind EDS file name: 005A002B003A0100.EDS; Location: Communication Component/Robot_Interface/EthernetIP in the directory where Mech-Vision and Mech-Viz are installed

  • PLC routine files:

    • CameraSignalsMove.mod (used to send signals of the vision system)

    • CameraTest.mod (used for testing of the vision system)

    • MM_XXX_XXX.kfb (used to implement the features of various interface functions)

    The files are stored in Communication Component/Robot_Interface/EthernetIP/Programming Samples/Keyence KV-8000 PLC EthernetIP in the installation directory where Mech-Vision & Mech-Viz are installed. Please copy and paste all files to the computer with KV STUDIO installed.

Configure Communication

If you configure the software to set up the EtherNet/IP communication, click this line to view the detailed operations.

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

  2. In the Robot Communication Configuration window, complete the following configurations.

    1. Click the Select robot drop-down menu, and select Listed robot. Click Select robot model, and select the robot model that you use. Then, click Next.

    2. In the Communication mode section, set Interface service type to Standard Interface, set Protocol to ETHERNET IP (Software), and set Network Adapters and IP Address to the network adapter and IP address used by the IPC.

    3. (Optional) Select Auto enable interface service when opening the solution.

    4. Click Apply.

      ethernet ip software

  3. On the main interface of Mech-Vision, make sure that the Robot Communication Configuration switch on the toolbar is flipped and has turned blue.

    interface service
If you use a PCI-e card to set up the EtherNet/IP communication, click this line to view the detailed operations.

Check PCI-e Card and Driver Software

  1. Please make sure that the INpact EIP Slave PCIe interface card has been pressed into the PCI-e slot of the IPC, as shown below.

    install communication board

  2. Start the IPC, go to Start ‣ Device Manager and check if the driver software VCI4 INpact PCIe has been installed.

    device manager

Set up “Robot Communication Configuration”

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

  2. In the Robot Communication Configuration window, complete the following configurations.

    1. Click the Select robot drop-down menu, and select Listed robot. Click Select robot model, and select the robot model that you use. Then, click Next.

    2. In the Communication mode area, select Standard Interface for Interface service type and select ETHERNET IP for Protocol.

    3. (Optional) Select Auto enable interface service when opening the solution.

    4. Click Apply.

      ethernet ip

  3. On the main interface of Mech-Vision, make sure that the Robot Communication Configuration switch on the toolbar is flipped and turned to blue.

    interface service

Configure IP address of the PCI-e Card

  1. Download and install HMS IPconfig software on the IPC first. Use an Ethernet cable to connect the network ports of the IPC and the INpact EIP Slave PCIe.

    After configuring the IP and initiating communication successfully, the Ethernet cable used here can be removed.

  2. Open HMS IPconfig, click to scan and select Ixxat INpact EtherNet/IP(TM). Then uncheck Retrieve IP settings dynamically from a DHCP server and enter the IP address and subnet mask, as shown below. The IP address should be the same as what is configured in the PLC. After configuration, click Apply.

    set ip

Install EDS File and Configure Communication

Create PLC Project

  1. Open KV STUDIO, click new, select the PLC model according to the model in use, and name the project. Then click Refer to select a location to store the project, and click OK to save settings.

    create plc 1

  2. If the message “Automatically set the operation recorder setting?” pops up, select Yes.

    create plc 2

  3. If the message “Setup unit setting info now?” pops up, select No.

    create plc 3

  4. In the left-side Project panel, go to Unit configuration ‣ KV 8000, double-click EtherNet/IP R30000 DM10000. An EtherNet/IP settings window will appear as shown below. Select Manual in the pop-up window.

    create plc 4

  5. In the EtherNet/IP settings window, select KV-8000, click Unit setting and then set the IP address of the PLC.

    create plc 5

Install EDS File and Configure Network

  1. Click EDS file in the EtherNet/IP settings window, and select Reg. In the pop-up window, locate and select the EDS file, then click Open.

    • The EDS file is stored in the Mech-Mind IPC. Location: Communication Component/Robot_Interface/EthernetIP in the installation directory where Mech-Vision and Mech-Viz are installed. If KV STUDIO is not installed on the same IPC, you can copy and paste the EthernetIP folder to the PC with KV STUDIO installed and click Reg.

    • If you configure the software to set up the EtherNet/IP communication, select the Software EIP.eds file. If you use a PCI-e card to set up the EtherNet/IP communication, select the 005A002B003A0100.EDS file. In this example, the 005A002B003A0100.EDS file is selected.
    eds file 0
    eds file 1

    If the message “The icon specified for EDS file could not be found.” pops up, select Select icon files and then click OK.

    eds file 2

    After selecting the icon files, click Open.

    eds file 3

  2. If the EDS file is registered successfully, Ixxat INpact EtherNet/IP™ will appear in the Unit list. Double-click it to connect to the EtherNet/IP network.

    eds file 4

  3. Set the IP address in the Initial adapter settings window, set the IP address of the IPC as same as which is set in HMS IPconfig, and then click OK.

    eds file 5

  4. Select Ixxat INpact EtherNet/IP™, click Unit setting(2) and then click .. next to Connection settings.

    eds file 6

  5. Now you can see a Connection settings window. Click Assign device. Assign the IN and OUT manually, as shown below (The Input and Output in the figure are applicable to this example only.) Then go back to the EtherNet/IP settings window after assigning.

    eds file 7

  6. Now the information of the server appears in the EtherNet/IP settings window. Click OK.

    eds file 8

  7. Click OK in the Unit Editor window.

    eds file 9

Download Hardware Configuration to PLC

  1. Go back to the main interface of KV STUDIO, click Transfer to PLC button in the menu bar, and the Transfer program window will pop up.

    download configuration 1

  2. Keep the default settings, and click Execute in the Transfer program window.

    download configuration 2

  3. Select Yes in the pop-up window showing the message “Change to PROGRAM mode and overwrite?”. Select Yes in the pop-up window showing the message “Change to RUN mode?”.

    download configuration 3
    download configuration 4

Check Communication

  1. If the PLC is connected successfully, the status of Ixxat INpact EtherNet/IP(TM) will be displayed as online in Monitor mode.

    establish communication 1

  2. The PLC is successfully connected if the following message is displayed in the Console tab of Mech-Vision Log panel: Connect to ETHERNET IP controller successfully.

    If you don’t see this log message, please check:

    1. If the hardware is properly connected;

    2. If the Interface Service has been started successfully in Mech-Vision;

    3. If the hardware configuration has been downloaded to the PLC.

Import Example Program and Download to PLC

Before you add the example program to a project already in use, it is recommended to import it to a new project and test it first. In the following steps, the project created earlier is used to import and test the example program.

Import Mech-Mind Example Programs

  1. In the main interface of KV STUDIO, go to File  Import  Import program, and the Import program window will pop up.

    import file 1

  2. In the Import program window, select the CameraSignalsMove.mod, CameraTest.mod, and MM_XXX_XXX.kfb files, and then click Open.

    import file 2

  3. Click OK in the Import completed window.

    import file 3

Download PLC Program to PLC

  1. Go back to the main interface of KV STUDIO, click Transfer to PLC → Monitor mode in the menu bar, and the Transfer program window will pop up.

    build plc 1

  2. Keep the default settings, and click Execute in the Transfer program window.

    build plc 2

  3. Select Yes in the pop-up window showing the message “Change to PROGRAM mode and overwrite?”. Select Yes in the pop-up window showing the message “Change to RUN mode?”.

    build plc 3
    build plc 4

Test with Mech-Vision/Mech-Viz Project

This section introduces how to use the example program function block to trigger the Mech-Vision project to obtain vision points and trigger the Mech-Viz project to obtain the planned path. For detailed information on the I/O units, please refer to EtherNet/IP-Keyence PLC Functions.

Prerequisites

  1. Mech-Vision project(s): Right-click the solution and select Autoload Solution. Projects in the solution are also autoloaded. Meanwhile, the project number will show up before each project name.

  2. Mech-Viz project: In Mech-Viz, right-click the project name in the Resources panel and select Autoload Project.

    The Mech-Viz project used for testing contains a “Branch by Msg” Step that has been renamed to 1 as shown below.

    preparation 4

Run Mech-Vision Project and Obtain Vision Points

Parameter Settings

  1. Go back to the main interface of KV STUDIO, go to Project ‣ Program, double-click CameraTest, and set the status of ToCamera.COM_ENABLE to be Always ON.

    test vision 1

  2. Set the Mech-Vision project ID according to the displayed number in the Project List panel in Mech-Vision. Set the value of VISION_PROJ_NUM to 1, then project No.1 in Mech-Vision will be started.

  3. Set the number of vision points to be sent by Mech-Vision project. Set the value of REQ_POSE_NUM to 0, which means the Mech-Vision project will send all the vision points.

    test vision 2

Start Mech-Vision Project

  1. Double-click the input variable Start_Vision of the MM_Start_Vis FB, and set the value to 1 to start Mech-Vision project. Then double-click the variable again to reset the value to 0.

    test vision 3

  2. Click Registration monitor window, locate FromCamera.STATUS_CODE in the Device column, and then check its current value. 1102 represents that the project was started successfully. Otherwise, the corresponding error code will be returned. Please refer to Status Codes and Troubleshooting for troubleshooting.

    test vision 4
    test vision 5

Obtain Vision Points from Mech-Vision

  1. After the status code 1102 is returned, double-click the input variable Get_VisData of the FB MM_Get_VisData to set the value to 1 and therefore obtain the vision points. Then double-click the variable again to reset the value to 0. The result is shown below. The value of SendPoseNum is 3, which means 3 vision points are obtained.

    test vision 6

  2. Check the current value of FromCamera.STATUS_CODE in the Registration monitor window. 1100 represents that the vision points were obtained successfully from Mech-Vision. Otherwise, the corresponding error code will be returned. Please refer to Status Codes and Troubleshooting for troubleshooting.

    test vision 7

Automate the Process of Getting Vision Results from Mech-Vision

The previous section introduces how to manually obtain vision results from Mech-Vision. To automate the process of obtaining vision results from Mech-Vision, connect the programs as the following example.

get vis results automatically 1
get vis results automatically 2
get vis results automatically 3
get vis results automatically 4

Run Mech-Viz Project and Obtain Planned Path

Parameter Settings

  1. Double-click the input variable Start_Empty of the FB MM_Get_VisData to set the value to 1. Then double-click the variable again to reset the value to 0. Open the device value batch modify/read window, and go to PLC  Read all items from PLC to check if the previously obtained vision data has been cleared successfully.

    test viz 1

  2. Set the value of Branch_Name and Branch_Exit_Port to 1 respectively, the Mech-Viz project will proceed along exit port 1 of Step 1.

    test viz 2

  3. Set the value of Request_Pose_Type to 1. This asks Mech-Viz to send joint positions (instead of TCP data).

    test viz 3

Start Mech-Viz Project

  1. Double-click the input variable Start_Viz of the FB MM_Start_Viz to set the value to 1 and therefore start Mech-Viz project. Then double-click the variable again to reset it to 0.

    test viz 4

  2. Check the current value of FromCamera.STATUS_CODE in the Registration monitor window. 2103 represents that the project was started successfully. Otherwise, the corresponding error code will be returned. Please refer to Status Codes and Troubleshooting for troubleshooting.

    test viz 5

Select Branch in the Mech-Viz Project

  1. Double click the input variable Set_Branch of the FB MM_Set_Branch, set the value to 1 in the Set New Value window to select branch in the Mech-Viz project and then reset it to 0.

    test viz 6

  2. Check the value returned by the variable FromCamera.STATUS_CODE. 2105 represents that the branch was selected successfully. Otherwise, the corresponding error code will be returned. Please refer to Status Codes and Troubleshooting for troubleshooting.

    test viz 7

Obtain Mech-Viz Planned Path

  1. Double click the input variable Get_VizData of the FB MM_Get_VizData, set the value to 1 in the Set New Value window to obtain planned path from Mech-Viz project and then reset it to 0.

    test viz 8

  2. Check the value returned by the variable FromCamera.STATUS_CODE. 2100 represents that planned path was obtained successfully. Otherwise, the corresponding error code will be returned. Please refer to Status Codes and Troubleshooting for troubleshooting. The result is shown in the figure. The value of SendPoseNum is 10, which means that 10 robot poses in joint positions have been obtained. The joint positions are stored in TargetPose.

    test viz 9

Automate the Process of Getting Planned Path from Mech-Viz

The previous section introduces how to manually obtain the planned path from Mech-Viz. To automate the process of obtaining the planned path from Mech-Viz, connect the programs as the following example.

get viz results automatically 1
get viz results automatically 2
get viz results automatically 3
get viz results automatically 4
get viz results automatically 5
get viz results automatically 6

We Value Your Privacy

We use cookies to provide you with the best possible experience on our website. By continuing to use the site, you acknowledge that you agree to the use of cookies. If you decline, a single cookie will be used to ensure you're not tracked or remembered when you visit this website.

  • Preference
  • I accept
  • I don't accept