Stop the war

Stand with Ukraine flag

Support Ukraine
Try it now Pricing
PE Edge
Community Edition Professional Edition Cloud Edge PE Edge IoT Gateway License Server Trendz Analytics Mobile Application PE Mobile Application MQTT Broker
Documentation > Integrations > Overview
Getting Started
Installation Architecture API FAQ
On this page

Edge Integrations

Available since TB Version 3.4
Doc info icon

Edge Integration is implemented in a similar way, as ** Integration**. The only difference is in the way, how integration is created and provisioned. Please make sure that you have knowledge of ** Integration** before proceed.

Overview

Edge Integrations feature was designed in a similar way as Platform Integrations. The only major difference is in the way how integrations and converters are configured.

To reuse same Integration between multiple Edges, Integration templates and Converter templates approach was introduced.

Integration templates are created on the Cloud, but these templates are not regular Platform Integrations and not started on the cloud. They are assigned to the Edge and started once they are provisioned to the Edge.

At the moment Integrations and Converters can not be modified on the Edge - they are modified on the Cloud and all the modifications automatically propagated to the Edge from the Cloud.

Integration configurations fields (URIs, passwords, etc.) could be replaced by Edge attribute value with a help of placeholders. In this way, single Integration template could be used by multiple Edges, and any specific configuration field of the Integration could be replaced by Edge attribute value.

Deployment options

ThingsBoard Integration has two deployment options: embedded and remote. See details and architecture diagrams below.

Embedded integrations

Embedded integration is running in the main ThingsBoard Edge process.

Pros:

  • simplifies deployment of new integration (just few clicks on ThingsBoard UI);
  • minimize latency for message delivery;

Cons:

  • consume resources allocated to main ThingsBoard Edge process: network connections, OS threads and CPU cycles;
  • low level of isolation;

Remote integrations

One can install remote integration in the local network and stream data to the edge over network.

Let’s assume you have local MQTT broker or OPC-UA server deployed on-premises. Those brokers and/or servers don’t have dedicated external IP address, so ThingsBoard Edge can’t connect to them directly. However, you can install remote integration close to this edge, in the same local network. This integration will connect to the broker/edge, pull the data and store it in the local file system. Remote integration will stream the data to the ThingsBoard Edge deployed in the network once the network connection is available.

Pros:

  • enables integration with servers deployed in the local network;
  • isolates the integration process from main ThingsBoard Edgeprocess;

Cons:

  • requires installation of a separate package;

Learn how to configure integration to run remotely using this guide.

Converter templates

Converter templates could be created only by Tenant administrator. Go to Cloud and navigate to Edge management -> Converter templates page. This page allows you to create Converter template. These Converter templates are going to be used later in Integration templates configuration.

Create Converter template
Create Converter template
Converter template configuration
Converter template configuration

You do not need to assign Converter templates to the Edge - once Integration template is assigned to specific Edge, related Uplink/Downlink Converters are provisioned to the Edge automatically.

Integration templates

Once Converter template was created you can navigate to Edge management -> Integration templates page to create Integration. This page allows you to create Integration template. These Integration templates are going to be assigned to the Edge.

Create Integration template
Create Integration template
Integration template configuration
Integration template configuration

Integration configuration placeholders

In most of the cases, Integration have common configuration part for most of the Edges, except some specific field(s). To be able to use the same Integration template for multiple Edges, with some unique values between Edges, placeholders feature could be used. You are able to add specific attributes to the Edge, and then use name of this attribute in the Integration template. This placeholder is going to be replaced by attribute value during the assignment to the Edge.

Let’s see on example how HTTP Integration could be configured with unique IP Address value per Edge as ‘Base URL’.

  • Add ipAddress attribute to Edge
  • Add placeholder ${{ipAddress}} to Integration configuration
  • Click Manage Integrations button of Edge entity
  • Assign Integration to the Edge
  • Login to your ThingsBoard Edge instance and open Integrations page - placeholder is going to be replaced by attribute value
Add <b>ipAddress</b> attribute to Edge
Add ipAddress attribute to Edge
Add placeholder <b>${{ipAddress}}</b> to Integration configuration
Add placeholder ${{ipAddress}} to Integration configuration
Click <b>Manage Integrations</b> button of Edge entity
Click Manage Integrations button of Edge entity
Assign Integration to the Edge
Assign Integration to the Edge
Login to your <b>ThingsBoard Edge</b> instance and open Integrations page - placeholder is going to be replaced by attribute value
Login to your ThingsBoard Edge instance and open Integrations page - placeholder is going to be replaced by attribute value

You can assign this Integration template to other Edge entities, and every Integration on the Edge is going to have it’s unique ‘Base URL’ value, that is replaced by attribute value.

If specific Edge is missing placeholder attribute key, Platform will notify regarding it during the assignment to Edge or Integration configuration update:

Add ipAddress attribute to Edge
Add ipAddress attribute to Edge

Edge limitations

In the current version, Edge is not able to create customers, device profiles and entity groups. These limitations affect Uplink Data converter functionality:

  • If non-existent device type used in the Converter, ‘default’ device type will be used.
  • Same applies to the customer - if customer is not available on the Edge, device will be assigned to Tenant.
  • If entity group non-exists on the edge - ‘All’ group is going to be used.

See Also

Explore guides and video tutorials related to specific integrations:

Next steps