7.19 BACnetEventEnrollmentType
7.19.1 General
This OPC UA ObjectType represents a status, error, and event reporting configuration for a BACnet device.
Figure 28 shows an overview for the BACnetEventEnrollmentType with its Properties and related ObjectTypes. It is formally defined in Table 35.
7.19.2 ObjectType definition
The BACnetEventEnrollmentType ObjectType is formally defined in Table 35.
| Attribute | Value | |||||
| BrowseName | BACnetEventEnrollmentType | |||||
| IsAbstract | False | |||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | Other | |
|---|---|---|---|---|---|---|
| Subtype of the BACnetObjectType defined in 7.1. | ||||||
| 0:HasProperty | Variable | Event_State | BACnetEventState | 0:PropertyType | M | |
| 0:HasProperty | Variable | Status_Flags | BACnetStatusFlags | 0:PropertyType | M | |
| 0:HasProperty | Variable | Event_Type | BACnetEventType | 0:PropertyType | M | |
| 0:HasComponent | Method | SetEventAlgorithm | M | |||
| 0:HasProperty | Variable | Object_Property_Reference | BACnetDeviceObjectPropertyReference | 0:PropertyType | M | |
| 0:HasProperty | Variable | Fault_Type | BACnetFaultType | 0:PropertyType | M | |
| 0:HasComponent | Method | SetFaultAlgorithm | O | |||
| 0:HasComponent | Object | FaultEvaluation | BACnetFaultEvaluation Type | M | ||
| 0:HasComponent | Object | EventReporting | BACnetEventReportingType | M | ||
The BACnetEventEnrollmentType ObjectType is a concrete type and can be used directly.
7.19.3 ObjectType Description
7.19.3.1 Variable Status_Flags
This OPC UA Variable, of DataType BACnetStatusFlags, represents the BACnet property Status_Flags. The BACnetStatusFlags DataType is defined in 10.3.7.
It represents four 0:Boolean flags that represent the general health of an analog input. The flags are IN_ALARM, FAULT, OVERRIDDEN, and OUT_OF_SERVICE.
7.19.3.2 Variable Event_Type
This OPC UA Property, of DataType BACnetEventType, represents the BACnet property Event_Type. The BACnetEventType DataType is defined in 10.4.12.
The value of this Variable is an enumeration that indicates the type of event algorithm that is to be used to detect the occurance of events and the event value notification parameters that are conveyed in event notifications.
7.19.3.3 Method SetEventAlgorithm
This Method sets the event algorithm for the EventReporting Object.
Signature
SetEventAlgorithm (
[in] BACnetEventParameter EventParameters
);
| Argument | Description |
| EventParameters | The new event algorithm. The BACnetEventParameter DataType is defined in 10.6.4. |
Method Result Codes
| ResultCode | Description |
| BadNodeIdUnknown | This status is returned for the BACnet error codes UNKNOWN_OBJECT and UNKNOWN_PROPERTY |
| BadTypeMismatch | This status is returned for the BACnet error codes INVALID_DATATYPE and DATATYPE_NOT_SUPPORTED |
| BadOutOfRange | This status is returned for the BACnet error code VALUE_OUT_OF_RANGE |
| BadNotWritable | This status is returned for the BACnet error code WRITE_ACCESS_DENIED |
7.19.3.4 Variable Object_Property_Reference
This OPC UA Property, of DataType BACnetDeviceObjectPropertyReference, represents the BACnet property Object_Property_Reference. The BACnetDeviceObjectProperty Reference DataType is defined in 10.5.9.
It indicates the object and property that is referenced by the event enrollement object. The event algorithm specified by the Event_Type property is applied to the referenced property in order to determine the Event_State of the event.
7.19.3.5 Variable Fault_Type
This OPC UA Property, of DataType BACnetFaultType, represents the BACnet property Fault_Type. The BACnetFaultType DataType is defined in 10.4.13.
It is an enumeration (NONE, FAULT_CHARACTERSTRING, FAULT_EXTENDED, and so on) that indicates the type of fault algorithm that is applied by the event enrollment object.
7.19.3.6 Method SetFaultAlgorithm
This Method sets the fault algorithm for the FaultEvaluation Object.
Signature
SetFaultAlgorithm (
[in] BACnetFaultParameter FaultParameters
);
| Argument | Description |
| FaultParameters | The new event algorithm. The BACnetFaultParameter DataType is defined in 10.6.4. |
Method Result Codes
| ResultCode | Description |
| BadNodeIdUnknown | This status is returned for the BACnet error codes UNKNOWN_OBJECT and UNKNOWN_PROPERTY |
| BadTypeMismatch | This status is returned for the BACnet error codes INVALID_DATATYPE and DATATYPE_NOT_SUPPORTED |
| BadOutOfRange | This status is returned for the BACnet error code VALUE_OUT_OF_RANGE |
| BadNotWritable | This status is returned for the BACnet error code WRITE_ACCESS_DENIED |
7.19.3.7 Object FaultEvaluation
The FaultEvaluation Object contains status and configuration information for the fault evaluation of the BACnetEventEnrollmentType. The BACnetFaultEvaluationType is defined in 8.23. The Object is optional and is not present if fault evaluation is not activated for the BACnet object.
7.19.3.8 Object EventReporting
The EventReporting Object contains status and configuration information for the event reporting of BACnetEventEnrollmentType Objects. The BACnetEventReportingType is defined in 0. The Object is optional and is not present if event generation is not activated for the BACnet object.