Skip to main content

Parameter - Alarm / Event

When users want to configure alarms for a parameter, they can use the Alarm/Event function in the Parameter UI interface to configure. EdgeHub currently provides three types of alarms for use:

  • Range Alarm
    • Supported data type:
      • Number
  • Complex Alarm
    • Supported data type:
      • Number
      • Discrete
  • AlarmCode Alarm
    • Supported data type:
      • Number
      • Discrete
      • String

1. Range Alarm​

  1. Go to Edit Parameter interface. Select the parameter that you want to add the alarm setting on it , and click the Alarm/event tab. parameter-alarm-1-01.png

  2. Select Range type parameter-alarm-1-02.png

  3. Fill up Basic information, includes:

  • Alarm Description
  • Dead band (Only need to be set when data type = Number)
    • An Alarm Deadband helps to eliminate nuisance alarms caused by a parameter’s value wandering above and below the alarm limit.
    • A parameter will enter an alarm condition only when the parameter’s value exceeds the alarm limit set in alarm rule. However, the parameter will NOT go OUT of alarm until the parameter’s value exceeds the deadband.
  • Dead band type (Only need to be set when data type = Number)
    • Absolute
      • The value of Dead band is an absolute number.
    • Percentage
      • The value of Dead band is a percentage of (span high - span low)
  • Delay time (second)
    • Once the parameter value match an alarm rule, only when the state persist above than delay time, the alarm can be triggered.
  • Restore delay time (second)
    • Once the parameter value back to normal, only when the state persist above than restore delay time, the alarm can be restored.

parameter-alarm-1-03.png

  1. Fill up Rule settings. For Range alarm, you can specify the rules named "HH", "H", "L" or "LL"

  • Value

    • Value of HH should be greater than H
    • Value of LL should be less than L
    • Value of HH and H should be greater than LL and L

  • Alarm level

    • Level of a alarm rule
    • Will be used as a condition to trigger the notification
      • Only when the parameter first reach the alarm rule, or reach a higher level of alarm rule, the notification will be triggered.

  • Alarm category

    • Category of a alarm rule
    • Ene Alarm Panel can use this setting to display different catrgories of alarms on the Panel

  • Alarm message

    • Description of this alarm rule

parameter-alarm-1-04.png

  1. Click Submit to save the Range alarm setting

parameter-alarm-1-05.png

2. Complex Alarm​

  1. Go to Edit Parameter interface. Select the parameter that you want to add the alarm setting on it , and click the Alarm/event tab. parameter-alarm-2-01.png

  2. Select Complex type parameter-alarm-2-02.png

  3. Fill up Basic information, includes:

  • Alarm Description
  • Dead band (Only need to be set when data type = Number)
    • An Alarm Deadband helps to eliminate nuisance alarms caused by a parameter’s value wandering above and below the alarm limit.
    • A parameter will enter an alarm condition only when the parameter’s value exceeds the alarm limit set in alarm rule. However, the parameter will NOT go OUT of alarm until the parameter’s value exceeds the deadband.
  • Dead band type (Only need to be set when data type = Number)
    • Absolute
      • The value of Dead band is an absolute number.
    • Percentage
      • The value of Dead band is a percentage of (span high - span low)
  • Delay time (second)
    • Once the parameter value match an alarm rule, only when the state persist above than delay time, the alarm can be triggered.
  • Restore delay time (second)
    • Once the parameter value back to normal, only when the state persist above than restore delay time, the alarm can be restored.

parameter-alarm-2-03.png

  1. In Rule settings, press + to add a rule
  2. Fill up rules. For Complex alarm, you can specify a range of data value as the alarm range within a rule. The rule settings include:

  • Rule name

  • Rule 1

    • the rule to trigger alarm

  • Rule 2 (Optional)

    • second rule to trigger alarm, together with rule 1 to form an alarm range

  • Alarm level

    • Level of a alarm rule
    • Will be used as a condition to trigger the notification
      • Only when the parameter first reach the alarm rule, or reach a higher level of alarm rule, the notification will be triggered.

  • Alarm category

    • Category of a alarm rule
    • Ene Alarm Panel can use this setting to display different catrgories of alarms on the Panel

  • Alarm message

    • Description of this alarm rule

parameter-alarm-2-04.png

  1. Click Submit to save the Complex alarm setting parameter-alarm-2-05.png

3. AlarmCode Alarm​

  1. Prepare to upload Alarm code file For an assert which has its own alarm code settings, EdgeHub allow it to upload an Alarm code definition file as the reference of AlarmCode Alarm. Please go to edit an Object and find Alarm code file in Step1: object information

  2. Click + of Alarm code file parameter-alarm-3-01.png

  3. Download the template of Alarm code file parameter-alarm-3-02.png

  4. You should get an alarm_code_template.xlsx file, open it by Excel and edit the code rules. The rule settings include:

  • AlarmCode
    • The code value that you want to match the parameter value
  • Category
    • Category of a alarm rule, must be defined in Alarm category settings of EdgeHub.
  • Level
    • Level of a alarm rule, must be defined in Alarm level settings of EdgeHub.
  • AlarmMsg_zh_tw
    • Description of this alarm code with traditional Chinese translation.
  • AlarmMsg_zh_cn
    • Description of this alarm code with simplified Chinese translation.
  • AlarmMsg_zh_en
    • Description of this alarm code with English translation.
  • AlarmMsg_zh_ja
    • Description of this alarm code with Japanese translation.

parameter-alarm-3-03.png

  1. Upload the Alarm code file Drag your Alarm code file and drop it into upload area. parameter-alarm-3-04.png

  2. Upload Completed parameter-alarm-3-05.png

  3. Submit to save the object parameter-alarm-3-06.png

  4. Go to Edit Parameter interface. Select the parameter that you want to add the alarm setting on it , and click the Alarm/event tab. parameter-alarm-3-07.png

  5. Select Alarm code type parameter-alarm-3-08.png

  6. Fill up Basic information, includes:

  • Alarm Description
  • Dead band (Only need to be set when data type = Number)
    • An Alarm Deadband helps to eliminate nuisance alarms caused by a parameter’s value wandering above and below the alarm limit.
    • A parameter will enter an alarm condition only when the parameter’s value exceeds the alarm limit set in alarm rule. However, the parameter will NOT go OUT of alarm until the parameter’s value exceeds the deadband.
  • Dead band type (Only need to be set when data type = Number)
    • Absolute
      • The value of Dead band is an absolute number.
    • Percentage
      • The value of Dead band is a percentage of (span high - span low)
  • Delay time (second)
    • Once the parameter value match an alarm rule, only when the state persist above than delay time, the alarm can be triggered.
  • Restore delay time (second)
    • Once the parameter value back to normal, only when the state persist above than restore delay time, the alarm can be restored.

  1. In Rule list, press + to add a rule, you can see the defined code shown on the right side drawer. parameter-alarm-3-09.png

  2. Select the code that you want to set as the rule, and click Submit parameter-alarm-3-10.png

  3. The codes have been added into rule list. parameter-alarm-3-11.png

  4. Click Submit to save the Alarm code alarm setting
    parameter-alarm-3-12.png

tags: EdgeHub​

On this page ...

Is this helpful?