Stream 5 - Alarm Management¶

Overview¶

Stream 5 messages handle alarm reporting and management.

Supported Messages¶

Message	Name	Direction	Description
S5F1	Alarm Report Send	E→H	Report alarm set/clear
S5F2	Alarm Report Acknowledge	H→E	Acknowledge alarm
S5F3	Enable/Disable Alarm Send	H→E	Enable/disable alarms
S5F4	Enable/Disable Alarm Acknowledge	E→H	Enable response
S5F5	List Alarms Request	H→E	Request alarm list
S5F6	List Alarm Data	E→H	Return alarm list
S5F7	List Enabled Alarms Request	H→E	Request enabled alarms
S5F8	List Enabled Alarms Data	E→H	Return enabled alarms

S5F1 - Alarm Report Send¶

Direction: E→H Reply: S5F2 W-Bit: Yes

Structure¶

S5F1 W
<L[3]
  <ALCD B[1]>        // Alarm code (category + set/clear)
  <ALID U4>          // Alarm ID
  <ALTX A>           // Alarm text
>

ALCD Bit Format¶

Bit 7	Bits 6-0
Set/Clear	Category

Bit 7 = 0: Alarm cleared
Bit 7 = 1: Alarm set
Bits 6-0: Alarm category (1-8)

ALCD Category Values¶

Value	Category
1	Personal Safety
2	Equipment Safety
3	Parameter Control Warning
4	Parameter Control Error
5	Irrecoverable Error
6	Equipment Status Warning
7	Attention Flags
8	Data Integrity

Example - Alarm Set¶

S5F1 W
<L[3]
  <B 0x86>           // Set + Category 6 (0x80 | 0x06)
  <U4 3001>
  <A "Process Error: Temperature out of range">
>

Example - Alarm Clear¶

S5F1 W
<L[3]
  <B 0x06>           // Clear + Category 6
  <U4 3001>
  <A "Process Error: Temperature out of range">
>

S5F2 - Alarm Report Acknowledge¶

Direction: H→E Reply Required: No

Structure¶

S5F2
<ACKC5 B[1]>

ACKC5 Values¶

Value	Description
0x00	Accepted

S5F3 - Enable/Disable Alarm Send¶

Direction: H→E Reply: S5F4 W-Bit: Yes

Structure¶

S5F3 W
<L[2]
  <ALED B[1]>        // 0=Disable, 1=Enable
  <ALID U4>          // Alarm ID (0 = all alarms)
>

Example - Enable Specific Alarm¶

S5F3 W
<L[2]
  <B 0x01>           // Enable
  <U4 3001>          // Alarm ID
>

Example - Disable All Alarms¶

S5F3 W
<L[2]
  <B 0x00>           // Disable
  <U4 0>             // All alarms
>

S5F4 - Enable/Disable Alarm Acknowledge¶

Direction: E→H Reply Required: No

Structure¶

S5F4
<ACKC5 B[1]>

ACKC5 Values¶

Value	Description
0x00	Accepted

S5F5 - List Alarms Request¶

Direction: H→E Reply: S5F6 W-Bit: Yes

Structure¶

S5F5 W
<L[n]
  <ALID U4>          // Alarm IDs to query (empty = all)
  ...
>

Example - Query All Alarms¶

S5F5 W
<L[0]>

Example - Query Specific Alarms¶

S5F5 W
<L[2]
  <U4 3001>
  <U4 3002>
>

S5F6 - List Alarm Data¶

Direction: E→H Reply Required: No

Structure¶

S5F6
<L[n]
  <L[3]
    <ALCD B[1]>      // Alarm code
    <ALID U4>        // Alarm ID
    <ALTX A>         // Alarm text
  >
  ...
>

Example¶

S5F6
<L[2]
  <L[3]
    <B 0x86>         // Set, Category 6
    <U4 3001>
    <A "Process Error: Temperature out of range">
  >
  <L[3]
    <B 0x02>         // Set, Category 2
    <U4 2001>
    <A "Equipment Safety: Interlock triggered">
  >
>

S5F7 - List Enabled Alarms Request¶

Direction: H→E Reply: S5F8 W-Bit: Yes

Structure¶

S5F7 W
<L[0]>

S5F8 - List Enabled Alarms Data¶

Direction: E→H Reply Required: No

Structure¶

S5F8
<L[n]
  <L[3]
    <ALCD B[1]>      // Alarm code
    <ALID U4>        // Alarm ID
    <ALTX A>         // Alarm text
  >
  ...
>

Returns only currently enabled alarms.

Alarm Reporting Sequence¶

Setting an Alarm¶

Equipment                    Host
    |                          |
    | S5F1 (ALCD=0x86)         |
    |------------------------->|
    |                          |
    |           S5F2 (ACKC5=0) |
    |<-------------------------|
    |                          |
    | S6F11 (AlarmSet event)   |
    |------------------------->|
    |                          |
    |               S6F12      |
    |<-------------------------|

Clearing an Alarm¶

Equipment                    Host
    |                          |
    | S5F1 (ALCD=0x06)         |
    |------------------------->|
    |                          |
    |           S5F2 (ACKC5=0) |
    |<-------------------------|
    |                          |
    | S6F11 (AlarmCleared)     |
    |------------------------->|
    |                          |
    |               S6F12      |
    |<-------------------------|