IO-Link device Add-On Instruction
1. Scope
This User Guide describes installing, using, and maintaining the Add-On Instruction (AOI) software module for Balluff IO-Link Devices. This software module is designed for use with RSLogix5000.
Prerequisite; set-up of IO-Link Master AOI, using IO-Link Master AOI User Guide.
2. Products
This guide was developed for use in conjunction with the AOI software module for Balluff’s IO-Link Master device. This software module is available for download at the website.
The Balluff AOI software module was developed for use with a Balluff IO-Link Device in conjunction with the Balluff EtherNet/IP Connectivity block BNI EIP-502-105-Z015 (hardware version 4.0, firmware version 2.7). Although this Add-On Instruction User Guide covers many Balluff IO-Link devices, each device has a unique AOI software module.
For the development of this software module and hardware configuration, the following system components were used and validated:
- RSLogix5000, version 18.01 (or later)
- Rockwell 1756-L63 controller
3. Instructions
This section describes the process for installing and using the AOI module. This is a three-step process that must be followed sequentially: complete the configuration of Balluff BNI EIP-502-105-Z015 module with its associated AOI; import AOI module along with all associated UDTs; and create new ladder logic with AOI modules. In addition, some Balluff IO-Link devices may require additional logic to configure the hardware for application-specific features. This configuration process is described in section 3.2 below.
3.1. configuration
Configuration of Balluff BNI EIP-502-105-Z015 module and associated AOI
Follow the User Guide for the IO-Link Master AOI, which can be found at www.Balluff.com. This step of configuring the IO-Link Master must be completed before any of the following steps, including hardware configuration of an IO-Link device, can be initiated.
3.2. Hardware
Hardware configuration of the Balluff IO-Link device.
Some devices include application-specific features that must be configured using explicit messages. If this hardware configuration is required based on the requirements of both the device and the application, please refer to the reference Balluff Tech Note.
3.3. Import
Import Balluff IO-Link Device AOI
- Right-click on the Add-On Instructions element of the Controller Organizer to view a menu that includes “Import Add-On Instruction…” as shown below:
- Locate your folder containing the downloaded Balluff AOI modules, highlight .L5X file and click Import…
- If the operation is successful, all UDTs associated with the AOI module will be imported into the project along with the AOI. This can be verified by checking the User-Defined element under Data Types in the Controller Organizer.
3.4. logic
Create logic using RSLogix5000
- Once an AOI has been imported, it can be used in the same manner as other ladder instructions. A new Element Group tab will be displayed in RSLogix5000’s Language Element toolbar. This is shown here with the hover window information displayed:
The AOI module can now be added to a rung of ladder: - All parameters must be defined with tags of valid data type as defined by the AOI module. The user should create each Tag Name relevant to the user’s project.
- There are only two tags that must be created; first the AOI Control Tag is the first tag location on the AOI. To guarantee that the new tag uses the correct data type, simply right-click on the”?” and choose New Tag…, then create a tag name.
- Second the IO-Link Device Data Tag, this the last tag location on the AOI. This tag contains the defined IO-Link Devices Process Data. This is the tag that will contain the data specific to the device for use in the logic of the project. For more information on what data is included in this tag, please refer to Section 4 which describes each UDT.
- Finally, drag the corresponding IO-Link Port Tag from the IO-Link Master AOI to the IO_Link_Port_Data tag location; this is the middle tag location. Also see; IO-Link Master AOI User Guide.
- There are only two tags that must be created; first the AOI Control Tag is the first tag location on the AOI. To guarantee that the new tag uses the correct data type, simply right-click on the”?” and choose New Tag…, then create a tag name.
4. User-defined Data Type (UDT)
The User-Defined Data Type for the Add-On Instruction defines the interface for the AOI and the user’s project. The highest level UDT is usually comprised of two sub-UDT components: Input (I) and Output (O). However, Input-only devices will not typically include an Output UDT. One additional UDT is defined, IO_Link_Port_Data, for integrating data through configured IO-Link ports.
The highest level UDT consists of the two sub-UDT.
4.1. Input UDT
The Input UDT consists of all inputs associated with the Balluff IO-Link Device. Each Balluff IO-Link Device Input UDT will contain the Input Data for that unique device. The definition of most input elements can be found in the corresponding IO-Link Devices User Manual, which can be located at the Balluff website (www.balluff.com) or by contacting Balluff Technical Support(http://www.balluff.com/go/contact). The IO-Link Diagnostic elements are not included in the device manuals, but are included in this section.
Note: There are IO-Link Diagnostic elements that are common to all Input UDTs, they are defines as follows:
- Device_OK:
Diagnostic bit; when high (1), represents that the corresponding IO-Link Port on the EtherNet/IP Master Module (BNI004A) is set-up as IO-Link, there is an IOLink device connected to the port, and that the connected device matches the correct Vendor and Device ID Number associated with the IO-Link Device AOI. - Mismatch_Fault:
Diagnostic bit; when high (1), ), represents that the corresponding IOLink Port on the EtherNet/IP Master Module (BNI004A) is set-up as IO-Link, there is an IO-Link device connected to the port, but that the connected device does not matches the correct Vendor and Device ID Number associated with the IO-Link Device AOI. - Comm_Fault:
Diagnostic bit; when high (1), represents that the corresponding IO-Link Port on the EtherNet/IP Master Module (BNI004A) is set-up as IO-Link, but there is not an IO-Link device connected to the port. This fault is usually associated with a short or opens on the cable between the IO-Link port and the IO-Link Device. - Validation_Error:
when high (1), represents a validation error associated with an incorrect Vendor or Device ID number. Consult the IO-Link Master AOI User Guide for more information - Event_Error_Code and Additional_Code; when a fault occurs, these elements will contain the error code and additional data that defines the fault. The definition of each error code and additional code can be found in the corresponding devices User Manual, which can be located at the Balluff website (www.balluff.com) or by contacting Balluff Technical Support (http://www.balluff.com/go/contact).
4.2. Output UDT
The Output UDT consists of all outputs associated with the Balluff IO-Link Device. Each Balluff IO-Link Device Output UDT will contain the Output Data for that unique device, unless it is an Input-only device. The definition of each element can be found in the corresponding devices User Manual, which can be located at the Balluff website (www.balluff.com) or by contacting Balluff Technical Support (http://www.balluff.com/go/contact).
4.3. IO-Link port data
The IO_Link_Port_Data UDT consists of the 48 input bytes (SINTs) and 48 output bytes (SINTs) that the IO-Link master allocates to each port. Under normal operating conditions, the user will not be aware of any data being passed through this UDT. The AOI automates the parsing of the data for each port and allows the user to access the data directly without mapping each of the four port’s data into the master’s single data buffer. This UDT is used for both the IO-Link master AOI as well as each IO-Link slave AOI. The master and slave must share the same tag name for the corresponding port. Refer to page 7 (3.4.3.3) for a visual representation.
- Inputs – this 48-byte SINT array contains all raw input data values being passed from the IO-Link slave device input array to the master device input array.
- Outputs – this 48-byte SINT array contains all raw output data values being passed from the IO-Link slave device output array to the master device output array.
5. Software validation
If the preceding instructions (4.0 Instructions) have been successfully completed, the software module will be integrated into the RSLogix5000 project and it will be ready to use. The user will be able to verify proper operation of the AOI by monitoring the transition of a controller-scoped tag and its corresponding real world device. This section describes a sampling technique that will verify the proper operation of one input bit.
5.1. example
This example describes how to validate the transition of a controller-scoped input tag.
This example uses the Device_OK bit although any input bit will suffice. The key point of this example is to ensure that the AOI bit corresponding to the selected input bit follows it. After physically connecting the IO-Link device to the master on a port that is configured for IO-Link Mode (Port LED is solid green), the Device_OK bit should transition to ON or “high” as shown here:
Note that when the IO-Link cable connecting the device to the IO-Link master is disconnected, this Device_OK bit should transition to OFF or “low”.
While the IO-Link device is properly connected to the IO-Link master, this bit (IO_Link_Device_Data_Tag.I.Device_OK) should be ON or “high”. If this is not the case, please refer to Section 6.0 Troubleshooting.
6. Troubleshooting
- If the user does not obtain the correct data in the defined user tags, please ensure that the following match those described in this User Guide:
- Hardware System layout – system must consist of the following:
- Rockwell Automation Logix processor
- Rockwell Logix EtherNet/IP network bridge
- ODVA-compliant EtherNet/IP physical media
- Software configurations – RSLogix5000 version 18.01 or higher must be used with this Add-On Instruction
- Revision levels
- Hardware System layout – system must consist of the following:
- Verify the correct LED states; on the IO-Link Port of the EtherNet/IP Master Module (BNI004A), the LED should be solid GREEN, while the IO-Link LED on the IO-Link device should flash.
- If the IO-Link Port of the EtherNet/IP Master Module (BNI004A) has a flashing GREEN LED, then the IO-Link device is not connected properly. Please ensure that the cable is not broken and both ends are connected securely.
- If the IO-Link Port of the EtherNet/IP Master Module (BNI004A) is OFF, then the Port is not configured for IO-Link mode. Please refer to the BNI004A AOI User Guide for guidance on configuring this port for IO-Link mode.
- If the system still does not respond properly, please contact the Balluff Technical Support Group at
http://www.balluff.com/go/contact
7. Definitions
The following terms are used in this guide with these definitions:
7.1. Controller Organizer
Controller Organizer – the area of RSLogix5000 where all project components can be accessed. If this toolbar is not visible, it can be opened by pressing Alt+0.
7.2. AOI - Add On Instruction
AOI – Add On Instruction – reusable software module created with RSLogix5000. Balluff’s AOI modules are composed of UDTs and associated logic to implement control algorithms. This module is hardware-specific. All AOI modules contained in a project will be located in the Controller Organizer as shown below:
7.3. Controller Scoped Tag
Controller scoped tag – a tag of any valid data type that is available to all programs within a project and must be used uniformly throughout the entire project.
7.4. AOI Parameter
AOI Parameter – a tag of any valid data type that is created during the definition of the AOI module and is isolated to that AOI. Its scope is limited to the each discrete use of AOI function.
7.5. UDT - User Defined Data Type
UDT – User Defined Data Type – reusable software module created with RSLogix5000. Balluff’s UDTs define the input and output tag names to be used when implementing our AOI modules. A UDT can be composed of any combination of standard Data Types defined by RSLogix5000 or other UDTs. All UDTs contained in a project will be located in the Controller Organizer as shown below:
7.6. I/O Configuration Tree
I/O Configuration Tree – the area of RSLogix5000 where all physical, or “real world”, Inputs and Outputs associated with the controller are defined. One example of an I/O Configuration Tree is shown below:
7.7. EDS - Electronic Data Sheet
EDS – Electronic Data Sheet – software configuration file that defines how a hardware product will communicate with the network master using EtherNet/IP. The format and content of an EDS is defined by ODVA, the controlling organization for EtherNet/IP specifications.
8. Related Documents
The following Balluff documents support the release of this User Guide and its related software module. Each of these documents can be obtained at the website www.balluff.com or by contacting Balluff Technical Support at http://www.balluff.com/go/contact
- IO-Link Master AOI User Guide
- Balluff device-specific hardware User Guides
- Using Explicit Messages to Configure IO-Link Devices Tech Note