Banner Engineering Banner IOL Parameter Data Function Block Instructions

Banner-logo

Banner Engineering Banner IOL Parameter Data Function

Banner-Engineering-Banner-IOL-Parameter-Data-Function-product

This document covers the installation and use of a function block for Siemen’s TIA Portal software package. This function block handles acyclic IO-Link commands to and from a Banner IO-Link Device and allows the user to easily change the IO-Link Device Parameter Data. Each Banner IO-Link Device Parameter Data function block is meant to be used alongside an IO-Link Master Control function block. This paper describes how to set up both blocks.

Components

Banner IOL Parameter.zal16
There are two methods for parameter data. The first is used when creating a connection to Banner’s IO-Link masters. The second set of instructions are for systems using other manufacturers’ IO-Link masters. When using another manufacturer’s IO-Link Master download the Siemens LIOLink Library (from the Siemens website). Use version v7.2 for TIA Portal v16 or v17, and v7.3 for v18+.

 Open Global Library Instructions

  1. Open a project.
  2. Go to the Open Global Library option in the Libraries tab in TIA Portal v16 or greater. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (2)
  3. Switch the “Files of type” to Compressed libraries. Go to the location of the compressed library.
  4. Press the Open button and the library will be uncompressed and opened.
  5. The library is now accessible in the Libraries tab in v16 or greater.

Setup of IO-Link Device with a Banner DXMR Device 

  1. Go to Device and Networks to configure the DXMR. Add the DXM it has yet to be added to the system.
  2. Add Banner IO-Link Master Info to Slot 1. This sets the DXMR for IO-Link mode.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (4)
  3. Open the IO-Link ISDU folder. Select the IO-Link ISDU 190/190 Byte option. Make note of the I address for Slot 10. The inputs data starts at I185 while the outputs data starts at Q185 for this example.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (4)
  4. Switch to the Libraries Tab. The Banner IOL Parameter Library should already be opened (See previous section if it is not).
  5.  Expand the “Master copies” folder.
  6. Expand the “IOL Control” folder.
  7. Drag the Banner _IOLM and Banner_ IOLM _EL to the PLC Data Types area under your PLC.
  8. Open the Banner folder and drag the Banner _ISDU_ Control to the “Program blocks” area
    Banner-Engineering-Banner-IOL-Parameter-Data-Function- (5)
  9. Also move the Banner_ ISDU _In and Banner_ ISDU_ Out to the “PLC Data Types” area.
  10. Now expand the “IOL Parameter” folder.
  11.  Move the “Banner IOL Parameter” to the Program blocks area.
  12.  Expand the “Data Types” folder.
  13.  Move all the data types to the “PLC Data Types” area.
  14. Finally open the “Devices DB”.
  15. Look for the Banner IO-Link Device that a parameter data connection will be created too. Move that database to the “Program blocks” area. This example will use “Banner Q5X2K” (found in Sensors).
  16.  The database will have two items in it. The “Q5X2K Rules” tells the Function Block how the data is organized. The “Q5X2K IOLM1 01” is the location the data is saved into by the Function Block. This tag can/should be renamed by the user. If multiple Q5X2K units are in the system this tag should have copies made of it. One for each Q5X2K in the system.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (6)
  17. Go to PLC Tags. Create two tags. The first tag “IOLM1 ISDU In” and the second tag is “IOLM1 ISDU Out”. Use the %I and %Q values from step 3.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (7)
  18.  Go to Program blocks. Add a new Data block if necessary (can use the device db that was imported). In this example the new data block is named “db”.
  19. Create a tag with the type of “Banner _IOLM”. This example uses IOLM1. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (8)
  20.  Next add the “Banner_ ISDU_ Control” function block to a ladder rung. You will be prompted to make a new data block. Accept this. You now must define the input variables for this function block: ISDU _In, ISDU _Out, and IOLM. Also set which ports the Function Block will interact with by changing the Port # to True. In this example only Port 1 will be used so that is the only one set to True. Only set a Port to True is the sensor/device is present and the parameter data Function block is configured for this device.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (9)
  21.  Link the IOLM variable to the database IOLM tag created in step 19. While ISDU_ In and ISDU_ Out are linked to variables created in step 17.
  22. Now add the “Banner IOL Parameter” function block to a ladder rung. You will be prompted to make a new data block. Accept this. Type in the port number for the device, then link the “IOLM” variable to the IO-Link master variable created in step 19.
    The Rules and Device need to be linked to the tags from the “Banner Q5X2K” database pulled in during step 15 and 16.
    As a last step, the Port Activate (which is part of the IOLM tag from step 19) bit is added on the same rung as the “Banner IOL Parameter” function block to ensure orderly behavior. The IO-Link Master function block will cycle through all ports, giving each connected device function block a time to operate.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (10)
  23. Setup of Parameter Data for a Banner DXMR is complete.
  24. Go to Page 11 for information on how to use the Function Block.

Setup of Banner IOL Parameter with other IO-Link Masters

Additional Component Needed
Siemens LIOLink V7.2 Library for TIA Portal V16 or V17 (downloadable on Siemens website) Siemens LIOLink V7.3 Library for TIA Portal V18+ (downloadable on Siemens website)

Installation Instructions

  1.  The Banner IOL Parameter Library will now be in the Global Library List. Expand the “Master copies” folder.
  2.  Expand the “IOL Control” folder.
  3. Drag the Banner_IOLM and Banner_IOLM_EL to the “PLC Data types” folder.
  4.  Expand the “Other Mfgs” folder.
  5. Move the Banner_IOLM_LIOLink to the area under “Program Blocks”.
  6. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (11)Now expand the “IOL Parameter” folder.
  7. Move the “Banner IOL Parameter” to the Program blocks area.
  8. Expand the “Data Types” folder.
  9. Move all the data types to the “PLC Data Types” area.
  10. Finally open the “Devices DB”.
  11. Look for the Banner IO-Link Device that a parameter data connection will be created to. Move the database to the “Program blocks” area. This example will use “Banner Q5X2K”.
  12. The database will have two items in it. The “Q5X2K Rules” tells the Function Block how the data is organized. The “Q5X2K IOLM1 01” is the location the data is saved into by the Function Block. This tag can/should be renamed by the user. If multiple Q5X2K units are in the system this tag should have copies made of it. One for each Q5X2K in the system.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (12)
  13. Now we must bring the Siemens-made IO_LINK_DEVICE function block or LIOLink function block specific to your PLC into our project. This example will use IO_LINK_DEVICE. This can be found in a Siemens IO-Link Library. See their website for more details. Once that library is retrieved and opened, drag IO_LINK_DEVICE to the Program Blocks area under your PLC.
  14.  Go to “Devices and networks” to configure the system, as necessary. Below is an example of what a configuration might look like. This example shows 5 different IO-Link Masters connected to the same PLC.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (13)
  15. Go to Program blocks. Add a new Data block if necessary. In this example the new data block is named “Banner IO-Link Data”.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (14)
  16.  In the new data block, create a new tag to represent the IO-Link Master, using the data type “Banner_IOLM”. This example uses the tag name “IOLM1”. A different IO-Link Master might be called IOLM2 or IOLM3, for instance.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (15)
  17.  Next add the “Banner_IOLM_Control” function block to an OB ladder. You will be prompted to make a new data block. You now must define the input variables for this function block. Defining an input variable for the last input, Communications Error, is optional.
    The Client Access Point (CAP) varies, depending on the specific IO-Link Master used.
    The ID Control state variable should be “true” if using an IO-Link Master from ifm; otherwise, it should be set to “false”.
    All Ports that will be accessed by the Function Block set them to “true”. In this example only Port 1 will be set to “true”. Only set to “true” if sensor/device is present and the parameter data function black it configured for this device.
    Link the “IOLM” input variable to the tag created in step 16. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (16)
  18. The ID Control true/false state is linked to an array called “ID_Array”, found in “Banner_IOLM_Control_DB”. This array contains the Hardware ID property of the PROFINET configuration.
    See Appendix A for more information on how to find the correct value for your specific IO-Link Master.
    In the case of an IO-Link Master from ifm, each port has a different Hardware ID and each number must be entered into the correct place. The example shown in Figure 3 is of an IO-Link device connected to port 6 of an ifm IO-Link Master. The ifm IO-Link Master’s port 6 Hardware ID is entered into the “ID_Array[6]” slot. This full array of different Hardware IDs, based on port used, is used when the “ID Control” variable is set to true (i.e. only when the IO-Link Master is from ifm).
    IO-Link Masters from other vendors use a single Hardware ID value for all ports. In this case, the Hardware ID is entered into the “ID_Array[1]” slot of the array, regardless of the port to which the device is connected. This array is ignored (but the [1] slot is still important) when the “ID Control” variable is set to false. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (17) Banner-Engineering-Banner-IOL-Parameter-Data-Function- (18)
  19. Now add the “Banner IOL Parameter” function block to an OB ladder. You will be prompted to make a new data block. Type in the port number for the device, then link the “IOLM” variable to the IO-Link master variable created in step 15.
    The Rules and Device need to be linked to the tags from the “Banner Q5X2K” database pulled in during steps 11 and 12.
    As a final step, the Port Activate bit is added on the same rung as the Banner IOL Parameter function block to ensure orderly behavior. The IO-Link Master function block will cycle through all ports, giving each connected device function block a time to operate.Banner-Engineering-Banner-IOL-Parameter-Data-Function- (19)
  20. Setup of Parameter Data for IO-Link Master is complete.
  21.  Go to next page for information on how to use the Function Block.

Using the Banner IOL Parameter Function Block
The Banner IOL Parameter function block will automatically gather data for all IO-Link devices in the system when first powered on. Parameter data is an acyclic process and can take some time to complete. The initial read is complete when the “Initial Global Read” tag is set to “true”. This flag can be set to false to request another full global read of all parameter data for an IO-Link device. The flag is found in the tag that is part of the pulled in database from the library. This example uses the Q5X2K database. The tag is in the “Data type” “Banner IOL Device”. There should be one tag of “Banner IOL Device” for each device in the system. If you have 3 Q5X2K sensors then copy the “Q5X2K IOLM1 01” until you have three copies of it. One for each device. Rename them as needed for the system. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (20)

  • The Data section in “Banner IOL Device” should be expanded. Now the Index should also be expanded. Now the Index array is fully visible. Start at index[2] each line is labeled. These labels represent the IO-Link Indices in the device. Read only indices will have a “ro” in the comment. Write only has a “wo”. Everything with neither a “ro” or a “wo” is Read Write capable. See the image below for an example of this. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (21)
  • A Global Read can be started by either entering a 1 into the Command or setting the “Initial Global Read” to false. A singular Index read is started by entering the index number into Command. As an example, if “BDC1 Setpoints” should be updated then entering an eight into the Command does the Read operation for that Index. The Data in the index is now updated. Expand the index to see the data.
  • The Write operation requires a few steps to complete. Start by expanding the Index that will be updated. For this example, “BDC1 Setpoints” will be used. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (22)
  • Change all the “Sub Index” values that need to be updated. This example changes SP1 from 472 to 480. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (23)
  • The Command needs to be set for the Write command to be updated. Take the index number and add 40 to it. This is the value that needs to be entered into the Command value. Here the value 48 (40 + 8) is entered and the device is updated. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (24)
  • The Command value will be set back to 0 after the operation is completed. When the Command is set back to 0 look at the “Communications Error” tag from the “Banner_IOLM_Control” or
    “Banner_ISDU_Control” database. This tells the user if the write operation was successful or not. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (25)
  • The previous section went through the steps of how to manually read and write the data. This section will show an example of how the update could happen when programmed. The user will need to come up with some logic that determines when the update should occur. This logic should not be able to be continuously activated.
    *NOTE: Parameter Data is meant to be updated infrequently. The data is stored in EEPROM that has a limited number of writings available. Exceeding this limit can cause the IO-Link device to error out. Each Index data element has a separate counter for this. If the application requires very quick Index writes, contact Banner Engineering to discuss. Never need to worry about Reads, however.

Example Logic for IO-Link Parameter Data Update Banner-Engineering-Banner-IOL-Parameter-Data-Function- (26)

In this example the “db.Update IOL” represents the logic that triggers the parameter data update. Here it is just a simple Boolean value; however, it will likely be more complex in the actual system. Next is a normally open contact that is checking that the “Initial Global Read” has been set to true. This ensures that the system has read all the parameter data correctly. If the parameter data has yet to be read then the data cannot be update yet. Next is an Equal comparison check. This looks at the Command variable for the function block. If Command is already processing a command/operation wait until that is completed before trying to do another command/operation. Finally, all the data for one Parameter Data Index can be adjusted as needed. In this example the Sub-Index[1] (Response Speed) and Sub-Index[2] (Gain) are updated to the necessary values for the system. Command has a 52 sent to it which represent Index 12 (remember writes are activated by adding 40 to the Index number). The Boolean used to activate the routine it turned off. It may be necessary to handle this in another way depending on the logic used to activate this process. The Banner IOL Parameter Function Block will update the IO-Link device to the new parameters.

Appendix A

IO-Link Master Hardware ID Numbers

The Hardware ID number used in “ID_Array” in the “Banner_IOLM_Control_DB” function block is not trivial to find. Each manufacturer uses the Hardware Identifier of a slightly different subcomponent as the value required for our purposes. Furthermore, the particular Hardware Identifier numbers will change based on the number of devices in your configuration. These pictures show which subcomponent’s Hardware ID is relevant to the function block. In each case, click on the hardware device from the “Devices & Networks” view. Click on “Properties”, then click on “System Constants” to see the screen shots below.

Balluff
Use the Hardware Identifier from the “BNI_PNT-508-105-Z015_1” Hw_SubModule. Type this number into the [1] slot of the ID_Array found in the “Banner_IOLM_Control_DB” data block. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (27)

Comtrol
Use the Hardware Identifier from the “Head” Hw_SubModule. Type this number into the [1] slot of the ID_Array found in the “Banner_IOLM_Control_DB” data block. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (28)

Turck
Use the Hardware Identifier from the “Basic_1” Hw_SubModule. Type this number into the [1] slot of the ID_Array found in the “Banner_IOLM_Control_DB” data block. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (29)

Siemens
Use the Hardware Identifier from the “CM_4xIO-Link_1” Hw_SubModule. Type this number into the [1] slot of the ID_Array ID_Array found in the “Banner_IOLM_Control_DB” data block. Banner-Engineering-Banner-IOL-Parameter-Data-Function- (30)

ifm
Use the Hardware Identifier from the port to which the IO-Link Device you wish to control is connected Hw_SubModule. Each port is a different Hardware identifier. You will need to populate the ID_Array, found in the “Banner_IOLM_Control_DB” data block, with the correct values. In the example below, port 6 on the master has a Hardware ID of “279”. Thus, the [6] entry in the ID_Array variable should be set to “279”.

Banner-Engineering-Banner-IOL-Parameter-Data-Function- (1)

Documents / Resources

PDF thumbnailBanner IOL Parameter Data Function Block
Instructions · Banner Engineering, function block, IO-Link

References

Ask a Question

Use this section to ask about setup, compatibility, troubleshooting, or anything missing from this manual.

Ask a Question

Ask about setup, compatibility, troubleshooting, or anything missing from this manual. Name and email are optional.