Skip to content

User Guide#

System Requirements#

Supported Platforms#

ADP Edge is deployed as docker containers and can be run on the following platforms or platforms that can emulate the following environments in docker:

  • linux-x64
  • linux-arm64

Network Requirements#

ADP Edge is engineered to run independently from an active internet connection but requires it for an initial setup or for updating flows and system updates. The following requirements need to be met during this period:

  • Outgoing connection on Port 443/https (tcp)
  • Outgoing/Incoming connections on Port 8888/http (tcp)
  • Outgoing/Incoming connection on port 9999/https (tcp)
  • Outgoing/Incoming connection PNT/EIP on Ports 2222/udp und 44818/tcp
  • Outgoing connection on Port 123/ntp (tcp/udp)
  • Outgoing/Incoming connections on port range 1999-2001/udp

Note

Ensure, that the ephemeral UDP ports (1024 to 65535) are opened up on your system.

Hardware Requirements#

Minimal hardware requirements:

  • Dual core processor 1 GHZ, for example, ARM Cortex-A53
  • 4 GB RAM
  • 8 GB free disk space

Recommended hardware requirements:

  • Quad core processor 1 GHZ, for example, ARM Cortex-A53
  • 4 GB RAM
  • 16 GB free disk space

Browser#

The following Browser are supported:

  • Chrome Version 99 or higher
  • Firefox Version 91 or higher
  • Edge Version 99 or higher
  • Opera Version 85 or higher
  • Safari Version 14.1 or higher
  • iOS Safari 12.2 or higher
  • Android Browser Version 101 or higher

All IO-Link devices whose IODDs can be found in the IODDfinder are supported.

The following IO-Link Network Modules are supplied:

Hardware Revision 8#

  • BNI EIP-508-105-Z015, FW 4.7.3, 4.5.0 & 3.3.2
  • BNI PNT-508-055-P067, FW 3.5.0 & 3.5.1
  • BNI PNT-508-105-Z077, FW 3.5.0 & 3.5.1
  • BNI EIP-508-105-Z067 (BNI00H7), FW 4.8.0

Disclaimer: Although hardware revision 8 can be used, it has limited support due to the instability of its underlying communication protocol in certain situations.

Hardware Revision 9#

  • BNI EIP-508-005-Z015-013 (BNI00HM), FW 4.9.1
  • BNI EIP-508-105-Z015 (BNI006A), FW 4.9.1
  • BNI EIP-508-005-R015-013 (BNI00HW), FW 4.9.1
  • BNI EIP-508-105-R015 (BNI008M ), FW 4.9.1
  • BNI EIP-501-005-Z015-013 (BNI00J6), FW 4.9.1
  • BNI PG3-508-0C5-Z015 (BNI00HL), FW 1.3.0
  • BNI PG3-508-0C5-R015 (BNI00K4), FW 1.3.0

A maximum of 10 masters can be supported by ADP per instance!

The IO-Link process data is made available to the BNI module with a cycle time of 300ms.

Note

To use a BNI in ADP Edge, the IP-address of the BNI must be in the address range of the ADP Edge network.

Understanding The ADP Edge User Interface#

ADP Edge Overview
No. Description
Opens a menu for the following basic operations:
- Opening the Online Help
- Opening application-related information
- Opening the Master Setup Assistant
- Performing a software update
- Managing profiles
- Adjusting settings
- Changing the display mode
- Signing out
Opens the Flow Studio to create and manage flows.
Selects the host in the flow.
Searches for devices.
Displays the flow items.
Displays information about the selected item of the flow.

First Sign In to ADP Edge#

  1. If you open the ADP Edge the first time, sign in with the standard credentials:

    Sign in dialog
    Sign in dialog

  2. Under Username enter admin and under Password enter Balluff#1.
    ⇒ You are asked to change the password.

  3. Change the password.
    ⇒ You can now sign in to the ADP Edge with the new credentials.

Basic Operation#

You can display application-related information:

  • Information about the Balluff Asset Data Provider app.
  • Information about open source licenses.
  • The Terms & Conditions.
  1. In the ADP Edge main window, click .
  2. Click About this app. ⇒ On the right-hand-site of the main window, the About this app pane opens:

Activate Network Interfaces for Discovery#

The ADP Edge can search different network interfaces for supported devices.

When you open ADP Edge for the first time, you will see a dialog listing all available network interfaces. Toggle the switch to enable or disable the selected network interface.

Note

This dialog is shown if there is no selected Network Interface yet.

Press the Save button to save your changes. ADP Edge will then start searching for supported devices on the selected network interfaces. See the next chapter for further information.

Note

The discovery process for supported devices may take some time to complete.

You can adjust the network interfaces by opening the user menu and selecting Settings.

You can select the IO-Link Network Modules for installation to the ADP topology using the Master Setup Assistant.

Note

Whenever one or more new IO-Link Network Modules are detected, a dialog opens where you can either directly open the Master Setup Assistant or choose not to.

  1. In the ADP Edge main window, click .

  2. Click Master Setup Assistant.
    ⇒ The Master Setup Assistant opens:

  3. Select the IO-Link Network Module(s) for installation and click Next. Depending of the hardware version of the selected IO-Link Network Modules, you may need to authenticate. Enter the credentials for all required IO-Link Network Modules. Press the Login button to login. Repeat this step for all necessary IO-Link Network Modules. Finally, click Next.

  4. On the selected IO-Link Network Modules all ports will be set the IO-Link mode. Once finished, the dialog appears as follows:

  5. Click Finish Assistant to close the dialog.
    ⇒ The selected IO-Link Network Modules are now available in the ADP topology.

The ADP supports connecting to network modules that are linked to a PLC controller. Modules detected as connected to a PLC are marked with the status "PLC lock active" in the Master Setup assistant, as shown below.

PLC Lock

These systems will be used in read-only mode in the ADP. No changes to the configuration are made during the onboarding process, and the ADP also prohibits writing process data or parameter data to devices attached to a locked module.

As shown below writeable IO-Link parameters cannot be changed and sent to the devices when they are attached to a PLC locked network module in order to prevent interfering with the PLC.

  1. In the ADP Edge main window, click Overview, and click the network-module you want to remove.
    ⇒ The network-module information overview table is displayed in the lower part of the main window.

  2. Click the Module row to expand it, and click DELETE.

    ⇒ The IO-Link Network Modules is deleted from the ADP topology.

Managing Profiles#

You can manage the user profiles.

Note

You need an account to login to Keyclock Account Management.

  1. In the ADP Edge main window, click .
  2. Click Manage profile.
    ⇒ The Keycloak Account Management site opens, where you can manage the user profiles.

Changing The Display Mode#

You can choose between a dark mode and a light mode.

  1. In the ADP Edge main window, click .
  2. Select either Dark mode or Light mode.
    ⇒ The setting is applied immediately to the main window.

Signing Out#

  1. In the ADP Edge main window, click .
  2. Click Sign out.
    ⇒ You have signed out of the ADP Edge.

Searching For Devices#

You can search for devices connected to the host.

  1. In the ADP Edge main window, enter a search string in the search field.
    ⇒ Devices that matches with the entered search string are automatically and dynamically suggested:

    Example: Search string = "Sm"
    Example: Search string = "Sm"

  2. Select the desired device.
    ⇒ The device is opened in the flow:

    Example: Search result = "SmartLight (BNI0082)"
    Example: Search result = "SmartLight (BNI0082)"

Host Overview#

The Host Overview section displays information about the edge node at the bottom. It also shows flows and their status, if any are deployed on the edge node.

Host overview
Host overview

Edge Node Information#

The following details are displayed for each edge node:

  • Edge Node ID: The unique identifier of the edge node.
  • Edge Node Name: The name assigned to the edge node.

Flow Information#

If there are any flows deployed on the edge node, their status will be shown under the Flows section.

Connection Issues#

If there are problems with the connection to the edge node, a warning icon will be displayed. Hovering over this icon will show the following message:

"No connection to the edge node could be established. Please check the Internet connection and restart ADP if necessary."

Edge Node Information Warning
Edge Node Information Warning

Troubleshooting Tips#

  1. No Internet Connection

    • Ensure that the device running ADP has an active Internet connection.

  2. Unable to Establish API Connection to Edge Node

    • Verify that the edge node is properly configured and reachable via the network.

  3. Starting ADP Without Internet

    • ADP requires an Internet connection on the first startup to synchronize with the ADP Cloud.

Note

Initial Setup Requirement#

When starting the ADP Edge for the first time, an Internet connection must be available to allow synchronization with the ADP Cloud.

Designing New Flows#

Flows are created and managed in the Flow Studio.

Note

You need an account to login to Flow Studio.

► In the ADP Edge main window, click Flow Studio:

⇒ The ADP Cloud site opens. After the login, you can design the flows for the ADP Edge nodes. For more information about ADP Cloud, see ADP-Cloud User-Guide.

Displaying Hardware Information#

You can display information about the host and its connected network-modules and the devices connected to each of the network modules.

Overview
Overview

By default, the main window displays the host and the connected network modules.

To display host information:

  1. In the ADP Edge main window, click Overview:
    ⇒ The host information overview table is displayed in the lower part of the main window.

    Host information
    Host information

  2. To view the details of a category, click on the corresponding row.
    ⇒ The row expands and provides the category information.

You can display the following categories of information for the network-modules: - Module

To display network-module information:

  1. In the ADP Edge main window, click Overview, and click on the network-module whose information you want to display.
    ⇒ The network-module information overview table is displayed in the lower part of the main window. Network-module information
  2. To view the details of a category, click on the corresponding row.
    ⇒ The row expands and provides the category information.

You can display the following categories of information for the devices:

  • Process Data
  • Device variant (only available for Balluff devices that support more than one variant)
  • IODD

To display device information:

  1. In the ADP Edge main window, click Overview, and click the network-module to which the device is connected.
    ⇒ A tree with all connected devices is displayed.

  2. Click on the device whose information you want to display.
    ⇒ The device information overview table is displayed in the lower part of the main window.

    Device information
    Device information

  3. To view the details of a category, click on the corresponding row.
    ⇒ The row expands and provides the category information.

Reading Device Parameters#

On initial configuration of the masters, the ADP Edge starts to read device parameters for all connected devices initially.

Note

After the first read, device parameters (which are not included to the identification data) are no longer read automatically.

Initial device parameters
Initial device parameters

Display The Device Parameters#

  1. In the ADP Edge main window, click Overview, and click the network-module to which the device is connected.
    ⇒ The device information overview table is displayed in the lower part of the main window.

  2. Click the IODD row to expand it, and select the PARAMETER tab:
    ⇒ The device parameters according to the IODD file are displayed:

    Device parameters (Example for retro-reflective sensor)
    Device parameters (Example for retro-reflective sensor)

Last read field#

Each parameter is also described by a field Last Read which displays the time, when a field was updated in an human readable manner.

Read device parameter manually#

  1. Display the device parameters.
  2. Click Read at the end of the row
    ⇒ The parameter should display the newly read value and the Last Read value should change to 0 seconds ago.
Read device parameters
Read device parameters

Setting Device Parameters#

By setting device parameters, the devices can be configured on demand.

Changing The Device Parameters#

You can change device parameters that are writeable to the device.

Changing Device Parameters#

  1. Display the device parameters.
  2. Change the desired parameter.
  3. Click Write.
    ⇒ The changed parameter is written to the device.

Changing The Device Variant#

For Balluff devices, you can change the device variant.

Note

Only available, if the Balluff device supports device variants.

  1. Display the device parameters.

  2. Click the DEVICE VARIANT row to expand it.
    ⇒ The row expands and provides the device variants:

    Device variants
    Device variants

  3. Select the device variant.
    ⇒ The device variant is changed.

Changing The Process Data Profile#

Note

Only available, if the device supports this parameters.

  1. Display the device parameters.

  2. Click the PROCESS DATA PROFILE row to expand it.
    ⇒ The row expands and provides the device variants:

    Process Data Profile
    Process Data Profile

  3. From the Process Data Profile drop-down list, select the desired profile.

  4. Click WRITE.
    ⇒ The process data profile is applied.

Consuming process data via MQTT#

The ADP Edge does publish process data from all enabled IO-Link devices onto the integrated MQTT broker which can then be accessed via plain MQTT or encrypted via MQTT over TLS.

MQTT#

Port: 1833
Username: mqtt
Password: !cQ6NzzuHWboGkMy!2KJTEjfDVJkgAe@ZuT8

MQTT over TLS#

Port: 8883
Username: mqtt
Password: !cQ6NzzuHWboGkMy!2KJTEjfDVJkgAe@ZuT8