V2/Concepts/Event

From Senfi Docs
Revision as of 16:18, 29 June 2021 by Huiyan (talk | contribs)
Jump to: navigation, search

Event

Whenever Result changes (from true to false and vice versa), Events may be triggered. Events includes Actions such as sending of notifications, commands to systems or request to a webhook.

General Information

Name and Description

An Event has a Name and Description. The Name and Description allows you to describe the event or situation that the Expression detects, such that recipients of the Event's notification or Alarms knows exactly what happened and is able to react to it accordingly.

  • The Event's Name and Description is displayed in the Alarm Description on the Digital Twin.

Description can also be the default content of an Action. You can describe the event or situation once in the Description, and reuse the information in all the Actions of the Event.

Inputs

You can define Inputs tags in the Event. These Inputs tags are linked to values or tag of input data coming from the related Expression. By doing so, you can embed the Inputs in the Description. You can learn more on how to embed the Input in the Description as described here.

Example

Using our Smart Weighing Scale measurement from earlier, the general information for one simple Event can be as follows:

  • Name: Battery level low
  • Inputs: weighing_scale_id, current_battery_level
  • Description: Weighing scale $(weighing_scale_id) battery level is running low. Current battery level: $(current_battery_level)