GuidesAPI Reference

Tutorial: Generate a Smart Alert using Topic Data

Suggest Edits

Navigation

For this example we will be setting up a Low Battery Smart Alert.

  1. Click Settings.
74
  1. Click *Configurations*, then click *Smart Alerts*.
195
  1. Click *Create Smart Alert*.
172

You will be given a prompt to enter a smart alert name. Then you will be redirected to the Smart Alert details. From here, you can click the Alert Settings button.

123 2288

This will open a form. By default, the form is set to Data Outside of Bounds. This type will help monitor when data is outside of a specific range and you would like to generate an alert when that occurs.

The following alert types are supported:

TypeDescription
Data Outside Of BoundsMonitors when data you are publishing is outside of a specific range.
Device Not ConnectedAn alert form that triggers when the agent detects that the device is not connected to the internet.
Device Not ActiveWill trigger when the device is not actively publishing data.
System ResourcesA form type that will limit the CPU, Disk Space, and Virtual Memory.
Topic BandwidthMonitor your device's bandwidth usage and queue length. Queue length is a component of the freedom agent and has a cap of 5000 messages.

Tutorial

  1. Select the Alert Type Data Outside Bounds if not already selected. The name, description, resolution, and severity level are up to your preference.

  2. Enter the topic and element where the battery percentage is captured. This can be found on the Stream Dashboard page.

632

In the stream dashboard, a topic with the name battery is usually in place to define the battery properties. Find that topic name and the property associated with battery percentage. In this example, the topic is /battery_state and the element is charge_level.

696
  1. Enter the value you want to indicate is a low battery level.
640
  1. Click Save.
168

Updated over 1 year ago