Exceptions
Introduction
The ORB-X1 reports events such as informational messages, alerts, warnings and alarms as exceptions. Exceptions are generated internally by the device firmware and are included in the data message sent to the Senquip Portal (or any other configured endpoint). On the Senquip Portal, active exceptions are shown against the relevant channel and, depending on severity, are displayed as coloured badges, can change gauge/widget colours, and can be forwarded by email or SMS using the Events page.
Each exception consists of:
A channel, identifying the measurement or system function the exception relates to (for example Supply Voltage or Current 1). This is shown on the Senquip Portal as the channel/parameter name, which may be renamed by the user in the channel settings.
A message, describing the condition that occurred (for example Low or Calibration Error).
A severity level, a number from 1 to 100 that determines how the exception is categorised and displayed.
Severity Levels
Severity levels are grouped into four categories:
Level Range |
Category |
Portal Indication |
|---|---|---|
1 - 10 |
Info |
Not shown as a badge; recorded in the device event history. |
11 - 20 |
Alert |
Shown with a blue indicator. |
21 - 30 |
Warning |
Shown with an orange indicator. |
31 - 100 |
Alarm |
Shown with a red indicator. |
Most system-generated exceptions use a fixed severity level. Exceptions that are based on user-configured thresholds (such as the low/high alert levels on a measurement channel) allow the severity level to be set independently for each threshold when configuring the device.
If an exception escalates to a higher severity (for example a warning becomes an alarm), the more severe event is forwarded to email/SMS endpoints. If it de-escalates, no new notification is sent.
List of Exceptions
The table below lists the exceptions that can currently be generated by the ORB-X1, the channel(s) they apply to (as shown on the Senquip Portal), and their default severity.
Message |
Portal Channel Name(s) |
Default Severity |
Description |
|---|---|---|---|
Wake on IO Change |
System |
Info |
Device woke from hibernate due to an I/O change interrupt. |
Wake on Vibration |
System |
Info |
Device woke from hibernate due to motion/vibration being detected. |
Wake on Magnet |
System |
Info |
Device woke from hibernate due to the magnet switch being triggered. |
Wake on Tamper |
System |
Info |
Device woke from hibernate due to the light/tamper sensor being triggered. |
Startup Error |
System |
Info |
The internal co-processor (COP) failed to start or did not return measurements at boot. |
Hibernate Mode |
System |
Info |
Device is entering hibernate mode because the input voltage (VIN) is low. |
Device Shutdown |
System |
Alert |
System voltage (VSYS) dropped below the configured shutdown threshold and the device is not on charge. |
VSET Fault |
System |
Alarm |
A boost/output voltage set fault was reported by the internal co-processor (COP). |
Poor Source |
Supply Voltage |
Info |
The internal 9V rail is low while VIN is present. This indicates an inadequate power source. |
Low |
Supply Voltage |
Alert |
VIN has dropped below the configured VIN threshold (fixed level; separate from the configurable low/high threshold alert below). |
Module Error |
CAN 1 |
Info |
The CAN 1 module reported an error condition. |
Module Error |
CAN 2 |
Info |
The CAN 2 module reported an error condition. |
Calibration Error |
Analog 1, Analog 2, Analog 3, Analog 4, Analog 5 |
Info |
The calibration string produced an invalid result for the voltage measurement on this channel. |
Calibration Error |
Current 1, Current 2, Current 3, Current 4, Current 5 |
Info |
The calibration string produced an invalid result for the current measurement on this channel. |
Current Out of Range |
Current 1, Current 2, Current 3, Current 4, Current 5 |
Info |
The current measurement exceeded the measurable range of the channel. |
Overcurrent Shutdown |
Current 1, Current 2, Current 3, Current 4, Current 5 |
Alarm |
An output overcurrent fault was detected by the internal co-processor (COP) and the channel was shut down. |
Calibration Error |
Frequency 1, Frequency 2, Frequency 3, Frequency 4, Frequency 5 |
Info |
The calibration string produced an invalid result for the frequency measurement on this channel. |
Calibration Error |
Duty Cycle 1, Duty Cycle 2, Duty Cycle 3, Duty Cycle 4, Duty Cycle 5 |
Info |
The calibration string produced an invalid result for the duty cycle measurement on this channel. |
Calibration Error |
Pulse 1, Pulse 2, Pulse 3, Pulse 4, Pulse 5 |
Info |
The calibration string produced an invalid result for the pulse measurement on this channel. |
Calibration Error |
Modbus 1 - Modbus 50 |
Info |
The calibration string produced an invalid result for the Modbus register value on this channel. |
Invalid Settings |
Modbus 1 - Modbus 50 |
Info |
The configured Modbus slave/register settings string could not be parsed. |
Read Error Ch <list> |
Modbus |
Info |
One or more Modbus channels failed to return a value; the failing channel numbers are appended to the message, e.g. “Read Error Ch 1,3”. |
Alert Settings Error |
Any channel with configurable alert thresholds |
Info |
The alert threshold configuration string for the channel is malformed. |
Low |
Any channel with configurable alert thresholds |
Configurable |
Measurement has crossed below a configured low alert threshold. Applies to Analog, Current, Frequency, Duty Cycle, Pulse, Modbus, Ambient, Pitch, Roll, Angle, Vibration and Speed channels. |
High |
Any channel with configurable alert thresholds |
Configurable |
Measurement has crossed above a configured high alert threshold. Applies to Analog, Current, Frequency, Duty Cycle, Pulse, Modbus, Ambient, Pitch, Roll, Angle, Vibration and Speed channels. |
Geofence Entry |
GPS Position |
Configurable |
Device position has crossed into a configured geofence boundary. |
Geofence Exit |
GPS Position |
Configurable |
Device position has crossed out of a configured geofence boundary. |
Lid Open |
Tamper |
Configurable |
The light/tamper sensor was triggered while the tamper alert is enabled. Severity is taken from the tamper alert setting. |
Data captured |
Serial 1 |
Configurable |
A serial capture alert condition was met on Serial 1. Severity is taken from the serial capture alert setting. |
Impact Event 1 |
Vibration |
Configurable |
The accelerometer detected an Impact Event 1 threshold crossing. Severity is taken from the impact event 1 setting. |
Impact Event 2 |
Vibration |
Configurable |
The accelerometer detected an Impact Event 2 threshold crossing. Severity is taken from the impact event 2 setting. |
Wake from Hibernate |
Vibration |
Alert |
Device exited hibernate mode due to an accelerometer/motion wake trigger. |
(script error text) |
Script |
Warning |
The text of the last mJS script runtime error. Sent when the Send Script Errors setting is enabled. |
(user-defined message) |
Custom 1 - Custom 50 |
User-defined |
Raised by a device script using the custom exception API, with a user-specified message and severity level. |
Note
Some exceptions, such as Read Error Ch <list>, include additional dynamic information appended to the message (for example the affected channel numbers). The text of a script-generated exception is defined by the device’s mJS script and so is not fixed.
Note
Channels such as Analog, Current, Frequency, Duty Cycle, Pulse and Modbus are available in multiples (for example Analog 1 to Analog 5, or Modbus 1 to Modbus 50) depending on the device model and configuration. The name shown for each channel on the Senquip Portal may be customised by the user.