An alert is used to notify users when data from a device meets certain conditions. An alert can be set to only activate at certain type of the day/week, and can monitor as many signals from different CAN Databases within the specified model as needed.
- Open the navigation menu.
- Select the Alerts item.
- Double-click the desired alert.
- If no alerts exist, use the
button to create one.
- If no alerts exist, use the
The alert editor page contains four sections for configuring what the alert should be sent for and how it should be sent.
There are certain restrictions on alert configuration that apply depending on model type.
- Name
- Identifies the alert across the platform.
- Alert Frequency
- The minimum amount of time between alert triggers.
- Prevents the alert from being sent continually to users.
- Specified in minutes; defaults to 60.
- Model
- What CAN databases to use for signals in the alert conditions.
Select which devices the alert should monitor. Only devices from the specified model can be monitored.
Devices are continuously checking their data against the alert's conditions. If a device determines that all conditions have been met, and the time is within the bounds of the date condition, then the relevant values for the alert are sent up to Spoke Zone, which then sends out the alert actions to users.
To add a new condition:
- Click the
button. - Search for the signal from the CAN database to be monitored. They are grouped by message.
- Select an operator for comparing the signal value.
- Specify the parameter to compare the signal to.
- Select a statistic to be calculated from the data collected over a period to then check against the condition.
- Using an aggregated statistic helps to mitigate the effect of outlier data points.
- Specify how much time, in seconds, to collect data before calculating the statistic and checking the condition.
The new condition specifies a mathematical expression that triggers the alert if it evaluates to true.
For example, specifying the signal speed
, operator greater than
, and parameter 65
will trigger the alert when the following is true:
This expression is described in the title of the condition.
Edit a previously created condition by clicking the
Date conditions prevent the alert from being triggered at inconvenient times.
To add a new date condition:
- Click the
button. - Select which days to enable the alert on.
- Specify the range of time each day during which the alert should be enabled.
- All times must be specified in UTC.
Now, combining with the example signal above, the alert will trigger when the following is true:
Edit a previously created date condition by clicking the
Actions determine how users should be notified when a device uploads data that triggers the alert.
There are two types:
- Email: Requires email address(es) and content
- Text: Requires phone number(s) and message
Click the
Value interpolation can be used to insert relevant CAN signals and other info into the message. See this page for details.