Edge Connector

Learn how to create, deploy and use edge connectors.

The edge connector can be used to integrate data, be it pre-existing or real-time, from private networks by placing regular connectors close to the respective data source or data sink. When deployed, it establishes a connection with an app to provide data to or receive data from the app.

Edge connectors are shared across workspaces. All apps in one workspace can use them after deployment.

System requirements

The edge connector can be run on the following systems:

64-bit hardware with
- MacOS
- Windows
- Linux
  - There is a separate Alpine version
ARM64 on Industrial PC

Creation

Click on the cloud symbol with an arrow pointing down within the functions panel
Select the connectors you would like to include. A single edge connector can be used to integrate multiple interfaces and protocols.
Select the target OS the edge connector shall be deployed on.
Optionally, define a prefix for the edge connector. Use a prefix if you want to use a specific edge connector on more than one computer.
Click submit.
Wait for the edge connector to be created. Its download starts automatically. Depending on your target OS, it has a different file format.

Using a prefix

Using a prefix allows you to create just one edge connector and deploy it on several computers. This is extremely useful if you want to control an entire fleet of similar endpoints (e.g. machines).

If you built your edge connector without specifying a prefix, the corresponding executable will have a built-in unique ID. This has two effects:

You can only run one instance of this specific edge connector at a time (otherwise the IDs collide).
You can move the edge connector across computers or within file systems. It will always be recognized as the same one.

If you built your edge connector with specifying a prefix, the corresponding executable will generate an ID at startup time. This has the following effects:

You can deploy the very same edge connector at multiple locations and run them simultaneously.
Each edge connector establishes an individual connection and appears as an own entity in the App Builder.
An edge connector is only recognized as the exact same one after a restart, as long as it is stored in the same directory (by reading a hidden .hw-agent-id file in this directory).

Don't move an edge connector with prefix after the initial activation.

Deployment and activation

The edge connector must now be deployed and activated within the network you want to integrate data from.

Save the edge connector on a device. For example, this can be on an industrial PC in the OT network, a machine controller or a regular laptop. It is crucial though that this device has access to the interface to be integrated, like an OPC UA server in case of OPC UA integration.
Depending on the target OS, simply double-click the file or open a terminal and run the file. On Linux and MacOS it might be necessary to make the file executable.
The edge connector and its functionality should automatically appear in the functions panel.
Expand it and drag any functions you want to use onto the board.

The edge connector establishes a connection to your Heisenware account via MQTTS. It is therefore necessary that port 8883, reserved for MQTTS, is NOT blocked.

If the edge connector does not appear in the function panel after you have started it, please speak to an IT administrator responsible for the network to have the port unblocked. Then try again.

Available connectors

As mentioned above, the edge connector is a means of transport for moving connectors into the network of the data source or data sink. If a connector is missing, it can be added to the functionality of the edge connector on request.

Available edge connector functionality includes:

OS connector: It can be used to display statistics about a server that needs to be monitored. For available functions, see the operating system connector article.
InfluxDB connector: Establishes a connection to an Influx database. For available functions, see the InfluxDB connector article.
SQL database connector: Establishes a connection to a SQL database. For available functions, see the PostgresSQL connector article.
HTTP connector: Establishes a connection to an HTTP server in a private network. For available functions, see the HTTP/REST connector article.
File connector: The file connector is used to read and write files in the network the edge connector is running on. For available functions, see the Files data connector article.
Siemens S7 connector: Establishes a connection with a Siemens PLC inside a closed network. For available functions, see the Siemens S7 protocol connector article.
OPC UA Client: Establishes a connection with an OPC UA Server inside a closed network. For available functions, see the OPC UA protocol connector article.
MQTT Client: Establishes a connection with a MQTT Broker inside a closed network. For available functions, see the MQTT protocol connector article.
Serial port connector: Establishes a connection with a serial port (RS-232/485). For available functions, see the RS-232/485 connector article.
Busylight connector: Allows to control kuando Busylight devices from the cloud.

Last updated 4 months ago

Creation

Click on the cloud symbol with an arrow pointing down within the functions panel

Select the connectors you would like to include. A single edge connector can be used to integrate multiple interfaces and protocols.

Select the target OS the edge connector shall be deployed on.

Optionally, define a prefix for the edge connector. Use a prefix if you want to use a specific edge connector on more than one computer.

Click submit.

Wait for the edge connector to be created. Its download starts automatically. Depending on your target OS, it has a different file format.

Using a prefix

Using a prefix allows you to create just one edge connector and deploy it on several computers. This is extremely useful if you want to control an entire fleet of similar endpoints (e.g. machines).

If you built your edge connector without specifying a prefix, the corresponding executable will have a built-in unique ID. This has two effects:

You can only run one instance of this specific edge connector at a time (otherwise the IDs collide).

You can move the edge connector across computers or within file systems. It will always be recognized as the same one.

If you built your edge connector with specifying a prefix, the corresponding executable will generate an ID at startup time. This has the following effects:

You can deploy the very same edge connector at multiple locations and run them simultaneously.

Each edge connector establishes an individual connection and appears as an own entity in the App Builder.

An edge connector is only recognized as the exact same one after a restart, as long as it is stored in the same directory (by reading a hidden .hw-agent-id file in this directory).

Don't move an edge connector with prefix after the initial activation.

Deployment and activation

The edge connector must now be deployed and activated within the network you want to integrate data from.

Save the edge connector on a device. For example, this can be on an industrial PC in the OT network, a machine controller or a regular laptop. It is crucial though that this device has access to the interface to be integrated, like an OPC UA server in case of OPC UA integration.

Depending on the target OS, simply double-click the file or open a terminal and run the file. On Linux and MacOS it might be necessary to make the file executable.

The edge connector and its functionality should automatically appear in the functions panel.

Expand it and drag any functions you want to use onto the board.

The edge connector establishes a connection to your Heisenware account via MQTTS. It is therefore necessary that port 8883, reserved for MQTTS, is NOT blocked.

If the edge connector does not appear in the function panel after you have started it, please speak to an IT administrator responsible for the network to have the port unblocked. Then try again.

Available connectors

Available edge connector functionality includes:

OS connector: It can be used to display statistics about a server that needs to be monitored. For available functions, see the operating system connector article.

InfluxDB connector: Establishes a connection to an Influx database. For available functions, see the InfluxDB connector article.

SQL database connector: Establishes a connection to a SQL database. For available functions, see the PostgresSQL connector article.

HTTP connector: Establishes a connection to an HTTP server in a private network. For available functions, see the HTTP/REST connector article.

File connector: The file connector is used to read and write files in the network the edge connector is running on. For available functions, see the Files data connector article.

Siemens S7 connector: Establishes a connection with a Siemens PLC inside a closed network. For available functions, see the Siemens S7 protocol connector article.

OPC UA Client: Establishes a connection with an OPC UA Server inside a closed network. For available functions, see the OPC UA protocol connector article.

MQTT Client: Establishes a connection with a MQTT Broker inside a closed network. For available functions, see the MQTT protocol connector article.

Serial port connector: Establishes a connection with a serial port (RS-232/485). For available functions, see the RS-232/485 connector article.

Busylight connector: Allows to control kuando Busylight devices from the cloud.