Skip to content

Commit

Permalink
Read me edit (#126)
Browse files Browse the repository at this point in the history
* Add files via upload

* Update README.md

Description improvements

-links
-updated the wording of some sentences

* Update README.md

Added TB Edge badge with link to TeamCity Edge server

* Add files via upload

* Add files via upload

* Delete img/dashboards.png

* Delete img/batch-update.svg

* Add files via upload

* Delete img/dashboards-scada.png

* Add files via upload

* Delete img/dashboards-scada.png

* Add files via upload

* Delete img/batch-update.png

* Add files via upload

* Update README.md

* Update README.md

* Update README.md

* Update README.md
  • Loading branch information
yevheniia-mala authored Oct 25, 2024
1 parent 490d737 commit eb39004
Show file tree
Hide file tree
Showing 7 changed files with 819 additions and 35 deletions.
83 changes: 48 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,72 +1,85 @@
# ThingsBoard
# ThingsBoard Edge
[![TB Edge Builds Server Status](https://img.shields.io/teamcity/build/e/Edge_Build?server=https%3A%2F%2Fbuilds.thingsboard.io&style=flat&logo=data%3Aimage%2Fpng%3Bbase64%2CiVBORw0KGgoAAAANSUhEUgAAACYAAAAmCAYAAACoPemuAAABbmlDQ1BpY2MAACiRdZG9S8NQFMVPW6VaKx10KOKQoYpDC0VBHLUOXYqUWsGqS%2FKatEKShpcUKa6Ci0PBQXTxa%2FA%2F0FVwVRAERRBxdPZrkRLvawot0r5wc3%2Bc987l5QTwZ3Rm2H1JwDAdnkunpNXCmhR8RwhRDIqSmW0tZLMZ9Fw%2Fj%2FCJ%2FpAQs3qf67qGiqrNAN8A8SyzuEM8T5zZcizBe8SjrCwXiU%2BI45wuSHwrdMXjN8Elj78E83xuEfCLmVKpg5UOZmVuEE8Rxwy9ylr3EV8SVs2VZepjVOOwkUMaKUhQUMUmdDhIUDcps%2B6%2BZNO3hAp5GL0t1MDJUUKZvHFSqzRVpa6RrtKjoyZy%2F5%2Bnrc1Me9PDKaD%2F1XU%2FJ4DgPtCou%2B7vqes2zoDAC3Bttv0Vymnum%2FR6W4sdA5Ed4PKmrSkHwNUuEH22ZC43pQCVX9OAjwtguACM3AOhdS%2Br1j7On4D8Nv2iO%2BDwCJik85GNP7aVZ%2BhXE%2FB8AAAACXBIWXMAAA9hAAAPYQGoP6dpAAAEUElEQVRYR8WYW4hOURTHZ9zvdyW5paHIRLmXGkSjlOTBg9L3ICNSxAMexgtvFOVBKUQeCHlxS4wHyaVQ3jTkfhnTuOR%2B%2Ffz%2Bp3U%2B%2B9uzP3O%2B48iu%2F%2Byz19l7rf9Ze%2B%2B11jcVFSlbPp8fCo6DV%2BAu2ADap1SXzTIIdAf3wDuwF5wHaluysZBSCwRyRmSOVPBcCY6A96BdSrVFy9IqGWZarqmvrKzM010H3UH%2FLIil0oFXas1jJ%2BQhMBDcBvdTKQws6pBS0URbt5C%2BCfSU48CilPr%2Bfhle2WTe0o3UWdsHtoHqv9eeUgPGDxipo%2FRpvZ3S%2Bh%2BWQeYr%2BPxfvRPiB6HxoMkw1p%2BDfBDo4coZzwIds3eTpxEjY0PkkNVYHLtDP9ji2w7b%2BnmZEkPpfvADzPC8UETOIWU88iK32wZ76HVjs2ko22iKP9C%2FBpNKkHtpnopJuf3BmBR9Z7CkrG1lsnJfDtQDBc%2BYlG7fKPCwBLnlHpu3jE85smhbjdQZk49L5Domq0pQQvbbMQRRSKAf6ZNjXAOUG9221uYvQNhiL0TurD2vTkTKlChQqkqYA3qCw6Yk522dS251gNRHZH3iNTxv9khvTkzKiKme2usoVO5rBvsC4UDkngS8K9FjMAJ0AwoRvjcLtzUJQVUXr8BwFMU3R9WBcl9LQMFQZAWveO%2BHMFYSVynUCFRpuG00g4siHiKGXIXA70KTgSpPNdVT64GqhC%2BgKPcxrgl4IXbeNx4awBowyHbiWcCzb5AVlUWM54P7Nlde3hoR1B%2BwxTGqSfO98zWgBCmdqxzoa2S0jQvBoRKkpnh6q80JcsY6IOeobSjMM4IDS7hZMehGwNhTIzSddyfBp8AciRQHJwfO7Hbkyr2RXXpVwirTGwsVLFXoD9AcIob8C%2FK54Jb3XjGqCllvIC93Ca1H9hV8Drzrh%2BwdiM6zVcIPeeyfuLRmkS7JFX2YZ2A240vgW8DwG2RLTX6Bj%2FBrtsu8GwAUshSqdHEWg4YSH9hazKI4IaswvOls2WHbhqveNuqgR9tHr9z6Aih9ReTou4Jzga1XsNftb7sxcZopiBIy6OeQ003SWVFOdVudq5kXYxxyk4zUT%2Fo6oDSodJgDfpgpTZDJCrozRcq%2BVpdBaUaK%2FSZPKQir92%2BhyD0HCkdau6JttyScgTKROm1slOzdbRWZqaAKKBMUtjNWj2wC0E3cldBksmkoVJxSixIyvbZVoSQi5RCIybUqmZJZKnMWxrWtSi%2BFxrgT6OWrcjwncjPLNPVvp0NoHFDg%2Ff5vLZWhHTJxSNBB31nG0mynYly5T6FDsW4ZUJwSqZXZWipDG8ZVJSgM6MapnovbqjLUZD8VFg%2BAqgTVVbogcaVQm721hBqNjDy0zgkXyn1q9QnVFE1LnMTbUK4E%2FwEouMaVcBzTHqUhltkaCKnyVFM9pX9%2F6geO%2FjebPPdlxqY4yKoSVpneCPQDRz%2F%2FklUJAUK%2FANSuR8d2qw90AAAAAElFTkSuQmCC&label=TB%20Edge%20server&labelColor=009688)](https://builds.thingsboard.io/buildConfiguration/Edge_Build?mode=builds#all-projects)

The **ThingsBoard Edge** is an open-source ThingsBoard's software product for edge computing.
The **ThingsBoard Edge** is an open source software solution from ThingsBoard designed specifically for edge computing. It is free for both personal and commercial use, and you can deploy it anywhere.

It allows bringing data analysis and management to the edge, where the data created. At the same time ThingsBoard Edge seamlessly synchronizing with the ThingsBoard cloud ([ThingsBoard Demo](https://demo.thingsboard.io/) or [ThingsBoard CE](https://github.com/thingsboard/thingsboard)) according to your business needs.
<img src="./img/thingsboard-e-icon.png?raw=true" width="100" height="100">

The **ThingsBoard Edge** enables users to process and analyze data closer to the source, improving performance and reducing latency. At the same time **ThingsBoard Edge** seamlessly synchronizes with the ThingsBoard Cloud ([ThingsBoard Demo](https://demo.thingsboard.io/) or [ThingsBoard CE](https://github.com/thingsboard/thingsboard)), tailored to meet your specific business needs.

## Documentation

ThingsBoard Edge documentation is hosted on [thingsboard.io](https://thingsboard.io/docs/edge/).
The **ThingsBoard Edge** documentation is hosted on [thingsboard.io](https://thingsboard.io/docs/edge/).

## ThingsBoard Edge use-cases

- **Autonomous Vehicles**
Edge computing makes it possible to collect, process and react to road events with almost no latency. Modern autonomous vehicles produces tons of data - between 5 TB and 20 TB a day. 4G or 5G will not able to provide that network throughput, but with ThingsBoard Edge you are able to filter data. Most of this data should be processed locally, and only subset of this data will be pushed to the cloud.
<br>Edge computing makes it possible to collect, process and react to road events with almost no latency. Modern autonomous vehicles produces tons of data - between 5 TB and 20 TB a day. 4G or 5G will not able to provide that network throughput, but with ThingsBoard Edge you are able to filter data. Most of this data should be processed locally, and only subset of this data will be pushed to the cloud.

- **Smart Farming**
Quickly react to failures of silo aeration systems on a remote site even if connectivity to the cloud from on-field location is pure at the moment.
<br>Quickly react to failures of silo aeration systems on a remote site even if connectivity to the Cloud from on-field location is pure at the moment.

- **Smart Houses**
Bringing the processing and analyzing data closer to the smart house provides the possibility to secure sensitive user information at the edge. Additionally, it provides a good user experience because of the low latency of smart house solutions - user will get responses from end devices much faster, comparing to connecting edge devices to the cloud to make some decisions.
<br>Bringing the processing and analyzing data closer to the smart house provides the possibility to secure sensitive user information at the Edge. Additionally, it provides a good user experience because of the low latency of smart house solutions - user will get responses from end devices much faster, comparing to connecting Edge devices to the Cloud to make some decisions.

- **Security Solutions**
It's necessary to react to security violations and threats within seconds and edge provides this possibility. You don't need to care about quality of your connectivity to cloud - decision will be made by local edge engine on a remote site in real-time.
<br>It's necessary to react to security violations and threats within seconds and Edge provides this possibility. You don't need to care about quality of your connectivity to Cloud - decision will be made by local Edge engine on a remote site in real-time.

- **In-hospital Monitoring**
To secure data privacy in healthcare devices processing of this data must be done on the edge. Push to the cloud only required pieces of readings from medical devices, while storing all other sensitive data on the edge.
Additional benefit from edge processing in this use-case - react to critical medical cases as quickly as possible due to real time processing of data from edge medical devices.
<br>To secure data privacy in healthcare devices processing of this data must be done on the Edge. Push to the Cloud only required pieces of readings from medical devices, while storing all other sensitive data on the Edge.
Additional benefit from Edge processing in this use-case - react to critical medical cases as quickly as possible due to real time processing of data from Edge medical devices.

- **Predictive Maintenance**
Brings processing and storage of edge device readings closer to the equipment. Analyze tons of data locally and detect changes in the production lines before a failure occurs. Send to the cloud only average readings from productions lines according to your business needs.
<br>Brings processing and storage of Edge device readings closer to the equipment. Analyze tons of data locally and detect changes in the production lines before a failure occurs. Send to the Cloud only average readings from productions lines according to your business needs.

## ThingsBoard Edge features

With **ThingsBoard Edge** you get the following benefits:
Unlock the key benefits of **ThingsBoard Edge**:

- **Local deployment and storage** to process and store data from edge (local) devices without connection to the cloud. Push updates to the cloud once connection restored.
- **Local Deployment and Storage:** Store and process data from Edge devices locally when there is no active connection to the Cloud, and push updates to the Cloud once the connection is restored.

![image](https://thingsboard.io/images/edge/overview/offline_network_.svg)
<img src="/img/local-deployment.svg" alt="ALocal Deployment and Storage" width="400" height="300">

- **Traffic filtering** to filter data from edge (local) devices on the ThingsBoard Edge service and push to cloud only subset of the data for further processing or storage.

![image](https://thingsboard.io/images/edge/overview/data_filtering.svg)

- **Local alarms** to react instantly to critical situations on site without connectivity to cloud.

![image](https://thingsboard.io/images/edge/overview/alarm.svg)
- **Traffic filtering:** Filter data from Edge (local) devices on the **ThingsBoard Edge** service and push only a subset of the data to the Cloud for further processing or storage.

- Monitor local events and timeseries data with a **real-time dashboards**.
- **Batch Update** thousands of edge configurations in a single click.
<img src="/img/data-filtering.svg" alt="Traffic filtering">

![image](https://thingsboard.io/images/edge/overview/update_dashboard.svg)
- **Local alarms:** React instantly to critical situations on site without requiring connectivity to the Cloud.

- **Local storage** to store data from the edge devices on the edge if there is no active connection to cloud and push to the cloud updates once connection restored.
<img src="/img/local-alarms.svg" alt="Local alarms" width="400" height="300">

ThingsBoard Edge inherits features from ThingsBoard CE to provide you the same experience how to connect, manage and process data from your devices.
- **Real-Time and SCADA-like HMI Dashboards:** Monitor local events and time-series data. Remotely access critical mechanical components via Human-Machine Interfaces.

<img src="/img/dashboard.png" alt="Local alarms" width="600" height="300">

- **Batch Update:** Update thousands of Edge configurations in a single click.

<img src="/img/batch-update.png" alt="Batch Update" width="500" height="300">

**ThingsBoard Edge** inherits features from ThingsBoard Community Edition, delivering the same seamless experience for connecting, managing, and processing data from your devices, ensuring consistency and ease of use across your IoT applications.

It supports next **ThingsBoard Community Edition** features:
* [**Attributes**](https://thingsboard.io/docs/user-guide/attributes/) - assign and manage custom attributes to your entities.
* [**Telemetry**](https://thingsboard.io/docs/user-guide/telemetry/) - API for collection of time-series data of your devices.
* [**Entities and relations**](https://thingsboard.io/docs/user-guide/entities-and-relations/) - model physical world objects (e.g. devices and assets) and relations between them.
* [**Data visualization**](https://thingsboard.io/docs/guides#AnchorIDDataVisualization) - develop custom dashboards and widgets.
* [**Rule engine**](https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/) - manage data processing & actions on incoming telemetry and events.
* [**RPC**](https://thingsboard.io/docs/user-guide/rpc/) - send remote procedure calls (RPC) **both from edge and cloud sides** to devices and vice versa.
* [**Audit log**](https://thingsboard.io/docs/user-guide/audit-log/) - track user activity.
* [**API Limits**](https://thingsboard.io/docs/user-guide/api-limits/) - control and limit number of API requests from a single host.
* [**Attributes**](https://thingsboard.io/docs/user-guide/attributes/): Easily assign and manage custom attributes for your entities.
* [**Telemetry**](https://thingsboard.io/docs/user-guide/telemetry/): Access a powerful API for collecting time-series data from your devices.
* [**Entities and relations**](https://thingsboard.io/docs/user-guide/entities-and-relations/): Effortlessly model physical world objects—such as devices and assets—and the relationships between them.
* [**Data visualization**](https://thingsboard.io/docs/guides#AnchorIDDataVisualization): Create custom dashboards and widgets tailored to your specific needs.
* [**SCADA interactive capabilities**](https://thingsboard.io/docs/user-guide/scada/): Enhance your operational efficiency with the remote access to equipment through interacrive SCADA dashboards.
* [**Rule engine**](https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/): Effectively manage data processing and automate actions based on incoming telemetry and events.
* [**RPC**](https://thingsboard.io/docs/user-guide/rpc/): Seamlessly send remote procedure calls (RPC) **from both the Edge and Cloud** to devices and vice versa.
* [**Audit log**](https://thingsboard.io/docs/user-guide/audit-log/): Monitor user activity with precision.
* [**API Limits**](https://thingsboard.io/docs/user-guide/api-limits/): Manage and limit the number of API requests from a single host.

## Getting Started

Collect and Visualize your IoT Edge data in minutes by following this [guide](https://thingsboard.io/docs/edge/getting-started/).
Start to **collect** and **visualize** your **IoT Edge data** in minutes by following this [guide](https://thingsboard.io/docs/edge/getting-started/).

## FAQ

Check the [FAQ](https://thingsboard.io/docs/edge/faq/) section for answers to common questions about **ThingsBoard Edge** and its features.

## Support
- [Contact Us](https://thingsboard.io/docs/contact-us/)
- [Stackoverflow](http://stackoverflow.com/questions/tagged/thingsboard)

## Licenses

Expand Down
Binary file added img/batch-update.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit eb39004

Please sign in to comment.