Skip to content

Commit

Permalink
continue writing Lesson 5
Browse files Browse the repository at this point in the history
  • Loading branch information
stitenko committed Jan 22, 2025
1 parent 5b64778 commit 94d18e9
Show file tree
Hide file tree
Showing 136 changed files with 139 additions and 29 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,13 @@ Alarm Clearing:

{% include images-gallery.html imageCollection="final-co2-alarm-rules" %}

<br><br>
<br>
Now that we have defined all the alarm rules for the "air-sensor" device profile, the next step is to add a widget to manage the alarms.

<br>

**Import device profile**

If, for any reason, you were unable to configure the rules mentioned above, you can [download the air-sensor device profile with pre-configured alarm rules](/docs/user-guide/advanced-guides-for-working-with-dashboard/files-from-tutorial/air_sensor_imported_.json){:target="_blank"} and import it into your ThingsBoard instance.

{% capture difference %}
Expand All @@ -186,24 +190,59 @@ If, for any reason, you were unable to configure the rules mentioned above, you

## Adding alarms table widget

Displaying alarms in a user-friendly manner is crucial for monitoring and management.
The Alarm Table widget in ThingsBoard provides a customizable interface to view and interact with alarms.
Displaying alarms in a user-friendly format is essential for monitoring and managing them effectively.
The "Alarms table" widget in ThingsBoard provides a customizable interface for easy monitoring and interaction with alarms.

Steps to Add an Alarm Table Widget:
Steps to add the "Alarm table" widget:

{% include images-gallery.html imageCollection="adding-alarms-table-widget-1" showListImageTitles="true" %}

*Send telemetry*
## Send telemetry

Now that the alarm rules have been defined and the widget for displaying them has been added, let&#39;s manually create conditions to trigger an alarm.
We&#39;ll send test telemetry with a value exceeding the threshold defined in the alarm rule.
As you may recall, if the temperature value exceeds 24, an alarm with a "Major" severity will be triggered. Follow these steps:

{% include images-gallery.html imageCollection="alarm-send-telemetry-1" showListImageTitles="true" %}

*Clear alarm*
### Clear alarm

To clear the alarm, click on the "Clear" icon in the "Alarms" widget.

{% include images-gallery.html imageCollection="clear-alarm-1" showListImageTitles="true" %}


## Adding alarm widget to all other states

**Add alarm widget to Office state**

Add an alarm widget to the building state as well. This widget will display alarms from all devices associated with the selected building. We'll add this widget using the copy method.

- Go to the device state, enter Edit Mode, right-click on the alarm widget, and select "Copy" from the dropdown menu;
- Navigate to the office state, right-click on an empty area of the dashboard, and select "Paste";
- Position the widget to align with the dashboard aesthetics, then open its settings and adjust as needed.
- Save the changes.

Switch to the office state. As you may notice, active alarms are not displayed in the widget. This happens because the widget needs to be configured to search for propagated alarms.

- Enter Edit Mode on the dashboard and edit the alarm widget:
- Turn on the "Search propagated alarms" option. The "Search propagated alarms" parameter allows displaying alarms for both the selected entity and its child entities, provided there are relationships between them;
- Change the widget title to "${entityName} alarms";
- Apply the changes;
- Save the dashboard.

Now, as you can see, alarms from the devices are properly displayed in the widget.

{% include images-gallery.html imageCollection="add-alarm-widget-to-office-state-1" showListImageTitles="true" %}

**Add alarm widget to Building A state**

{% include images-gallery.html imageCollection="add-alarm-widget-to-building-a-state-1" showListImageTitles="true" %}

**Add alarm widget to Buildings state**

{% include images-gallery.html imageCollection="add-alarm-widget-to-buildings-state-1" showListImageTitles="true" %}

## Next step

At this stage, the development of our dashboard is complete. In the next lesson, we will share this dashboard with customers.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -106,63 +106,134 @@ final-co2-alarm-rules:
adding-alarms-table-widget-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-1-pe.png
title: ''
title: 'Click on the "Indoor Air Quality Sensor" device row in the "Office sensors list" widget to transition to its state;'
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-2-pe.png
title: ''
title: 'Enter dashboard editing mode;'
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-3-pe.png
title: ''
title: 'Click the "+ Add widget" button at the top of the screen;'
3:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-4-pe.png
title: ''
title: 'Find the "Alarm widgets" widgets bundle and click on it;'
4:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-5-pe.png
title: ';'
title: 'Choose the "Alarms table" widget;'
5:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-6-pe.png
title: ''
title: 'Specify "Selected entity" alias as the data source. Check "Active" in the alarm status list of the filter section to show only active alarms;'
6:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-7-pe.png
title: ''
title: 'Remove "assignee" column;'
7:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-8-pe.png
title: ''
title: 'Change widget title to "Air sensor alarms". Next, turn off all option except "All alarms clear" option in the "Table buttons" section;'
8:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-9-pe.png
title: 'Uncheck "Data export" option in the "Card appearance" section. Then, click "Add" to confirm adding widget;'
9:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-10-pe.png
title: 'We have added a widget that will display the active alarms for your device. Place the "Air sensor alarms" widget on the free space of the dashboard and adjust its size by dragging the lower right corner. Then, save the dashboard.'
10:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/adding-alarms-table-widget-11-pe.png
title: ''

alarm-send-telemetry-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/alarm-send-telemetry-1-pe.png
title: ''
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/send-telemetry-1-pe.png
title: 'Open the "Devices" page. Choose the "Indoor Air Quality Sensor" device and click the "Check connectivity” button in the "Device details" window;'
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/alarm-send-telemetry-2-pe.png
title: ''
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/send-telemetry-2-pe.png
title: 'In the opened window choose the desired messaging protocol and select your operating system. Install the required client tools, if necessary. Next, copy the provided command, which includes telemetry data;'
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/alarm-send-telemetry-3-pe.png
title: ''
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/send-telemetry-3-pe.png
title: 'Open the Terminal and paste the copied command. This command will send a POST request to the ThingsBoard server with the {"temperature":25} data. Execute this command. After successful execution, the "temperature" reading will be published. Then, close the connectivity window;'
3:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/alarm-send-telemetry-4-pe.png
title: ''

image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/send-telemetry-4-pe.png
title: 'Return to the dashboard and navigate to the "air-sensor" state. In the "Alarm table" widget, a new alarm should appear, indicating the triggered rule;'
4:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/send-telemetry-5-pe.png
title: 'You will also receive a notification about the triggered alarm in the Notification center.'

clear-alarm-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/clear-alarm-1-pe.png
title: 'To clear the alarm, click on the "Clear" icon;'
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/clear-alarm-2-pe.png
title: ''
title: 'Click "Yes" to confirm clear alarm;'
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/clear-alarm-3-pe.png
title: ''

add-alarm-widget-to-office-state-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-1-pe.png
title: ''
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-2-pe.png
title: ''
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-3-pe.png
title: ''
3:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-4-pe.png
title: ''
4:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-5-pe.png
title: ''
5:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-6-pe.png
title: ''
6:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-7-pe.png
title: ''
7:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-8-pe.png
title: ''
8:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-9-pe.png
title: ''
9:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-10-pe.png
title: ''
10:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-office-state-11-pe.png
title: ''

add-alarm-widget-to-building-a-state-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-building-a-state-1-pe.png
title: ''
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-building-a-state-2-pe.png
title: ''
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-building-a-state-3-pe.png
title: ''
3:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-building-a-state-4-pe.png
title: ''
4:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-building-a-state-5-pe.png
title: ''





add-alarm-widget-to-buildings-state-1:
0:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-buildings-state-1-pe.png
title: ''
1:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-buildings-state-2-pe.png
title: ''
2:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-buildings-state-3-pe.png
title: ''
3:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-buildings-state-4-pe.png
title: ''
4:
image: /images/user-guide/advanced-guides-for-working-with-dashboard/lesson-4/add-alarm-widget-to-buildings-state-5-pe.png
title: ''



Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ...r-working-with-dashboard/lesson-4/critical-high-temperature-alarm-rule-1-pe.png
100644 → 100755
Binary file modified ...r-working-with-dashboard/lesson-4/critical-high-temperature-alarm-rule-2-pe.png
100644 → 100755
Binary file modified ...r-working-with-dashboard/lesson-4/critical-high-temperature-alarm-rule-3-pe.png
100644 → 100755
Binary file modified ...r-working-with-dashboard/lesson-4/critical-high-temperature-alarm-rule-6-pe.png
100644 → 100755
Binary file modified ...for-working-with-dashboard/lesson-4/final-high-temperature-alarm-rules-1-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/high-temperature-clear-alarm-rule-1-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/high-temperature-clear-alarm-rule-2-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/high-temperature-clear-alarm-rule-3-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/high-temperature-clear-alarm-rule-4-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-1-pe.png
100644 → 100755
Binary file modified ...for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-10-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-2-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-3-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-4-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-5-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-7-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-8-pe.png
100644 → 100755
Binary file modified ...-for-working-with-dashboard/lesson-4/major-high-temperature-alarm-rule-9-pe.png
100644 → 100755

0 comments on commit 94d18e9

Please sign in to comment.