Company Events Academic Community Support Solutions Products & Services Contact NI MyNI

Configure Alarming VI

LabVIEW 2013 Datalogging and Supervisory Control Module Help

Edition Date: June 2013

Part Number: 371618J-01

»View Product Info
Download Help (Windows Only)

Owning Palette: Variables & I/O Servers VIs

Requires: DSC Module

Configures the alarm settings of a shared variable.

You first must enable alarming for a shared variable before you can configure alarm settings. You enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE. You must manually select the polymorphic instance to use.
Note  You can configure alarm settings of network-published shared variables only.

Use the pull-down menu to select an instance of this VI.

Configure Alarming (Shared Variable, Enable Alarming)

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
enable? specifies whether LabVIEW enables alarming for a shared variable. The default is FALSE.
reset when disabled? specifies whether to reset the values of all alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the values. If reset when disabled? is FALSE, LabVIEW retains the values. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

Configure Alarming (Shared Variable, Numeric)

Note Note  To use this VI, you first must enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE.

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
numeric alarm settings specifies the alarm settings of the numeric shared variable.
enable? specifies whether LabVIEW enables the alarm that the alarm type specifies for the shared variable. The default is FALSE.
name specifies the name of the alarm.
alarm type specifies the alarm type for this shared variable.

0HI_HI (default)
1HI
2LO
3LO_LO
level/change specifies the level of the numeric alarm. The default is 90. The alarm level is the value, in engineering units, that evokes the alarm condition. The level values of the numeric alarms conform to the following rule: HI_HI level>HI level>LO level>LO_LO level. The shared variable remains in the alarm state until the shared variable value goes below the level/change value minus the deadband/time value.
deadband/time specifies the deadband, in percentage of the full scale range, of the numeric alarm. The default is 1. The Share Variable Engine (SVE) clears an active alarm if the percentage difference between the new value and the previous value equals or exceeds the deadband. If you set this input too high, the SVE might not clear the alarm.
priority specifies the priority of the alarm. Enter a value between 1 and 1000, where 1000 is the highest priority. The default is 1.
ack type specifies how LabVIEW acknowledges alarms.
Note  If you specify Each Occurrence for ack type, LabVIEW may generate a large number of alarm instances before you acknowledge them.


0Auto (default)—Specifies that LabVIEW acknowledges an alarm when the shared variable value returns to a normal state.
1User—Specifies LabVIEW does not acknowledge an alarm until you acknowledge the alarm regardless of the alarm state. LabVIEW does not generate any new alarm instance before you acknowledge the existing alarm instance.
2None (obsolete)
3Each Occurrence—Specifies that LabVIEW does not acknowledge an alarm until you acknowledge the alarm. LabVIEW generates a new alarm instance whenever the alarm changes from a normal state to an abnormal state.
area specifies the name of the alarm area that this alarm belongs to.
description specifies the description of the alarm.
log? specifies whether LabVIEW enables alarm logging for the alarm. The default is TRUE.
reset when disabled? specifies whether to reset the value of numeric alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the value. If reset when disabled? is FALSE, LabVIEW retains the value. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

Configure Alarming (Shared Variable, Boolean)

Note Note  To use this VI, you first must enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE.

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
Boolean alarm settings specifies the alarm settings of the Boolean shared variable.
enable? specifies whether LabVIEW enables the alarm of the shared variable. The default is FALSE.
name specifies the name of the alarm.
alarm on specifies the alarm criteria of the alarm. If you set this input to TRUE, the Boolean shared variable is in alarm state when the value is TRUE. Otherwise, the Boolean shared variable is in alarm state when the value is FALSE. The default is TRUE.
priority specifies the priority of the alarm. Enter a value between 1 and 1000, where 1000 is the highest priority. The default is 1.
ack type specifies how LabVIEW acknowledges alarms.
Note  If you specify Each Occurrence for ack type, LabVIEW may generate a large number of alarm instances before you acknowledge them.


0Auto (default)—Specifies that LabVIEW acknowledges an alarm when the shared variable value returns to a normal state.
1User—Specifies LabVIEW does not acknowledge an alarm until you acknowledge the alarm regardless of the alarm state. LabVIEW does not generate any new alarm instance before you acknowledge the existing alarm instance.
2None (obsolete)
3Each Occurrence—Specifies that LabVIEW does not acknowledge an alarm until you acknowledge the alarm. LabVIEW generates a new alarm instance whenever the alarm changes from a normal state to an abnormal state.
area specifies the name of the alarm area that this alarm belongs to.
description specifies the description of the alarm.
log? specifies whether LabVIEW enables alarm logging for the alarm. The default is TRUE.
reset when disabled? specifies whether to reset the value of Boolean alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the value. If reset when disabled? is FALSE, LabVIEW retains the value. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

Configure Alarming (Shared Variable, Bit Array)

Note Note  To use this VI, you first must enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE.

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
bit array alarm settings specifies the alarm settings for the bit array shared variable.
enable? specifies whether LabVIEW enables the alarm of the shared variable. The default is FALSE.
name specifies the name of the alarm.
invert specifies which bits evoke an alarm on high, 1, and which bits evoke an alarm on low, 0. Enter the value 1 if you want that bit to evoke an alarm when low. In bitwise terminology, the Shared Variable Engine (SVE) performs an XOR with the invert value to produce the alarm state. LabVIEW applies the invert value to the scaled value after applying any relevant scaling masks.
mask specifies the bits that LabVIEW uses to calculate the alarm for the shared variable. LabVIEW uses bits with a mask value 1 in the alarm calculation. Bits with a mask value 0 do not evoke an alarm, regardless of the values of the bits. In bitwise terminology, the SVE performs an AND with the mask value to produce the alarm state. LabVIEW applies the mask value to the scaled value after applying any relevant scaling masks.
alarm on specifies the alarm criteria of the U32 bit field shared variable.

0All—Specifies that the U32 bit field shared variable is in alarm state only when all bits meet the alarm criteria.
1Any (default)—Specifies that the U32 bit field shared variable is in alarm state when any bit meets the alarm criteria.
priority specifies the priority of the alarm. Enter a value between 1 and 1000, where 1000 is the highest priority. The default is 1.
ack type specifies how LabVIEW acknowledges alarms.
Note  If you specify Each Occurrence for ack type, LabVIEW may generate a large number of alarm instances before you acknowledge them.


0Auto (default)—Specifies that LabVIEW acknowledges an alarm when the shared variable value returns to a normal state.
1User—Specifies LabVIEW does not acknowledge an alarm until you acknowledge the alarm regardless of the alarm state. LabVIEW does not generate any new alarm instance before you acknowledge the existing alarm instance.
2None (obsolete)
3Each Occurrence—Specifies that LabVIEW does not acknowledge an alarm until you acknowledge the alarm. LabVIEW generates a new alarm instance whenever the alarm changes from a normal state to an abnormal state.
area specifies the name of the alarm area that this alarm belongs to.
description specifies the description of the alarm.
log? specifies whether LabVIEW enables alarm logging for the alarm. The default is TRUE.
reset when disabled? specifies whether to reset the value of bit array alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the value. If reset when disabled? is FALSE, LabVIEW retains the value. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

Configure Alarming (Shared Variable, Bad Status)

Note Note  To use this VI, you first must enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE.

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
bad status alarm settings specifies the bad status alarm settings of the shared variable.
enable? specifies whether LabVIEW enables the alarm of the shared variable. The default is FALSE.
name specifies the name of the alarm.
priority specifies the priority of the alarm. Enter a value between 1 and 1000, where 1000 is the highest priority. The default is 1.
ack type specifies how LabVIEW acknowledges alarms.
Note  If you specify Each Occurrence for ack type, LabVIEW may generate a large number of alarm instances before you acknowledge them.


0Auto (default)—Specifies that LabVIEW acknowledges an alarm when the shared variable value returns to a normal state.
1User—Specifies LabVIEW does not acknowledge an alarm until you acknowledge the alarm regardless of the alarm state. LabVIEW does not generate any new alarm instance before you acknowledge the existing alarm instance.
2None (obsolete)
3Each Occurrence—Specifies that LabVIEW does not acknowledge an alarm until you acknowledge the alarm. LabVIEW generates a new alarm instance whenever the alarm changes from a normal state to an abnormal state.
area specifies the name of the alarm area that this alarm belongs to.
description specifies the description of the alarm.
log? specifies whether LabVIEW enables alarm logging for the alarm. The default is TRUE.
reset when disabled? specifies whether to reset the value of bad status alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the values. If reset when disabled? is FALSE, LabVIEW retains the values. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

Configure Alarming (Shared Variable, Rate of Change)

Note Note  To use this VI, you first must enable alarming by setting the enable? input in the Configure Alarming (Shared Variable, Enable Alarming) VI to TRUE.

variable reference in specifies a reference number for a shared variable. Use the Create Shared Variable VI to create a refnum for a shared variable.
rate of change alarm settings specifies the rate of change alarm settings of the shared variable.
enable? specifies whether LabVIEW enables the alarm of the shared variable. The default is FALSE.
name specifies the name of the alarm.
level/change specifies the change of the rate of change alarm. The alarm change is the value that the shared variable value must change in the specified deadband/time to go into an alarm state. The default is 1.
deadband/time specifies the time of the rate of change alarm. The time is the amount of time, in milliseconds, in which the shared variable value must change at least the value of level/change to go into an alarm state. The default is 1.
priority specifies the priority of the alarm. Enter a value between 1 and 1000, where 1000 is the highest priority. The default is 1.
ack type specifies how LabVIEW acknowledges alarms.
Note  If you specify Each Occurrence for ack type, LabVIEW may generate a large number of alarm instances before you acknowledge them.


0Auto (default)—Specifies that LabVIEW acknowledges an alarm when the shared variable value returns to a normal state.
1User—Specifies LabVIEW does not acknowledge an alarm until you acknowledge the alarm regardless of the alarm state. LabVIEW does not generate any new alarm instance before you acknowledge the existing alarm instance.
2None (obsolete)
3Each Occurrence—Specifies that LabVIEW does not acknowledge an alarm until you acknowledge the alarm. LabVIEW generates a new alarm instance whenever the alarm changes from a normal state to an abnormal state.
area specifies the name of the alarm area that this alarm belongs to.
description specifies the description of the alarm.
log? specifies whether LabVIEW enables alarm logging for the alarm. The default is TRUE.
reset when disabled? specifies whether to reset the value of rate of change alarm settings to the initial state when you disable alarming. If reset when disabled? is TRUE, LabVIEW resets the value. If reset when disabled? is FALSE, LabVIEW retains the value. The default is FALSE.
error in describes error conditions that occur before this node runs. This input provides standard error in functionality.
variable reference out returns the shared variable refnum that you wire to the variable reference in input.
error out contains error information. This output provides standard error out functionality.

 

Your Feedback! poor Poor  |  Excellent excellent   Yes No
 Document Quality? 
 Answered Your Question? 
Add Comments 1 2 3 4 5 submit