Thresholds, Actions and Notifications
Thresholds, Actions and Notifications
Maximum Number of Thresholds
The maximum number of thresholds is a function of the number of channels, levels, and SETPARAM actions.
To check these:
Go to the DEVICE ADVANCED CONFIGURATION section for the device.
Navigate to the Serial | Analog | Digital dropdown list.
Parameters to Note
Channel > channel_number:
Look for the value of
graph_level_count. This is primarily determined by the firmware version of the device.
Level > channel_number:
Look for the value of
level_setparam_count. The number of parameters defined across all channels of a sensor type—Serial, Analog, Digital—contributes to the SETPARAM_COUNT for that sensor type.
Default Maximum Values by Device Type
Serial CHANNEL_COUNT
16
16
16
16
16
8
16
8
Serial LEVEL_COUNT
30
30
30
30
30
15
30
15
Serial SETPARAM_COUNT
30
30
30
30
30
15
30
15
Analog CHANNEL_COUNT
4
4
4
4
4
4
2
2
Analog LEVEL_COUNT
12
12
12
12
12
12
12
12
Analog SETPARAM_COUNT
12
12
12
12
12
12
12
12
Digital CHANNEL_COUNT
6
6
6
6
6
6
2
2
Digital LEVEL_COUNT
12
12
12
12
12
12
12
12
Digital SETPARAM_COUNT
12
12
12
12
12
12
12
12
Note: These values may change in future firmware and software versions.
Parameters – What They Mean and Their Range of Values
The following table provides a brief explanation of each parameter and its range of acceptable values.
Technical Streams
For technical streams and their values, see [Overview of Technical Streams].
Health Tab Parameters
BOOT COUNT
The number of times the device has booted since activation.
- Large jump: battery may be dead. - Reset to 0: firmware upgrade or lost configuration.
BOOT REASON CODE
The code for the latest device reboot.
- 12: Brownout Detector Reset (dead battery). - 1: Power On Reset (manual/command). - 64: System Reset (Watchdog).
BOOT REASON
The reason corresponding to the boot code.
See BOOT REASON CODE.
GENERAL ERR
Not used.
Disregard.
GSM POWERON
Number of times the GSM modem was turned on.
GSM TX SUCCESS
Number of successful GSM transmissions (HTTP relevant).
GSM ERR
Number of GSM transmission failures.
Possible causes: - Bad signal (poor antenna). - Server unreachable.
GSM NO CREG
Times the device couldn't register on a cellular network.
GSM MODEM DEAD
Indicates modem start failure.
- 0: Normal. - 1: Modem is dead.
GSM PDP DATA HUBL
Number of ping test failures to the server.
GSM NO OPERATORS
Times no cellular networks were found.
LOG REC DISCARDED
Files discarded when storage was nearly full.
GPS DATA HUBL FIX
Failed GPS fix attempts.
TOUCH_EVENT
Not used.
Disregard.
MODBUS READ ERROR
Errors on the serial Modbus sensor.
Possible causes: - Sensor not connected. - Sensor misconfigured.
TIMEKEEPER ACTSRC DATA HUBL
Failed atomic time retrievals during HTTP.
SDCARD ERROR
Failed SPI transactions with SD card.
LORA TX SUCCESS
Successful LoRa transmissions.
LORA TX DATA HUBL
Failed LoRa transmissions.
LORA RECEIVED CMDS
Commands received via LoRa (useful for debugging).
LORA CONFIRMS DATA HUBL
LoRa sent error (RN2483_MAC_ERR): communication problem.
LORA POWER ON DATA HUBL
LoRa module failed to power up.
LORA INIT DATA HUBL
LoRa module powered up but failed during setup.
TRACE CMDS
Commands received during device trace.
SERVER CMDS
Server commands since last reboot.
Listed in the Commands tab.
BLE ERROR
Bluetooth communication failures with mobile app.
Examples: - Message send failure. - Invalid message from app.
BLE CONNECTIONS
Successful mobile app connections.
MQTT CONNECTION
Successful MQTT broker connections.
MQTT PUBLISH
Records published to MQTT broker since last reboot.
MQTT PUBLISH ERROR
Failed attempts to publish to MQTT broker.
MQTT CONNECTION ERROR
MQTT broker connection errors.
DATA LOGGER ERROR
Failed SD save, fallback to FFS (flash).
DATA LOG CREATED
Successfully saved data samples to persistent memory.
POWERSUPPLY SWITCH
Power source switches (battery ↔ external).
LKGC LINK OPEN
Device reverted to LKGC for communication.
Notes
Regular monitoring helps detect issues such as dead batteries, signal failures, and misconfigurations.
Communication-related parameters (GSM, LoRa, MQTT) are critical for troubleshooting connectivity problems.
Adding and Editing a Threshold
You can configure and manage thresholds on a data stream to define actions when specific conditions are met. This includes adjusting sampling behavior, triggering digital outputs, and sending notifications.
Overview of Threshold Capabilities
From the Configuration & Thresholds tab of a data stream, you can:
Add or edit thresholds
Define actions triggered by thresholds
Limit sampling intervals
Manage digital output channel behavior
Threshold Limits
Analog channel: Up to 4 thresholds
Serial channel: Up to 4 thresholds
Digital channel: Up to 4 thresholds
Per device total: 54 thresholds across all data streams
Prerequisites
Sampling Limits must be defined: Final Value Limits must be set before thresholds can be added. See: Limiting the display of engineering values.
Define actions: Ensure all possible data value ranges are covered by threshold actions.
Voice notifications: Contact [email protected] to enable voice message alerts.
To Add or Edit a Threshold
In the left pane, click Devices.
In the Sites Tree, click the stream name.
In the right pane, open the Configuration & Thresholds tab.
Slide the Thresholds toggle to ON. A graph displays data from the past week. Existing thresholds appear below the graph.
Click +Add Threshold.
In the Create New Threshold window:
a. Name: Give the threshold a descriptive name — this will appear in alerts.
b. Threshold: Enter a value within the valid range.
The system may automatically convert the value to a decimal for engineering unit conversion and transmission.
c. False Alarm Threshold (Optional): Enter a value no lower than the sampling interval, or leave blank to use the default (0 = no false alarm filtering).
d. Click Submit.
Defining Threshold Actions
Click the lightning bolt icon next to your newly created threshold. The Update Threshold Actions window opens.
Configure these settings:
Transmit Data
Immediately: Sends data instantly when the threshold is crossed.
This is checked automatically if notifications are enabled.
Transmission Interval
Options:
Normal,Event,EmergencyShorter intervals increase power and network usage. When triggered, the device transmits all data streams, not just the one with the threshold.
Notification Actions
Select user groups and delivery methods: Email, SMS, Voice
If you see
****for a user group, contact support.
Stream Sampling Actions
For each data stream, select an action:
Pause Sampling: Temporarily stops sampling
Resume Sampling: Resumes normal sampling
Sample Once: Takes one sample immediately, then continues normal schedule
Pause Single: Takes one sample immediately, then pauses sampling
Change Interval: Set a new sampling frequency (in seconds)
Digital Output Actions
Choose a digital output channel and an action:
PULSE ONCE: Sends a single pulse based on:
output_pulse_count,output_time_high,output_time_low(RequiresType=PT_OUTPUT_DRIVEin Advanced Configuration)
SET DOWN: Pin output goes LOW (0V)
SET UP: Pin output goes HIGH (2.8V)
Click Submit to save.
Verify the Configuration
In the left pane, click the Device.
Go to the Commands tab.
Confirm that both Set Thresholds and Reboot commands are 100% green under the Command and Status columns.
Manage Data Stream Thresholds
You can configure thresholds for data streams to define a range of acceptable data sample values and set automated alert or notification actions.
Thresholds are not available for virtual, technical, or event streams; they apply only to data streams and are configured individually.
Overview of Data Stream Thresholds
Purpose: Monitor data sample values and trigger actions when those values exceed defined limits.
Configuration: Thresholds are defined in the UI and downloaded to the device during the next transmission. The device stores these configurations locally, enabling immediate action.
Supported Stream Types: Serial, analog, and digital streams.
Setting a Data Stream Threshold
Define Threshold Ranges:
Each threshold range is defined by an upper limit.
The lower limit is automatically set to the upper limit of the previous range (or the sensor's minimum value for the first range).
Example (for a temperature sensor measuring 0°F to 250°F):
Normal: 0°F to 90°F → no alert
Hot: 90°F to 120°F → alert action required
SuperHot: 120°F to 250°F → alert action required
Configure Alert Actions:
Specify actions triggered when thresholds are exceeded.
Actions may include:
Sending email/SMS alerts
Adjusting sampling or transmission intervals
Triggering other streams
Set False Alarm Threshold:
Prevents alerts due to short data spikes.
Example: If set to 120 seconds, no alert actions are triggered unless the data exceeds the threshold for more than 2 minutes.
Key Features
Multiple Thresholds per Stream:
Each data stream can have up to four threshold ranges.
Transmission Interval Adjustment:
Change the transmission interval:
Normal,Event,EmergencyExample: If temperature exceeds the "Hot" threshold, switch to "Event" mode.
Sampling Interval Adjustment:
Modify the sampling interval for all streams in the same sample group.
Example: If Stream A exceeds a threshold and reduces its sampling interval to 1 minute, all streams in the same group will follow.
Example Threshold Configuration
For a temperature sensor (0°F to 250°F):
Normal
Range: 0°F to 90°F
Action: None
Hot
Range: 90°F to 120°F
Action: Send SMS alert and adjust transmission interval
SuperHot
Range: 120°F to 250°F
Action: Send email alert and trigger external action
Benefits of Thresholds
Monitor device and sensor performance in real time
Reduce false alarms with configurable False Alarm Thresholds
Automate responses to sensor readings for timely action and efficient device management
Sending a Test Email and SMS
Threshold Alerts and Device Technical Alerts are delivered via email and/or SMS. To verify that alerts will be properly received, users can send themselves a test message.
Who Can Send Test Messages
Logged-in users can send a test email and SMS to themselves.
Users with the "No Access" role cannot log in. However, an Account Owner can send a test message on their behalf.
Steps to Send a Test Email and SMS
In the left navigation pane, click Profile.
Select Personal Settings. The Profile window opens.
Scroll to the bottom of the page and click Test Email or Test SMS.
In the pop-up window, click Yes to confirm.
You should receive an email or SMS shortly.
Note: If you do not receive the test message, please contact Support.
Threshold Operations Exceeding the Limit
Currently, there is a limit on the number of operations that can be configured per threshold level. This article outlines a workaround for situations where the number of operations exceeds the supported limit.
What Are Threshold Operations?
Threshold operations are actions triggered by the Data Logger when a threshold condition is met. These actions fall into the following categories:
Transmit Data
Transmission Interval
Performed by the Data Logger.
Does not consume operations.
Sampling Actions (Consumes operations)
Change sample interval
Stream sampling actions
Digital output actions
Notification Actions
Server-side notifications
Do not consume operations.
Operations Limitation
The Data Logger supports a maximum of three operations per threshold level.
Operations Usage
Action Type
Operation
Operations Used
Sampling Interval
Change sample interval
3 actions
Stream Sampling Actions
Pause sampling
1 action
Resume sampling
1 action
Sample once
2 actions
Pause single
2 actions
Change sample interval
3 actions
Digital Output Actions
Set UP
1 action
Set DOWN
1 action
Pulse Once
2 actions
Workaround for Operation Limitation
If more than three operations are needed for a threshold, you can configure an additional stream that mirrors the original stream’s transformation, final values, and threshold settings.
Example: Level Sensor and Camera
Threshold Conditions
If Level = 0–20 cm
Sample interval should be 10 minutes for both the Level Sensor and Camera.
If Level = 20–70 cm
Sample interval should be 5 minutes for both the Level Sensor and Camera.
Each time the level crosses 20 cm
Send a notification
Change the transmission interval
Problem
Changing the sample interval uses 3 operations per group. Applying this action to Sample Group 1 (Level Sensor) and Sample Group 2 (Camera) requires 6 operations, exceeding the 3-operation limit.
Solution
Configure the Level stream thresholds to change the sample interval for Group 1 (Level Sensor).
Create an additional channel: Level (technical stream for camera thresholds).
Configure this new channel to handle sample interval changes for Group 2 (Camera).
Note
You do not need to duplicate configuration for:
Notification actions
Transmit data
Transmission interval
These are already managed by the original Level channel thresholds.
Configuring a Power Source Technical Stream and its Alert
You can configure a technical stream to monitor when the power source changes from the internal battery to an external source, or vice versa. This stream gives information about the device itself so that you can monitor its health.
An Alert can be sent by email, SMS, or both methods. Unlike all other technical streams, this stream can be configured to send an Alert immediately rather than at the next regularly scheduled transmission.
Prerequisite
The device must have Firmware version 2.3 or newer.
To configure a power source technical stream and its alert:
1. Follow the instructions to create a technical stream. In step 5, do the following:
a. Select EXTERNAL POWER VOLTAGE channel to associate with the new stream. b. Select Voltage(V) as the Engineering Units.
c. Click Submit.
In the STREAM MANAGEMENT area, the new technical stream is shown as associated with the EXTERNAL POWER VOLTAGE channel.
2. Configure the Power Source Switch alert.
3. In your DATA HUB UI, do the following:
a. In the left pane, click Fleet Management, and select the device whose power source you need to monitor. b. In the device pane, scroll down to the Advanced Device Configuration area. c. Open the SysHealth dropdown list, and then do the following steps:
Click power source switch alert action, and then select what action will trigger an alert:
PWR_SRC_SWITCH_ACT_NONE– no alert is ever triggeredPWR_SRC_SWITCH_ACT_EXT– the power switches to an external sourcePWR_SRC_SWITCH_ACT_INT– the power switches to an internal sourcePWR_SRC_SWITCH_ACT_BOTH– the power switches to an external or to an internal source
Click pwr_src_switch_transmit_immediate, and then select when to send the alert:
0– send the alert at the next normally scheduled transmission1– send the alert immediately after a power source switch alert action occurs
Creating an Events Stream for SCADA Systems
Contents
Overview of Events Stream
Steps to Create an Events Stream
Overview of an Events Stream
This functionality is designed for users who rely on a SCADA system — rather than the FAI UI — for monitoring and management.
An Events stream solves a common problem: although SCADA systems receive data streams, they do not receive notifications about events. An event refers to any occurrence in which a sample value crosses a defined threshold, thereby triggering the associated Threshold Actions.
While it is possible to manually configure thresholds and alerts within the SCADA system to mirror those in the FAI UI, there are limitations:
SCADA systems are not automatically notified when thresholds or actions are changed in the FAI UI.
Even if SCADA integrators are informed manually, corresponding updates must be made to the SCADA configuration.
The Events Stream Solution
The Events stream provides a workaround by decoupling threshold logic from specific value ranges (which may change) and instead tying it to a fixed index number.
In the FAI UI, each stream can have up to five thresholds. These are mapped to static index numbers 1 through 5, where:
1 is the lowest threshold
5 is the highest threshold
Whenever a sample crosses into a different threshold zone, the Events stream logs the corresponding index number in its Samples table. This allows you to configure static rules in the SCADA system for each index number just once.
Example
Suppose a level stream is configured with three thresholds:
1: Value range from –∞ to 0
2: Value range from 0 to 5
3: Value range from 5 to ∞
The Samples table of the Events stream will display:
Datetime
Raw Value
Final Value (shows the index number only when a threshold is crossed)
If the sample value remains within the current threshold, no index number appears in the Final Value column.
Steps to Create an Events Stream
Open Fleet Management
In the left pane, click Fleet Management.
Select the Device
Find and click the name of the device you want to configure.
Access the Stream
Go to the Stream tab.
Click the name of the stream you want to use.
Enable Thresholds
Click the Threshold tab.
Toggle the option to “Turn on” the threshold section.
Create the Events Stream
On the right side, click the Create Events Stream button.
Submit
In the Create Events Stream window that appears, click Submit.
An Events stream is created for the selected data stream.
Last updated