Skip to content

Commit e2c3f8b

Browse files
edge-docs-upd-4.0-p1 (#1981)
* in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * in progress * upgrade-to-4.0 * Updated Edge CE and Edge PE configuration from latest yml file * upgrade-to-4.0 --------- Co-authored-by: Volodymyr Babak <[email protected]>
1 parent f1b3db6 commit e2c3f8b

File tree

463 files changed

+1822
-1658
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

463 files changed

+1822
-1658
lines changed

_includes/docs/edge/faq.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@
2121
{% endif %}
2222

2323
### Does ThingsBoard Edge support clustering?
24-
<p>No, <b>ThingsBoard Edge</b> does not support clustering at the moment. But cluster support will be added in the following releases.</p>
24+
25+
The **earlier versions** of **ThingsBoard Edge** do not support clustering. It is designed to operate, process and analyze data locally before synchronizing with the central **ThingsBoard Server**.
26+
27+
Starting **with release 4.0**, Edge supports clustering. Multiple **Edge nodes** can be clustered to provide high availability. If one node fails, the others can seamlessly continue to handle workloads.
2528

2629
### Do I need an internet connection to use the ThingsBoard Edge?
2730
<p>No, you can run it completely offline if you need to. The only connection required is to the <b>ThingsBoard Server</b> via <a href="https://grpc.io/" target="_blank">gRPC</a>.</p>
@@ -93,7 +96,7 @@ If this is required, you'll need to provision multiple <b>ThingsBoard Edge</b> i
9396
### How many devices can ThingsBoard Edge support?
9497
{% if docsPrefix == 'pe/edge/' %}
9598
<p>The number of connected devices depends on your <a href="https://thingsboard.io/pricing/?section=thingsboard-edge" target="_blank">subscription plan</a>.</p>
96-
<p>Some plans offer 'Unlimited Devices and Assets', thus there are no soft limits on creating devices and assets on the edge side.</p>
99+
<p>Some plans offer 'Unlimited Devices and Assets, thus there are no soft limits on creating devices and assets on the edge side.</p>
97100
{% else %}
98101
<p><b>ThingsBoard Edge</b> doesn’t impose a fixed limit on the number of devices you can connect.</p>
99102
<p>In practice, the number of devices you can support depends largely on your hardware resources, system configuration, and the specific use case.
@@ -172,12 +175,12 @@ Some useful references include <a href="https://github.com/mqtt/mqtt.github.io/w
172175
<p>This means that Edge support is not bundled with the license. For now, we provide basic support to customers with more than 25 Edge licenses of any type.</p>
173176

174177
### Refund and Delivery Policy
175-
<p>Refund Policy</p>
178+
<p><b>Refund Policy</b></p>
176179
<p>The License fee is non-refundable, regardless of any circumstances.
177180
Customers may manage their subscription plans: update or cancel them. Once the subscription is deleted before expiration, Stripe will keep the balance.
178181
After a certain time period (about an hour) positive Amount due with the remain credits will appear in Billing section of License portal.
179182
This sum is deducted from Total fee whenever particular customer purchase a new plan or a perpetual license.</p>
180-
<p>Delivery Policy</p>
183+
<p><b>Delivery Policy</b></p>
181184
<p>The software is available for download and installation from our website.
182185
See <a href="/docs/user-guide/install/pe/edge/installation-options/" target="_blank">Installation Guides</a>for more details.
183186
In order to activate the software you will need to obtain the license key.

_includes/docs/edge/user-guide/alarms.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,10 @@
33

44
## Overview
55

6-
The **ThingsBoard Alarm** is an essential feature for monitoring and responding to entities events and conditions. For a comprehensive understanding of the **ThingsBoard Alarm** feature, please refer to the [Working with Alarms](/docs/{{cloudDocsPrefix}}user-guide/alarms/) documentation.
6+
The **ThingsBoard Alarm** is an essential feature for monitoring and responding to entity events and conditions.
7+
For a comprehensive understanding of the **ThingsBoard Alarm** feature, please refer to the [Working with Alarms](/docs/{{cloudDocsPrefix}}user-guide/alarms/){: target="_blank"} documentation.
78

8-
Although the **Alarm** feature for the **Edge** is designed in a similar manner to that of the **Cloud**, it includes several notable additions:
9+
Although the **Alarm** feature for the **Edge** is designed similarly to that of the **Cloud**, it includes several notable additions:
910
* Alarms are processed locally on the **Edge** and focused on the immediate conditions for alarm triggering without relying on connectivity.
1011
* The Alarm data can be pushed from the **Edge** to the **Cloud** and can also be sent back from the **Cloud** to the **Edge**. This setup enables real-time monitoring and management of alarms across different locations.
1112
* Edge Alarms can be integrated with other local systems or software solutions for further processing, notifications, or actions.
@@ -16,17 +17,18 @@ In essence, the **ThingsBoard Edge Alarms** provide real-time, localized alarm m
1617

1718
The **Edge Alarms** are created and configured in the same way as the **Cloud Alarms**. Therefore, it is necessary to define the **parameters and the rules** according to which the alarm is to be triggered.
1819

19-
The easiest way to create an Alarm is to use the [Alarm Rules within the Device profile](/docs/{{cloudDocsPrefix}}user-guide/device-profiles/#alarm-rules). The majority of tasks can be configured with **Alarm Rules** with minimal effort.
20+
The easiest way to create an Alarm is to use the [Alarm Rules within the Device profile](/docs/{{cloudDocsPrefix}}user-guide/device-profiles/#alarm-rules){: target="_blank"}. The majority of tasks can be configured with **Alarm Rules** with minimal effort.
2021

21-
If more complex logic is required, we suggest utilising the alternative option, namely the **["Create Alarm"](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/action-nodes/#create-alarm-node)** and **["Clear Alarm"](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/action-nodes/#clear-alarm-node)** rule nodes in the **[Rule Engine](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/re-getting-started/)**. This is a more advanced option that requires a certain level of programming expertise. Please refer to the [corresponding example](/docs/user-guide/rule-engine-2-0/tutorials/create-clear-alarms/).
22+
If more complex logic is required, we suggest using the alternative option, namely the ["Create Alarm"](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/action-nodes/#create-alarm-node){: target="_blank"} and ["Clear Alarm"](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/action-nodes/#clear-alarm-node){: target="_blank"} rule nodes in the [Rule Engine](/docs/{{cloudDocsPrefix}}user-guide/rule-engine-2-0/re-getting-started/){: target="_blank"}. This is a more advanced option that requires a certain level of programming expertise. Please refer to the [corresponding example](/docs/user-guide/rule-engine-2-0/tutorials/create-clear-alarms/){: target="_blank"}.
2223

2324
## Alarms Pushing from the Cloud to the Edge
2425

25-
The **ThingsBoard system** allows for pushing **Alarms** from the **Cloud** to the **Edge** in order to enhance operational efficiency and reduce reliance on **Cloud** resources.
26+
The **ThingsBoard system** allows for pushing **Alarms** from the **Cloud** to the **Edge** to enhance operational efficiency and reduce reliance on **Cloud** resources.
2627

27-
### Prerequisite
28-
29-
It is essential to determine which **Rule chain** you intend to use, as this will have a significant impact on the configuration process.
28+
{% capture prerequisite %}
29+
Determine the **Rule Chain** you intend to use in advance, as this will have a significant impact on the configuration process.
30+
{% endcapture %}
31+
{% include templates/info-banner.md content=prerequisite %}
3032

3133
### Guidelines
3234

@@ -36,17 +38,15 @@ To push Alarms from the **Cloud** to the **Edge**, follow these steps:
3638

3739
## Alarms Pushing from the Edge to the Cloud
3840

39-
The ThingsBoard system also allows for pushing Alarms from the **Edge** to the **Cloud**.
41+
**ThingsBoard** also allows for pushing alarms from the **Edge** to the **Cloud**.
4042
{% capture local-deployment %}
4143
**Please note!** <br>
42-
You **cannot** create or edit the **Rule Chain** on the **Edge** itself. It must be configured as a template on the **Cloud (Server)**, and then assigned to the **Edge** instance. Only then will the actual **Rule Chain**, derived from that template, begin to function and process data from devices (entities) according to its configuration.
44+
If you use **earlier versions** of Edge, you **cannot** create or edit a **Rule Chain** on the **Edge** itself. It must be configured as a template in the **Cloud (Server)**, and then assigned to the **Edge** instance.
45+
46+
Starting with **Edge version 4.0**, you can create and edit a **Rule Chain** on the **Edge**.
4347
{% endcapture %}
4448
{% include templates/info-banner.md content=local-deployment %}
4549

46-
### Prerequisite
47-
48-
It is essential to determine which **Rule chain** you intend to use, as this will have a significant impact on the configuration process.
49-
5050
### Guidelines
5151

5252
To push Alarms from the **Edge** to the **Cloud**, follow these steps:

_includes/docs/edge/user-guide/db-overview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55

66
The **Edge Dashboards** are robust and effective tools for local monitoring and management of IoT data. They can function and display data in real time, even when there is no connection to the Cloud. The data can be synchronized with the server when the connection is restored.
77

8-
The **Edge Dashboards** are designed in the same way as the [Platform (Cloud) Dashboards](/docs/{{cloudDocsPrefix}}user-guide/dashboards/). Please read the Platform Dashboard documentation for a general understanding of its functionality.
8+
The **Edge Dashboards** are designed in the same way as the [Platform (Cloud) Dashboards](/docs/{{cloudDocsPrefix}}user-guide/dashboards/){: target="_blank"}. Please read the Platform Dashboard documentation for a general understanding of its functionality.
99

1010
## Dashboard Provision to ThingsBoard Edge
1111

12-
The dashboards can be created and managed on the **ThingsBoard server**, and then [provisioned](/docs/{{docsPrefix}}getting-started/#step-5-provision-dashboard-to-thingsboard-edge) to the **Edge instance**. This approach enables the simultaneous deployment of changes to all Edge instances.
12+
The dashboards can be created and managed on the **ThingsBoard server**, and then [provisioned](/docs/{{docsPrefix}}getting-started/#step-5-provision-dashboard-to-thingsboard-edge){: target="_blank"} to the **Edge instance**. This approach enables the simultaneous deployment of changes to all Edge instances.
1313

1414
You can verify that the Dashboard is provisioned:
1515

@@ -22,9 +22,9 @@ You can also create and manage **Dashboards** right from the **Edge** itself. Al
2222
To **create** the Edge Dashboard on your **ThingsBoard Edge** instance, do the following:
2323

2424
{% include images-gallery.html imageCollection="create-dashboard" showListImageTitles="true" %}
25-
You can learn about **Widgets** [here](/docs/{{cloudDocsPrefix}}user-guide/widgets/)
25+
You can learn about **Widgets** [here](/docs/{{cloudDocsPrefix}}user-guide/widgets/){: target="_blank"}.
2626

27-
Read more about the **Dashboard toolbar** [here](/docs/{{cloudDocsPrefix}}user-guide/dashboards/#dashboard-toolbar).
27+
Read more about the **Dashboard toolbar** [here](/docs/{{cloudDocsPrefix}}user-guide/dashboards/#dashboard-toolbar){: target="_blank"}.
2828

2929
To verify that the changes are successfully propagated:
3030

@@ -34,7 +34,7 @@ If you have multiple instances of **ThingsBoard Edge**, you can delete the Dashb
3434

3535
### Assign/Remove Customers
3636

37-
Before you assign customers to the Dashboard, make sure that you have assigned them to the **ThingsBoard Edge** instance first. You can read more about Customers [here](/docs/{{cloudDocsPrefix}}user-guide/ui/customers/).
37+
Before you assign customers to the Dashboard, make sure that you have assigned them to the **ThingsBoard Edge** instance first. You can read more about Customers [here](/docs/{{cloudDocsPrefix}}user-guide/ui/customers/){: target="_blank"}.
3838

3939
To **assign/unassign** customers to the **Edge Dashboard**, do the following:
4040

_includes/docs/edge/user-guide/edge-attributes.md

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,11 @@ To keep the **ThingsBoard Server** up to date with any attribute changes that ha
4949

5050
{% include images-gallery.html imageCollection="pushToCloud" %}
5151

52+
{% capture edge-rule-chain %}
53+
Starting with **Edge 4.0**, you can create and edit a **Rule Chain** on the **Edge**.
54+
{% endcapture %}
55+
{% include templates/info-banner.md content=edge-rule-chain %}
56+
5257
Read about how to **subscribe to device attributes change** [here](/docs/{{docsPrefix}}config/subscribe-to-attribute/#step-3-subscribe-to-device-attributes-change-and-publish-device-attributes-message){: target="_blank"}.
5358

5459
## Custom Attributes for Edge Instance
@@ -58,7 +63,7 @@ The retrieved **Edge attributes** can be used for metadata enrichment, authentic
5863

5964
To assign a custom attribute to the **Edge** instance, follow these steps:
6065

61-
* Log in to the **ThingsBoard Server**, go to the **Edge management > Instances** section and click on the **Edge** instance. On the **"Edge details"** page, select the **"Attributes"** tab.
66+
* Log in to the **ThingsBoard Server**, go to the **Edge management > Instances** section and click on the **Edge** instance. On the **"Edge details"** page, select the **"Attributes"** tab.
6267
* Click the **“Add”** button and add a new custom attribute (_e.g. edgeAccessToken_).
6368
* Confirm the assigned attribute.
6469
* Select the **"Relations"** tab and click the **“Add”** button to add a new relation (_e.g. the relation between the Edge and the Device(s)_). Click the **“Add”** button.
@@ -67,7 +72,8 @@ To assign a custom attribute to the **Edge** instance, follow these steps:
6772
{% include images-gallery.html imageCollection="addEdgeAttributes" %}
6873

6974
To use **Edge** attributes as placeholders in the **Rule Chain template**:
70-
* Go to the **ThingsBoard Server**, the **Edge management > Rule chains templates** section and click on the **Rule Chain** in question.
75+
* Go to the **ThingsBoard Server**, the **Edge management > Rule chains templates** section and click the appropriate **Rule Chain**.
76+
* If you're using **Edge 4.0** or later, stay in your **Edge** instance and go to the **Rule chains** section. To edit a rule chain, click the appropriate **Rule Chain**.
7177
* On the **Rule Chain** edit page, find the **"related entity data"** node using the **Node search** bar. Drag and drop the node onto the **Rule Chain sheet**. Fill in the following fields in the pop-up window:
7278
* **Name:** Enter the node name.
7379
* **Direction:** Select the relation direction (_From originator/To originator_).
@@ -97,7 +103,8 @@ Before configuring the alarm notifications, have these steps completed:
97103
* [Set a relation](/docs/{{docsPrefix}}config/provision-asset/#creating-relations){: target="_blank"} between the **Asset** and **Device**.
98104

99105
Follow these steps to configure the alarm notifications:
100-
* Log in to the **ThingsBoard Server**, go to the **Edge management > Rule chains templates** section and click on the **Rule Chain** in question.
106+
* Log in to the **ThingsBoard Server**, go to the **Edge management > Rule chains templates** section and click the appropriate **Rule Chain**.
107+
* If you're using **Edge 4.0** or later, stay in your **Edge** instance and go to the **Rule chains** section. To edit a rule chain, click the appropriate **Rule Chain**.
101108
* On the **Rule Chain** edit page, find the **"related entity data"** node using the **Node search** bar. Drag and drop the node onto the **Rule Chain sheet**. Fill in the following fields in the pop-up window:
102109
* **Name:** Enter the node name.
103110
* **Direction:** Select the relation direction (_From originator/To originator_).

_includes/docs/edge/user-guide/edge-management.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@
55

66
**ThingsBoard** offers two distinct deployment options: **ThingsBoard Edge** and **ThingsBoard Cloud**.
77

8-
**ThingsBoard Edge** is designed specifically for local, distributed data processing, enabling data analysis and management directly at the source of data generation. This approach allows for local processing, storage, and immediate response to critical situations, even without a continuous connection to the central server. For more information, see the [What is ThingsBoard Edge](/docs/{{docsPrefics}}getting-started-guides/what-is-edge/){: target="_blank"} article.
8+
**ThingsBoard Edge** is designed specifically for local, distributed data processing, enabling data analysis and management directly at the source of data generation. This approach allows for local processing, storage, and immediate response to critical situations, even without a continuous connection to the central server. For more information, see the [What is ThingsBoard Edge](/docs/{{docsPrefix}}getting-started-guides/what-is-edge/){: target="_blank"} article.
99

10-
In contrast, **ThingsBoard Cloud**, is a fully managed, scalable, and fault-tolerant platform hosted in the cloud. The devices connected to the Cloud transfer data over the internet. It is perfect for centralized data collection, processing, and management. For more information, see the [What is ThingsBoard](/docs/{{peDocsPrefics}}getting-started-guides/what-is-thingsboard/){: target="_blank"} article.
10+
In contrast, **ThingsBoard Cloud** is a fully managed, scalable, and fault-tolerant platform hosted in the cloud. The devices connected to the cloud transfer data over the internet. It is perfect for centralized data collection, processing, and management. For more information, see the [What is ThingsBoard](/docs/{{docsPrefix}}getting-started-guides/what-is-edge/){: target="_blank"} article.
1111

1212
### The Key Differences Between Edge and Cloud
1313

@@ -20,7 +20,8 @@ Although **Edge is designed similarly to Cloud**, the main difference lies **in
2020
* Devices connected to the **Cloud** are **require internet connectivity** to communicate with the platform.
2121

2222
**Cluster deployment** refers to the deployment in a distributed architecture, where multiple nodes (instances) work together to ensure scalability, fault tolerance, and high availability.
23-
* **Edge does not support cluster deployment**. It is designed to operate, process and analyze data locally before synchronizing with the central ThingsBoard server.
23+
* The older versions of **Edge do not support cluster deployment**. It is designed to operate, process and analyze data locally before synchronizing with the central ThingsBoard server.
24+
* Starting with release 4.0 **Edge supports clustering**. Multiple Edge nodes can be clustered to provide high availability. If one node fails, the others can seamlessly continue to handle workloads.
2425
* **Cloud supports cluster deployment** and is crucial for handling large-scale IoT applications with numerous devices and high data throughput.
2526

2627
## Synchronization Architecture
@@ -47,7 +48,7 @@ To force synchronization procedure, go to the **Edge management > Instances** se
4748

4849
## Entities Management
4950

50-
Most entities can be created on the **Edge** instance, except for **Customers**, **Users**, and **Rule Chains** entities. To enable the use of these entities on the **Edge**, these entities must be **assigned** to the **Edge** prior to use.
51+
Most entities can be created on the **Edge** instance, except for **Customers**, and **Users**, entities. To enable the use of these entities on the **Edge**, these entities must be **assigned** to the **Edge** prior to use.
5152

5253
To **assign** specific entities to the **Edge**, log in to your **Cloud** and navigate to the **Edge management > Instances** section:
5354

@@ -83,7 +84,7 @@ Basic information about the Edge configuration is provided on the Edge instance
8384
The **Cloud Events** page shows events that ThingsBoard Edge pushes to the Cloud. To view this information, log in to your **Edge instance** and go to the **Edge > Cloud events** section. The following information is displayed:
8485

8586
* **Created time:** The date and time the event is created and pushed to the Cloud. Displayed in a format YYYY-MM-DD H:Min:Sec.
86-
* **Action:** The action pushed to the Cloud. Possible actions: Added, Deleted, Updated, Attributes Updated, Attributes Deleted, Timeseries Deleted, Timeseries Updated, RPC Call, Credentials Updated, Relation Add or Update, Relation Deleted, Relations Deleted, Alarm Ack, Alarm Clear, Attributes Request, Rule Chain Metadata Request, Relation Request, Credentials Request.
87+
* **Action:** The action pushed to the Cloud. Possible actions: Added, Deleted, Updated, Attributes Updated, Attributes Deleted, Timeseries Deleted, Timeseries Updated, RPC Call, Credentials Updated, Relation Add or Update, Relation Deleted, Relations Deleted, Alarm Ack, Alarm Clear, Attributes Request, Rule Chain Metadata Request, Relation Request, Credential Request.
8788
* **Entity type:** The entity that created the event.
8889
* **Entity ID:** The identification code of the entity.
8990
* **Status:** Defines if the event has been pushed to the Cloud.

0 commit comments

Comments
 (0)