Alarms

Overview

The Alarms service enables users to create alarms triggered by threshold conditions defined in the Rules Engine. When a rule is triggered, the system generates an alarm with relevant information for monitoring and response.

The alarm object includes the following fields:

Use Cases

Common scenarios where alarms provide value in IoT systems:

• Temperature Monitoring: Alert when sensors report values outside safe thresholds in server rooms, greenhouses, or refrigerators
• Power Consumption: Trigger alerts when energy usage exceeds limits to prevent overload or equipment damage
• Air Quality: Detect hazardous gas levels (CO₂, smoke) in smart buildings
• Water Leak Detection: Alert when sensors detect unexpected moisture in facilities or homes
• Machine Monitoring: Generate alerts based on vibration or noise thresholds for preventive maintenance
• Security Events: Detect unauthorized access or motion in restricted areas

Create Alarm

To create an alarm, define an alarm rule in the Rules Engine:

1. Navigate to the Rules page and create a new rule

   

2. Click + Create Rule to open the rule editor

   

3. Add an Input node with channel and topic configuration

   

   

   

4. Add an Editor block for rule logic

   

   

5. Add the Alarm node as output

   

6. Save the rule by clicking Save Rule and provide a name

   

7. View the completed rule

   

Below are examples of Lua and Go scripts for checking water level thresholds:

function logicFunction()
    local results = {}
    local threshold = 2000

    for _, msg in ipairs(message.payload) do
        local value = msg.v
        local severity
        local cause

        if value >= threshold * 1.5 then
            severity = 5
            cause = "Critical level exceeded"
        elseif value >= threshold * 1.2 then
            severity = 4
            cause = "High level detected"
        elseif value >= threshold then
            severity = 3
            cause = "Threshold reached"
        end

        table.insert(results, {
            measurement = msg.n,
            value = tostring(value),
            threshold = tostring(threshold),
            cause = cause,
            unit = msg.unit,
            severity = severity,
        })
    end

    return results
end
return logicFunction()

package main

import (
  m "messaging"
  "fmt"
  "strconv"
)


type alarm struct {
  Measurement string
  Value       string
  Threshold   string
  Cause       string
  Unit        string
  Severity    uint8
}

func logicFunction() any {
  results := []alarm{}
  threshold := 2000.0
  pld, ok := m.message.Payload.([]any)
  if !ok {
  panic("invalid payload")
  }
  for _, m := range pld {
  if m == nil {
  continue
  }
  msg, ok := m.(map[string]any)
  if !ok {
    panic("not map")
  }

  value := msg["v"].(float64)
  unit := msg["u"].(string)
  msmnt := msg["n"].(string)
  var severity uint8
  var cause string

  switch {
  case value >= threshold*1.5:
  severity = 5
  cause = "Critical level exceeded"
  case value >= threshold*1.2:
   severity = 4
  cause = "High level detected"
  case value >= threshold:
   severity = 3
   cause = "Threshold reached"
  }

  result := alarm{
   Measurement: msmnt,
   Value:       strconv.FormatFloat(value, 'f', -1, 64),
   Threshold:   strconv.FormatFloat(threshold, 'f', -1, 64),
   Cause:       cause,
   Unit:        unit,
   Severity:    severity,
  }
  results = append(results, result)
 }
 fmt.Println("returning", len(results))

 return results
}

:::info

Severity values range from 1 to 5, with 1 being the lowest and 5 the highest.

:::

View Alarms

To view existing alarms, navigate to the Alarms page via the sidebar. This page displays all generated alarms with their current status and details.

Filter Alarms

Use filters to narrow down the alarm list based on specific criteria:

1. Click the Filter button on the alarms page
2. Select from available filter options:
   • Channel: Filter by communication channel
   • Subtopic: Filter by message subtopic
   • Severity: Filter by alarm severity level
   • Assignee: Filter by assigned team member
   • Updated By: Filter by who last modified the alarm
   • Assigned By: Filter by who assigned the alarm
   • Acknowledged By: Filter by who acknowledged the alarm
   • Resolved By: Filter by who resolved the alarm
   • Created From: Filter by alarm creation start date
   • Created To: Filter by alarm creation end date (must be after "Created From")
3. Apply filters to update the alarm list

Download Alarms CSV

Export alarm data to CSV format for analysis or reporting:

1. Click the Download CSV button on the alarms page
2. Configure export settings:

Field Selection

Choose which fields to include in the CSV:
ID, Severity, Cause, Value, Threshold, Client ID, Assignee, Assigned At, Acknowledged At, Resolved At, Updated At, Rule, Status, Measurement, Unit, Channel ID, Subtopic, Assigned By, Acknowledged By, Resolved By, Updated By, Created At

Basic Settings

• Offset: Starting record number
• Limit: Maximum number of records
• Channel: Filter by specific channel
• Subtopic: Filter by subtopic
• Severity: Filter by severity level
• Assignee: Filter by assigned user
• File Name: Custom name for the CSV file

Advanced Filters

• Updated By: Filter by who modified the alarm
• Assigned By: Filter by who assigned the alarm
• Acknowledged By: Filter by who acknowledged the alarm
• Resolved By: Filter by who resolved the alarm
• Created From: Start date for alarm creation
• Created To: End date for alarm creation

3. Click Download to generate and save the CSV file

Acknowledge Alarm

To acknowledge an alarm:

1. Click the quick links button next to the alarm
2. Select Acknowledge from the dropdown menu
3. Confirm the acknowledgment

Clear Alarm

To clear an alarm:

1. Click the quick links button next to the alarm
2. Select Clear from the dropdown menu
3. Confirm the action

Assign Alarm

To assign an alarm to a domain member:

1. Click the quick links button next to the alarm
2. Select Assign from the dropdown menu
3. Choose the member from the available users
4. Click Assign to confirm

To reassign an alarm to a different person, follow the same process and select the new assignee.

View Details

To view comprehensive alarm information:

1. Click the quick links button next to the alarm
2. Select View Details from the dropdown menu

The alarm details dialog contains three sections:

General Details

Displays core alarm information:

• Alarm status
• Rule that triggered the alarm
• Publisher (device/client)
• Channel where the message was published
• Current assignee (if assigned)

Timeline

Shows chronological alarm actions:

• Alarm creation
• Acknowledgment events
• Resolution events
• Assignment changes

Activity Log

Allows team collaboration:

• Add comments about the alarm
• View previous comments
• Track communication history

Quick Actions

From the details dialog, you can:

• Assign the alarm to a team member
• Acknowledge the alarm
• Clear/resolve the alarm

Delete Alarm

To delete an alarm:

1. Click the quick links button next to the alarm
2. Select Delete from the dropdown menu
3. Confirm the deletion