Event Enrollment object (EvtEnr)

The Event Enrollment (EvtEnr) object type defines a standardized object that represents and contains information required for managing events within BACnet systems. Events are changes of value of any property of any object that meet certain predetermined criteria. The primary purpose for Event Enrollment objects is to define an event and to provide a connection between the occurrence of an event and the transmission of a notification message to one or more recipients. The EvtEnr object properties are:

✳ Indicates a Siemens proprietary property.

Event enable
'Event enable' enables or disables specific event notification functionality (i.e. during engineering/configuration).
To-Offnormal	Allows TO-OFFNORMAL event notification functionality to be enabled and disabled.
To-Fault	Allows TO-FAULT event notification functionality to be enabled and disabled.
To-Normal	Allows TO-NORMAL event notification functionality to be enabled and disabled.

Enable event detection
"Enable event detection" allows to enable or disable event notifications of the corresponding object at engineering time. When "Enable event detection" is false, the internal algorithm of the object does not perform. Therefore, event notifications are not issued, and the dynamic properties of the object do not update.

Suppress event detection
"Suppress event detection" is a writeable property allowing event detection functionality to be temporarily enabled and disabled for the object instance at runtime.

Suppress event notification ✳
"Suppress event notification" is a writeable property allowing event notification functionality to be temporarily enabled or disabled for the object instance at runtime.

Object property reference
"Object property reference" specifies the BA-Object property that provides the test value for a specific object instance.

Event parameters
"Event parameters" determines the algorithm used to monitor the referenced object and provides the parameter values needed for this algorithm. See ABT Pro: Configuring alarms , Defining alarms
Name	Value	Description
BA_EventParameter_Type	Change of bitstring
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
Bitmask In alarm Fault Overridden Out of service	False, True False, True False, True False, True
BitstringList In alarm Fault Overridden Out of service	0..5 False, True False, True False, True False, True

BA_EventParameter_Type	Change of state	Alarm, if a certain value of a state occurs. Used for: - Device alarms (system alarms) - Value alarms (BI, Multistate)
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
StateList	0..5	Number of different states to monitor. 0=none, inactive
BA_PropertyStates_Type boolean-value	Boolean value	Monitors enumeration False and True.
BA_PropertyStates_Type boolean-value	False, True	Alarm, if False or True occurs.
BA_PropertyStates_Type binary-value	Binary value	Monitors enumeration Inactive and Active.
BA_PropertyStates_Type binary-value	Inactive, Active	Alarm, if Inactive or Active occurs.
BA_PropertyStates_Type reliability	Reliability	Monitors enumeration of Error code.
BA_PropertyStates_Type reliability	No fault detected, ..	Alarm, if another error code than No fault detected occurs.
BA_PropertyStates_Type system-status	System status	Monitors enumeration of system status.
BA_PropertyStates_Type system-status	Operational, ..	Alarm, if the defined system status occurs.
BA_PropertyStates_Type unsigned-value	Unsigned value	Monitors multistate values. Note: BACnet enumerations start with the value 1. Desigo enumerations start with the value 0.
BA_PropertyStates_Type unsigned-value	0..65535	Alarm, if the defined value occurs.

BA_EventParameter_Type	Command failure
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
FbPrpRef ObjIDRef PrpId ArrayIdx DevIDRef	Unassigned Present value 65535 Unassigned	…..
BitstringList In alarm Fault Overridden Out of service	0..5 False, True False, True False, True False, True

BA_EventParameter_Type	Floating limit
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
SetpointReference ObjIDRef PrpId ArrayIdx DevIDRef	Unassigned Present value 65535 Unassigned	…..
LowDiffLimit HighDiffLimit Nz	0..xxxx 0..xxxx 0..xxxx

BA_EventParameter_Type	Out of range	Alarm, if Lo/Hi-limit exceeded. Used for: - Temperature setpoint (AI) - Overheating (AI)
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
LoLm	-3.4 E38..3.4 E38	Alarm, if Real value < Lo-limit.
HiLm	-3.4 E38..3.4 E38	Alarm, if Real value > Hi-limit.
Nz	0..1000	- Low limit alarm, if Real value < LoLm -The Low limit alarm is deactivated if Real value > LoLm+Nz - High limit alarm, if Real value > HiLm -The High limit alarm is deactivated if Real value < HiLm-Nz

BA_EventParameter_Type	Unsigned range	Alarm, if Lo/Hi-limit exceeded. Used for: - value alarms (BI, Multistate) Note: BACnet enumerations start with the value 1. Desigo enumerations start with the value 0.
TimeDelay	0..3600 s	Minimal duration of the alarm until it is notified by the system.
LoLm	0..4294967295	Alarm, if Binary value < Lo-limit.
HiLm	0..4294967295	Alarm, if Binary value > Hi-limit.

Configurable event message texts
"Configurable event message texts" consists of a set of three writable character strings, one for each state transition (TO-OFFNORMAL, TO-FAULT, and TO-NORMAL). These strings will be used as all or part of the message text parameter passed in event notifications.

Event message texts
"Event message texts" consists of a set of three writable character strings, one for each state transition (TO-OFFNORMAL, TO-FAULT, and TO-NORMAL). These strings will be used as all or part of the message text parameter passed in event notifications.

State flag ✳
"State flag" represents four boolean flags ("Out of service", "Overridden", "Fault", "In-Alarm") that indicate the general status of an object.

Reliability
'Reliability' indicates whether the property value 'Present value' is reliable. If the 'Present value' is not reliable, the property 'Reliability' indicates the cause of the fault and the bit "Fault" of the state indication is set to 'True'. In a normal case, the property 'Reliability' is set to "No fault".
Property ID: 103

Notification type
"Notification type" conveys whether the notifications generated by the object should be of type "Event" or "Alarm".

Notification class
"Notification class" holds a reference to a "Notification class object", and indicates which "Notification class object" to use when generating notifications for this object.

Monitoring time deviation to normal ✳
"Monitoring time deviation to normal" specifies the minimum period of time (in seconds) between the detection of a system alarm (fault) condition and the transition into the system alarm state.

Event type
"Event type" indicates the event detection algorithm used by the BA-Event-Enrollment object. The algorithm is chosen by the Event-Parameters property.

Configured event enable ✳
"Configured event enable" is a Bitstring value consisting of the following three binary flags:
To-Offnormal	Allows TO-OFFNORMAL event notification functionality to be enabled and disabled for the object instance. Since BA-Device-Alert objects issue only TO-NORMAL notifications, setting this flag to true has no effect.
To-Fault	Allows TO-FAULT event notification functionality to be enabled and disabled for the object instance. Since BA-Device-Alert objects issue only TO-NORMAL notifications, setting this flag to true has no effect.
To-Normal	Allows TO-NORMAL event notification functionality to be enabled and disabled for the object instance.

Event state
"Event state" provides a way to determine if this object has an active event state associated with it. The "Event state" property indicates the event state of the object. Changes in the "Event state" property to the value FAULT are considered to be fault events. If the object does not support intrinsic reporting, then the value of this property is NORMAL.
Property-ID: 36

Time stamp of event
"Time stamp of event" conveys the times of the last event notifications for TO-OFFNORMAL, TO-FAULT, and TO-NORMAL events, respectively.

Acknowledged transitions
"Acknowledged transitions" conveys three flags that separately indicate the receipt of acknowledgments for TO-OFFNORMAL, TO-FAULT and TO-NORMAL events. These flags is cleared upon the occurrence of the corresponding event and set under any of these conditions: Upon receipt of the corresponding acknowledgment; Upon the occurrence of the event if the corresponding flag is not set in the "Event enable" property (meaning event notifications will not be generated for this condition and thus no acknowledgment is expected); Upon the occurrence of the event if the corresponding flag is set in the "Event enable" property and the corresponding flag in the "Acknowledgement required" property of the "Notification class" object implicitly referenced by the "Notification class" property of this object is not set (meaning no acknowledgment is expected).

Acknowledged transitions

"Acknowledged transitions" conveys three flags that separately indicate the receipt of acknowledgments for TO-OFFNORMAL, TO-FAULT and TO-NORMAL events. These flags is cleared upon the occurrence of the corresponding event and set under any of these conditions:

Upon receipt of the corresponding acknowledgment;
Upon the occurrence of the event if the corresponding flag is not set in the "Event enable" property (meaning event notifications will not be generated for this condition and thus no acknowledgment is expected);
Upon the occurrence of the event if the corresponding flag is set in the "Event enable" property and the corresponding flag in the "Acknowledgement required" property of the "Notification class" object implicitly referenced by the "Notification class" property of this object is not set (meaning no acknowledgment is expected).

Time of acknowledgement ✳
"Time of acknowledgement" indicates the times of the last event acknowledgments for TO-OFFNORMAL, TO-FAULT, and TO-NORMAL events, respectively.

Acknowledgement credentials
"Acknowledgement credentials" consisting of three character strings identifying the user or process that acknowledged the most recent TO-OFFNORMAL, TO-FAULT, and TO-NORMAL event notifications.

Object access level ✳
"Object access level" defines the instance-specific object access level. "Object access level" is used for generic filtering and processing an object by a client application. "Object access level" is a configuration property which can only be set up offline (ABT, application configuration). "Object access level" is evaluated by client applications such as Technical Operator, DB-Import, and APOGEE Point Team mapping.
Access level	Name	Description
7	Basic operation	Access to BACnet objects and properties for a room user e.g. data points visible on a room unit.
6	Standard operation	Access to BACnet objects and properties for standard operation and monitoring (daily business), .e.g. room and plant information on a management station.
5	Extended operation	Access to BACnet objects and properties for extended operation and monitoring such as network and device objects. All I/Os are visible
4	Administrator	Not used by HQ solutions yet.
3	Basic service	Access to BACnet objects and properties used for commissioning, e.g. configuration value extensions, I/O extensions, etc.
2	Extended service	Not used by HQ solutions yet.
1	Internal	Access to all BACnet objects and properties for very specialized actions e.g. during development.

Object usage ✳
"Object usage" indicates whether the object is used or unused. The "Object usage" property can hide or display respective objects and their functionality in a client. For example, room functionality can be marked for flexible room arrangements as used/unused. An object that is marked as unused behaves as if the object does not exist.
Property ID: 4930

Description
"Description" is a string of printable characters whose content is not restricted.

Object name
"Object name" represents a name for the object that is unique internetwork-wide. The minimum length of the string is one character. The set of characters used in the "Object name" are restricted to printable characters.

Object identifier
"Object identifier" is a numeric code that is used to identify the object. It must be unique internetwork-wide.

Object name
"Object name" represents a name for the object that is unique internetwork-wide. The minimum length of the string is one character. The set of characters used in the "Object name" are restricted to printable characters.

Object type
"Object type " indicates membership in a particular object type class. E.g. "Analog input", "Binary output", "Event enrollment", "Trend log", etc.

Building automation profile ✳
"Building automation profile" is an enumeration that indicates a particular type of Siemens proprietary object. Siemens objects are based on standard BACnet objects. For example, Siemens Analog Input, Analog Output, Analog Calculated Value, and Analog Configuration Value are based on standard Analog Input, Analog Output, and Analog Value BACnet objects.

Profile name
"Profile name" indicates the name of an object profile to which this object conforms. To ensure uniqueness, a profile name must begin with a vendor identifier code followed by a dash. All subsequent characters are administered by the organization registered with that vendor identifier code. The vendor identifier code that prefixes the profile name indicates the organization that publishes and maintains the profile document named by the remainder of the profile name.

Comment
A string of printable characters whose content is not restricted. (property is only used in ABT Pro)

Version
Version of a copied object (copied from a library). (property is only used in ABT Pro)

Library reference
Source of a copied object (copied from a library). (property is only used in ABT Pro)