Flinks: Alarms

Alarm Flink seamlessly integrates various alarm sources such as sensors, cameras, fences to trigger real-time dashboard notifications or automated workflows via Flows when thresholds are met.

Creating your Alarm Flink

Navigate to the Operations Dashboard and click on the Hamburger menu. From the dropdown menu, select Flinks under Integrations.

In the Flinks library, set up your custom Flink by choosing Alarms and clicking on Next.

Assign a name to your Flink. Optionally, add a description and an icon. Preview your Flink and click on Add.
Your new Flink will now appear in the My Flinks section.

Configuring your Alarm Flink

Go to My Flinks and select the Flink you just created. In the Configuration section you can assign a specific icon to the alarm.

After this move to the Alarm Sources section. All alarm sources associated with a Flink can be created and managed here. Click on Add Source to begin adding a new alarm source.
Here you can enter the name and a short description of the alarm source. After this click on Generate URL to proceed.

A follow-up window will display Source Details, which include:
A Trigger alarm Webhook URL with an associated JSON Payload to provide details of the alarm when triggered.
This JSON Payload can be modified and then tested using the Test button. Testing the alarm source would only raise an alarm on the Integration Panel on the right side of the dashboard and not initiate any linked Flow.

A Heartbeat URL to monitor and reflect the status of the alarm source on the FlytBase Dashboard. A Green status indicator in front of the alarm indicates an active alarm source.

These Webhook URLs can be used to integrate third-party sensors such as electronic fences, motion detection and thermal cameras with FlytBase.

To retrieve these URLs later, click on the Source Details button for the specific alarm source you want to integrate.
The Trigger alarm Payload (JSON) for the Alarm Source contains the following information:

//A sample JSON Payload
{
  "timestamp": 1708502346278, //Epoch time elapsed since Jan 1, 1970
  "severity": 2,              //Integer value in the range 1-3, unknown is 0
  "description": "High temperature!", //User-defined string in double-quotes
  "latitude": 37.7749,        //Source Latitude in decimal format
  "longitude": -122.4194,     //Source Longitude in decimal format
  "altitude_msl": 100,        //Altitude at which the drone hovers over the source
                              //Value should be +ve, and relative to mean sea level
  "metadata": {
    "sensor_id": "TempSensor12A", //User-defined additional data for the alarm
    "temperature": 50.2,          //Variable names in "", integers without quotes
    "battery_level": 80           //Strings in ""
  }
}

To retrieve these URLs later, click on the Source Details button for the specific alarm source you want to integrate.
Next, click on the Alarm logs section, all alarms triggered for the selected Flink are recorded here. You can filter these logs by Alarm Source or by the date they were raised.

Modifying and Deleting an Alarm Source

After setting up a Flink and alarm sources within it, you will be able to see notifications on the Integrations Panel on the right hand side of the dashboard whenever an alarm source is triggered.

Moving forward, you need to create an automation workflow to configure response action for the alarm sources from your drone fleet. To learn more about creating such automation workflows, refer to the documentation on Flows: Alarms.