The BACnetTimeManagementType is formally defined in Table 46.

Table 46 – BACnetTimeManagementType Definition

Attribute

Value

BrowseName

BACnetTimeManagementType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Local_Date

BACnetDate

0:PropertyType

O

0:HasProperty

Variable

Local_Time

BACnetTime

0:PropertyType

O

0:HasProperty

Variable

UTC_Offset

0:Int16

0:PropertyType

O

0:HasProperty

Variable

Daylight_Savings_Status

0:Boolean

0:PropertyType

O

0:HasComponent

Method

TimeSynchronization

O

The BACnetTimeManagementType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetTime, represents the BACnet property Local_Date. The BACnetTime DataType is defined in 10.5.32.

The Local_Date shall indicate the current date. When unable to track the date, the value of the variable shall be initialized to a date on or before January 1, 1990.

This OPC UA Property, of DataType BACnetDate, represents the BACnet property Local_Time. The BACnetDate DataType is defined in 10.5.6.

The Local_Time shall indicate the current local time. When unable to track the time, the value of the variable shall be initialized to the time 00:00:00.00.

This OPC UA Property, of DataType Int16, represents the BACnet property UTC_Offset.

The UTC_Offset shall indicate the number of minutes (-780 to 780) offset between local standard time and Universal Time Coordinated (UTC). The time zones to the west of the zero degree meridian shall be positive, and the time zones to the east of the zero degree meridian shall be negative.

This OPC UA Property, of DataType Boolean, represents the BACnet property Daylight_Savings_Status.

When the Daylight_Savings_Status variable value is true, daylight savings time is in effect at the BACnet device’s location.

This Method is used to update the time of a BACnet device. See B.3 for more details.

Signature

TimeSynchronization (

[in]UtcTimeTime

);

Argument

Description

Time

The UTC time used to update the time of the BACnet device.

Method Result Codes

ResultCode

Description

Common StatusCodes defined in OPC 10000-4

The BACnetAutomaticTimeSynchronizationMasterType is formally defined in Table 47.

Table 47 – BACnetAutomaticTimeSynchronizationMasterType Definition

Attribute

Value

BrowseName

BACnetAutomaticTimeSynchronizationMasterType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetTimeManagementType defined in 8.1.1

0:HasProperty

Variable

Time_Synchronization_Recipients

BACnetRecipient[]

0:PropertyType

O

0:HasProperty

Variable

UTC_Time_Synchronization_Recipients

BACnetRecipient[]

0:PropertyType

O

0:HasProperty

Variable

Time_Synchronization_Interval

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

Align_Intervals

0:Boolean

0:PropertyType

M

0:HasProperty

Variable

Interval_Offset

0:UInteger

0:PropertyType

M

0:HasComponent

Method

AddTimeSynchronizationRecipients

M

0:HasComponent

Method

RemoveTimeSynchronization Recipients

M

The BACnetTimeManagementType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetRecipient [], represents the BACnet property Time_Synchronization_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

The Time_Synchronization_Recipients value contains a list of devices that the BACnet device may send time synchronizations to. When the list is empty, the device performs no time synchronization.

This OPC UA Property, of DataType BACnetRecipient [], represents the BACnet property UTC_Time_Synchronization_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

The UTC_Time_Synchronization_Recipients value contains a list of devices that the BACnet device may send UTC time synchronizations to. When the list is empty, the device performs no UTC time synchronization.

This OPC UA Property, of DataType UInteger, represents the BACnet property Time_Synchronization_Interval.

The Time_Synchronization_Interval specifies the periodic interval in minutes at which local and/or UTC time synchronization requests shall be sent. If the variable value is zero, then all time synchronization shall be disabled.

This OPC UA Property, of DataType Boolean, represents the BACnet property Align_Intervals.

The Align_Intervals indicates whether clock-aligned periodic logging shall be enabled. When clock-aligned periodic logging is enabled, and the Log_Interval is a factor of an hour, or day, then the beginning of the priod specified for time synchronization shall align with the next clock hour, or dayAlign_Intervals.

This OPC UA Property, of DataType UInteger, represents the BACnet property Interval_Offset.

The Interval_Offset value indicates an offset in minutes from the period specified for time synchronization and the time that the synchronization requests are actually sent. The value used shall be the Interval_Offset modulo the value of Time_Synchronization_Interval. For example, if the Time_Synchronization_Interval is 30 and the Interval_Offset is 31, then the offset shall be 1.

This Method adds entries to the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients.

Signature

AddTimeSynchronizationRecipients (

[in]0:Boolean AddToUtcList

[in]BACnetRecipient [] TimeSynchronizationRecipients

[out]0:UInt32 FirstFailedElementNumber

);

Argument

Description

AddToUtcList

Indicates if the recipient is added to Time_Synchronization_Recipients or to UTC_Time_Synchronization_Recipients.

TimeSynchronizationRecipients

Array of time syncronization recipients. Based on the AddToUtcList parameter, the recipients are added to the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

FirstFailedElementNumber

The numerical position, starting at 1, of the failed element in the TimeSynchronizationRecipients. If the call succeeds or fails for other reasons, the returned value shall be 0.

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

BadOutOfMemory

This status is returned for the BACnet error code NO_SPACE_TO_ADD_LIST_ELEMENT

This Method removes entries from the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients.

Signature

RemoveTimeSynchronizationRecipients (

[in]0:Boolean RemoveFromUtcList

[in]BACnetRecipient [] TimeSynchronizationRecipients

[out]0:UInt32 FirstFailedElementNumber

);

Argument

Description

RemoveFromUtcList

Indicates if the recipient is removed from Time_Synchronization_Recipients or to UTC_Time_Synchronization_Recipients.

TimeSynchronizationRecipients

Array of time synchronization recipients. Based on the AddToUtcList parameter, the recipients are removed from the BACnet property Time_Synchronization_Recipients or UTC_Time_Synchronization_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

FirstFailedElementNumber

The numerical position, starting at 1, of the failed element in the TimeSynchronizationRecipients. If the call succeeds or fails for other reasons, the returned value shall be 0.

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

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

BadNotFound

This status is returned for the BACnet error code LIST_ELEMENT_NOT_FOUND

The BACnet BackupRestoreType is formally defined in Table 48.

Table 48 – BACnetBackupRestoreType Definition

Attribute

Value

BrowseName

BACnetBackupRestoreType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Configuration_Files

BACnetDeviceObjectPropertyReference[]

0:PropertyType

M

0:HasProperty

Variable

Last_Restore_Time

BACnetTimeStamp

0:PropertyType

M

0:HasProperty

Variable

Backup_Failure_Timeout

0:UInt16

0:PropertyType

M

0:HasProperty

Variable

Backup_Preparation_Time

0:UInt16

0:PropertyType

O

0:HasProperty

Variable

Restore_Preparation_Time

0:UInt16

0:PropertyType

O

0:HasProperty

Variable

Restore_Completion_Time

0:UInt16

0:PropertyType

O

0:HasProperty

Variable

Backup_And_Restore_State

BACnetBackupState

0:PropertyType

O

0:HasComponent

Method

BACnetBackup

M

0:HasComponent

Method

BACnetRestore

M

The BACnet BackupRestoreType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetDeviceObjectPropertyReference [], represents the BACnet property Configuration_Files. The BACnetDeviceObjectPropertyReference DataType is defined in 10.5.9.

The Configuration_Files represents a collection of file names within a device that define the device’s image and that can be backed up. Note that the content is only required to be valid when a backup is in progress.

This OPC UA Property, of DataType BACnetTimeStamp, represents the BACnet property Configuration_Files. The BACnetTimeStamp DataType is defined in 10.6.11.

The Last_Restore_Time value represents the time at which the device image was last backed up.

This OPC UA Property, of DataType UInt16, represents the BACnet property Backup_Failure_Timeout.

The Backup_Failure_Timeout value represents the time, in seconds, that the device being backed up or restored must wait until ending the backup or restore operation.

This OPC UA Property, of DataType UInt16, represents the BACnet property Backup_Preparation_Time.

The Backup_Preperation_Time value represents the time, in seconds, that the device that is being backed up may remain unresponsive after the backup procedure is initiated.

This OPC UA Property, of DataType UInt16, represents the BACnet property Restore_Preparation_Time.

The Restore_Preperation_Time value represents the time, in seconds, that the device that is being restored may remain unresponsive after the restore procedure is initiated.

This OPC UA Property, of DataType UInt16, represents the BACnet property Restore_Completion_Time.

The Restore_Completion_Time variable value represents the time, in seconds, that the device that is being restored may remain unresponsive after the restore procedure has ended.

This OPC UA Property, of DataType BACnetBackupState, represents the BACnet property Backup_And_Restore_State. The BACnetBackupState DataType is defined in 10.4.3.

The Backup_And_Restore_State value represents the current state of the device that is performing a backup or restore procedure.

This Method is used to trigger a backup.

Signature

BACnetBackup (

);

Method Result Codes

ResultCode

Description

Common StatusCodes defined in OPC 10000-4

This Method is used to trigger a restore.

Signature

BACnetRestore (

);

Method Result Codes

ResultCode

Description

Common StatusCodes defined in OPC 10000-4

The BACnetMstpMasterType is formally defined in Table 49.

Table 49 – BACnetMstpMasterType Definition

Attribute

Value

BrowseName

BACnetMstpMasterType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Max_Master

0:Byte

0:PropertyType

M

0:HasProperty

Variable

Max_Info_Frames

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

Slave_Proxy_Enable

0:Boolean

0:PropertyType

O

0:HasProperty

Variable

Manual_Slave_Address_Binding

BACnetAddressBinding[]

0:PropertyType

O

0:HasProperty

Variable

Auto_Slave_Discovery

0:Boolean

0:PropertyType

O

0:HasProperty

Variable

Slave_Address_Binding

BACnetAddressBinding[]

0:PropertyType

O

The BACnetMstpMasterType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType Byte, represents the BACnet property Max_Master.

The Max_Master value represents the highest possible maximum node address and shall be equal to or less than 127. The default value shall be 127.

This OPC UA Property, of DataType UInteger, represents the BACnet property Max_Info_Frames.

The Max_Info_Frames value represents the maximum number of information frames that may be sent before passing the communications token. The default value shall be 1.

This OPC UA Property, of DataType Boolean, represents the BACnet property Slave_Proxy_Enable.

When the Slave_Proxy_Enable value is true, the device will perform Slave/Proxy functions on the device MS/TP port.

This OPC UA Property, of DataType BACnetAddressBinding [], represents the BACnet property Manual_Slave_Address_Binding. The BACnetAddressBinding DataType is defined in 10.5.3.

The Manual_Slave_Address_Binding value represents a collection of manually configured slave devices for which this device is acting as a Slave Proxy.

This OPC UA Property, of DataType Boolean, represents the BACnet property Auto_Slave_Discovery.

When true, the Auto_Slave_Discovery value indicates that the MS/TP master will perform automatic slave detection functions on the master MS/TP port.

This OPC UA Property, of DataType BACnetAddressBinding [], represents the BACnet property Slave_Address_Binding. The BACnetAddressBinding DataType is defined in 10.5.3.

The Slave_Address_Binding value represents a collection of slave devices for which this device is acting as a Slave Proxy. This set includes the manually configured devices represented by the Master_Slave_Address_Binding and automatically discovered slave devices.The Slave_Address_Binding shall be periodically maintained, but the period at which the list is maintained shall be locally defined.

The BACnetDeviceRestartType is formally defined in Table 50.

Table 50 – BACnetDeviceRestartType Definition

Attribute

Value

BrowseName

BACnetDeviceRestartType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Last_Restart_Reason

BACnetRestartReason

0:PropertyType

M

0:HasProperty

Variable

Time_Of_Device_Restart

BACnetTimeStamp

0:PropertyType

M

0:HasProperty

Variable

Restart_Notification_Recipients

BACnetRecipient[]

0:PropertyType

M

0:HasComponent

Method

AddRestartRecipients

M

0:HasComponent

Method

RemoveRestartRecipients

M

The BACnetDeviceRestartType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetRestartReason, represents the BACnet property Last_Restart_Reason. The BACnetRestartReason DataType is defined in 10.4.29.

The Last_Restart_Reason value indicates the reason for the last device restart. Some possible values for this variable are UNKNOWN, COLDSTART, WARMSTART, DETECTED_POWER_LOST, DETECTED_POWER_OFF, HARDWARE_WATCHDOG, SOFTWARE_WATCHDOG, and SUSPENDED.

This OPC UA Property, of DataType BACnetTimeStamp, represents the BACnet property Time_Of_Device_Restart. The BACnetTimeStamp DataType is defined in 10.6.11.

The Time_Of_Device_Restart value represents the time at which the device was last restarted.

This OPC UA Property, of DataType BACnetRecipient [], represents the BACnet property Restart_Notification_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

The Restart_Notification_Recipients variable value is a collection of recipients that shall be notified when the device is restarted. The default value is the network broadcast address. If the collection size is zero, no restart notifications shall be sent.

This Method adds entries to the BACnet property Restart_Notification_Recipients.

Signature

AddRestartRecipients (

[in]BACnetRecipient [] RestartNotificationRecipients

[out]0:UInt32 FirstFailedElementNumber

);

Argument

Description

RestartNotificationRecipients

Array of time restart notification recipients. The recipients are added to the BACnet property Restart_Notification_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

FirstFailedElementNumber

The numerical position, starting at 1, of the failed element in the RestartNotificationRecipients. If the call succeeds or fails for other reasons, the returned value shall be 0.

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

BadOutOfMemory

This status is returned for the BACnet error code NO_SPACE_TO_ADD_LIST_ELEMENT

This Method removes entries from the BACnet property Restart_Notification_Recipients.

Signature

RemoveRestartRecipients (

[in]BACnetRecipient [] RestartNotificationRecipients

[out]0:UInt32 FirstFailedElementNumber

);

Argument

Description

RestartNotificationRecipients

Array of restart notifctation recipients. The recipients are removed from the BACnet property Restart_Notification_Recipients. The BACnetRecipient DataType is defined in 10.6.9.

FirstFailedElementNumber

The numerical position, starting at 1, of the failed element in the RestartNotificationRecipients. If the call succeeds or fails for other reasons, the returned value shall be 0.

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

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

BadNotFound

This status is returned for the BACnet error code LIST_ELEMENT_NOT_FOUND

This OPC UA ObjectType represents a set of variables related to the BACnet Change_of_State concept. The type represents metadata related to an object’s Present_Value: when the Present_Value changed, how often it changed, and how often this count is reset.

The BACnetChangeOfStateCountType is formally defined in Table 51.

Table 51 BACnetChangeOfStateCountType Definition

Attribute

Value

BrowseName

BACnetChangeOfStateCountType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Change_Of_State_Time

BACnetDateTime

0:PropertyType

M

0:HasProperty

Variable

Change_Of_State_Count

0:UInt32

0:PropertyType

M

0:HasProperty

Variable

Time_Of_State_Count_Reset

0:DateTime

0:PropertyType

M

0:HasComponent

Method

Reset

M

The BACnetChangeOfStateCountType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of type DateTime, represents the date and time at which the most recent change of state occurred. A “change of state” shall be defined as any event that alters the Present_Value property.

This OPC UA Property, of type UInt32, represents the number of times that the Present_Value property has changed state since the Change_Of_State_Count property was most recently set to a zero value. A “change of state” shall be defined as any event that alters the Present_Value property.

This OPC UA Property, of type DateTime, represents the date and time at which the Change_Of_State_Count property was most recently set to a zero value.

This Method is used to trigger a reset.

Signature

BACnetReset (

);

Method Result Codes

ResultCode

Description

Common StatusCodes defined in OPC 10000-4

This OPC UA ObjectType represents a set of variables related to the BACnet Elapsed_Active_Time concept. The type represents metadata related to an object’s Present_Value: the accumulated number of seconds that the Present_Value variable has been Active, and the date and time at which the Elapsed_Active_Time was most recently set to a zero value.

The BACnetElapsedActiveTimeType is formally defined in Table 52.

Table 52 BACnetElapsedActiveTimeType Definition

Attribute

Value

BrowseName

BACnetElapsedActiveTimeType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Elapsed_Active_Time

0:UInt32

0:PropertyType

M

0:HasProperty

Variable

Time_Of_Active_Time_Reset

0:DateTime

0:PropertyType

M

0:HasComponent

Method

Reset

M

The BACnetElapsedActiveTimeType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of type UInt32, represents the accumulated number of seconds that the Present_Value property has had the value Active since the Elapsed_Active_Time property was most recently set to a zero value.

This OPC UA Property, of type DateTime, represents the date and time at which the Elapsed_Active_Time property was most recently set to a zero value.

This Method is used to trigger a reset.

Signature

BACnetReset (

);

Method Result Codes

ResultCode

Description

Common StatusCodes defined in OPC 10000-4

This OPC UA ObjectType represents a set of variables related to the BACnet event Reporting concept. Event reporting is used to define alarm or event conditions that are intrinsic to a particular BACnet object type and require only the properties of that object type.

This OPC UA ObjectType covers both BACnet event detection and event reporting parameters.

The BACnetEventReportingType is formally defined in Table 53.

Table 53 BACnetEventReportingType Definition

Attribute

Value

BrowseName

BACnetEventReportingType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Event_State

BACnetEventState

0:PropertyType

M

0:HasProperty

Variable

Notification_Class

UInt32

0:PropertyType

M

0:HasProperty

Variable

Event_Enable

BACnetEventTransitionBits

0:PropertyType

M

0:HasProperty

Variable

Acked_Transitions

BACnetEventTransitionBits

0:PropertyType

M

0:HasProperty

Variable

Notify_Type

BACnetNotifyType

0:PropertyType

M

0:HasProperty

Variable

Event_Time_Stamps

BACnetTimeStamp [3]

0:PropertyType

M

0:HasProperty

Variable

Event_Message_Texts

String [3]

0:PropertyType

O

0:HasProperty

Variable

Event_Message_Texts_Config

String [3]

0:PropertyType

O

0:HasProperty

Variable

Event_Detection_Enable

0:Boolean

0:PropertyType

O

0:HasProperty

Variable

Event_Algorithm_Inhibit_Ref

BACnetDeviceObjectPropertyReference

0:PropertyType

O

0:HasProperty

Variable

Event_Algorithm_Inhibit

0:Boolean

0:PropertyType

O

0:HasComponent

Object

EventAlgorithm

BACnetEvent AlgorithmType

O

The BACnetEventReportingType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetEventState, is included in order to provide a way to determine whether this object has an active event state associated with it. If the object does not support event reporting then the value of this property shall be Normal. The BACnetEventState DataType is defined in 10.4.10.

While BACnet object types normally require the BACnet property Event_State, the OPC UA Object EventReporting is O. In absence of an event algorithm the property Event_State is defined by BACnet to be Normal. And therefore does not provide any valuable information and is not visible in this case.

This OPC UA Property, of type UInt32, shall specify the instance of the Notification Class object to use for event-notification description.

The value of this property results in a HasEventSource Reference from the OPC UA Object representing the BACnet Notification Class object and the BACnet object containing the event reporting object. The inverse reference shall be supported if event reporting is available.

This OPC UA Property, of type BACnetEventTransitionBits, is a set of three flags that separately configure delivery of TO_OFFNORMAL, TO_FAULT, and TO_NORMAL notifications. The BACnetEventTransitionBits DataType is defined in 10.3.3.

This OPC UA Property, of type BACnetEventTransitionBits, is a set of three flags that separately indicate the acknowledgement state for TO_OFFNORMAL, TO_FAULT, and TO_NORMAL events. Each flag shall have the value True if no event of that type has ever occurred for the object. The BACnetEventTransitionBits DataType is defined in 10.3.3.

This OPC UA Property, of type BACnetNotifyType, shall indicate whether the notifications generated by the object are Events or Alarms. The BACnetNotifyType DataType is defined in 10.4.20.

This OPC UA Property, of type BACnetTimeStamp [3], shall indicate the times of the last TO_OFFNORMAL, TO_FAULT, and TO_NORMAL events. The BACnetTimeStamp DataType is defined in 10.6.11.

This OPC UA Property, of type String [3], shall indicate the message text values of the last TO_OFFNORMAL, TO_FAULT, and TO_NORMAL events. If a particular type of event has yet to occur, an empty string shall be stored in the respective array element.

This OPC UA Property, of DataType Boolean, represents the BACnet property Event_Detection_Enable.

When true, the Event_Detection_Enable value indicates that intrinsic reporting is enabled in the device and that the device should be considered by event summarization services. This value is expected to be statically configured and is not expected to change dynamically.

When false, the Event_State shall be NORMAL and the variables Acked_Transitions, Event_Time_Stamps, and Event_Message_Texts shall be equal to their respective initial conditions.

This OPC UA Property, of DataType BACnetDeviceObjectPropertyReference represents the BACnet property Event_Algorithm_Inhibit_Ref. The DataType is defined in 10.5.9.

The Event_Algorithm_Inhibit_Ref variable value represents the property which controls the value of the property Event_Algorithm_Inhibit

This OPC UA Property, of DataType Boolean, represents the BACnet property Event_Algorithm_Inhibit.

When the Event_Algorithm_Inhibit variable value is true, the event algorithm is disabled for the object. When the Event_Algorithm_Inhibit_Ref variable is initialized (its value is other than 4194303) then the Event_Algorithm_Inhibit variable shall reflect the value of the property referenced by Event_Algorithm_Inhibit_Ref.

This object, of type BACnetEventAlgorithmType describes the BACnet event algorithm used by the physical device.

This OPC UA ObjectType represents an abstract type related to the BACnet Algorithmic Change Reporting mechanism. Algorithmic change reporting is a general concept that can be applied to properties of any object. The actual algorithms used to generate the events are similar to those used by EventReporting.

The subtypes of BACnetEventAlgorithmType defined in the following clauses represent the event algorithms defined in chapter 13.2 Event Algorithms in the BACnet standard.

The BACnetEventAlgorithmType is formally defined in Table 54.

Table 54 BACnetEventAlgorithmType Definition

Attribute

Value

BrowseName

BACnetEventAlgorithmType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

TimeDelay

0:UInt32

0:PropertyType

M

0:HasProperty

Variable

TimeDelayNormal

0:UInt32

0:PropertyType

M

The BACnetEventAlgorithmType is an abstract type and cannot be used directly.

This OPC UA Property, of type UInt32, is the TimeDelay parameter for the object’s event algorithm. It represents the time, in seconds, that the offnormal conditions must exist before an offnormal event state is indicated.

It is normally used to represent the BACnet property Time_Delay.

This OPC UA Property, of type UInt32, is the TimeDelayNormal parameter for the object’s event algorithm. It represents the time, in seconds, that the normal conditions must exist before a NORMAL event state is indicated.

It is normally used to represent the BACnet property Time_Delay_Normal. If the BACnet property Time_Delay_Normal is not present it has the same value as the BACnet property Time_Delay.

This OPC UA ObjectType represents the BACnet Change of State event algorithm.

The BACnetChangeOfStateAlgorithmType is formally defined in Table 55.

Table 55 BACnetChangeOfStateAlgorithmType Definition

Attribute

Value

BrowseName

BACnetChangeOfStateAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

AlarmValues

0:BaseDataType{Any}

0:PropertyType

M

The BACnetChangeOfStateAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property is the AlarmValues parameter for the object’s event algorithm. It contains a list of discrete values that represent the offnormal values.

This OPC UA ObjectType represents the BACnet Command Failure event algorithm.

The BACnetCommandFailureAlgorithmType is formally defined in Table 56.

Table 56 BACnetCommandFailureAlgorithmType Definition

Attribute

Value

BrowseName

BACnetCommandFailureAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

FeedbackValueRef

BACnetDeviceObjectPropertyReference

0:PropertyType

M

The BACnetCommandFailureAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetDeviceObjectPropertyReference, references the value that is used as the pFeedbackValue parameter of the BACnet event algorithm. The DataType is defined in 10.5.10.

If the event algortithm is used in objects other than event enrollment, the value contains the reference to the BACnet Feedback_Value property.

This OPC UA ObjectType represents the BACnet Floating Limit event algorithm.

The BACnetFloatingLimitAlgorithmType is formally defined in Table 57.

Table 57 – BACnetFloatingLimitAlgorithmType Definition

Attribute

Value

BrowseName

BACnetFloatingLimitAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

SetpointReference

BACnetDeviceObject PropertyReference

0:PropertyType

M

0:HasProperty

Variable

LowDiffLimit

0:Float

0:PropertyType

M

0:HasProperty

Variable

HighDiffLimit

0:Float

0:PropertyType

M

0:HasProperty

Variable

Deadband

0:Float

0:PropertyType

M

The BACnetFloatingLimitAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetDeviceObjectPropertyReference, references the value that is used as the SetpointReference parameter of the BACnet event algorithm. The DataType is defined in 10.5.10.

The SetpointReference variable value represents a reference to the value that defines the reference interval.

This OPC UA Property, of DataType Float, is the LowDiffLimit parameter for the object’s event algorithm.

Subtracted from the setpoint reference value, the LowDiffLimit variable value represents the lower limit of the range considered normal.

This OPC UA Property, of DataType Float, is the HighDiffLimit parameter for the object’s event algorithm.

Added to the setpoint reference value, the HighDiffLimit variable value represents the upper limit of the range considered normal.

This OPC UA Property, of DataType Float, is the Deadband parameter for the object’s event algorithm.

The Deadband variable value represents the deadband that is applied to the limit before a return to Normal event state is indicated.

This OPC UA ObjectType represents the BACnet out of Range event algorithm.

The BACnetOutOfRangeAlgorithmType is formally defined in Table 58.

Table 58 BACnetOutOfRangeAlgorithmType Definition

Attribute

Value

BrowseName

BACnetOutOfRangeAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

HighLimit

0:Float

0:PropertyType

M

0:HasProperty

Variable

LowLimit

0:Float

0:PropertyType

M

0:HasProperty

Variable

Deadband

0:Float

0:PropertyType

M

0:HasProperty

Variable

LimitEnable

BACnetLimitEnable

0:PropertyType

M

The BACnetOutOfRangeAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType Float, is the HighLimit parameter for the object’s event algorithm.

The HighLimit value represents the upper limit of the range considered normal.

This OPC UA Property, of DataType Float, is the LowLimit parameter for the object’s event algorithm.

The LowLimit value represents the lower limit of the range considered normal.

This OPC UA Property, of DataType Float, is the Deadband parameter for the object’s event algorithm.

The Deadband value represents the deadband that is applied to the limit before a return to Normal event state is indicated.

This OPC UA Property, of DataType BACnetLimitEnable, shall indicate three separate flags that enable and disable the delivery of TO_OFFNORMAL, TO_FAULT, and TO_NORMAL notifications. The DataType BACnetLimitEnable is defined in 10.3.4.

This OPC UA ObjectType represents the BACnet buffer ready event algorithm.

The BACnetBufferReadyAlgorithmType is formally defined in Table 59.

Table 59 – BACnetBufferReadyAlgorithmType Definition

Attribute

Value

BrowseName

BACnetBufferReadyAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

Threshold

0:UInt32

0:PropertyType

M

0:HasProperty

Variable

PreviousCount

0:UInt32

0:PropertyType

M

The BACnetBufferReadyAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType UInt32, is the Threshold parameter for the object’s event algorithm.

The Threshold value represents the number of records that, when added to the log buffer, will result in a transition to NORMAL. If this variable has a value of zero, then no transitions will be indicated by the algorithm.

This OPC UA Property, of DataType UInt32, is the PreviousCount parameter for the object’s event algorithm.

The PreviousCount value represents the value of pMonitoredValue at the time the most recent transition to NORMAL was indicated. Upon initialization of the event algorithm, this parameter shall be set to the value of pMonitoredValue. When a transition to NORMAL is indicated, this parameter shall be updated to the value of pMonitoredValue.

This OPC UA ObjectType represents the BACnet change of bitstring event algorithm.

The BACnetChangeOfBitStringAlgorithmType is formally defined in Table 60.

Table 60 – BACnetChangeOfBitStringAlgorithmType Definition

Attribute

Value

BrowseName

BACnetChangeOfBitStringAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

AlarmValues

0:OptionSet

0:PropertyType

M

The BACnetChangeOfBitStringAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType OptionSet, is the AlarmValues parameter for the object’s event algorithm.

The AlarmValues value represents a set of values that are considred off-NORMAL.

The OptionSet DataType contains the bitmask that defines the bits of the monitored value that are significant for comparison with the values in the AlarmValues set. The value is bitwise AND’ed with the monitored value before comparison with the AlarmValues values.

This OPC UA ObjectType represents the BACnet change of value event algorithm.

The BACnetChangeOfValueAlgorithmType is formally defined in Table 61.

Table 61 – BACnetChangeOfValueAlgorithmType Definition

Attribute

Value

BrowseName

BACnetChangeOfValueAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

Increment

0:Float

0:PropertyType

M

0:HasProperty

Variable

Bitmask

0:OptionSet

0:PropertyType

M

The BACnetChangeOfValueAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType Float, is the Increment parameter for the object’s event algorithm.

The Increment value represents the positive increment by which a monitored value of Float type must change for a new transition.

This OPC UA Property, of DataType OptionSet, is the Bitmask parameter for the object’s event algorithm.

The Bitmask value represents the bitmask that defines the bits of pMonitoredValue that are significant for detecting a change of value. This value is bit-wise AND’ed with the monitored value before comparison with the value that has caused the last transition to NORMAL.

This OPC UA ObjectType represents the BACnet unsigned range event algorithm.

The BACnetUnsignedRangeAlgorithmType is formally defined in Table 62.

Table 62 – BACnetUnsignedRangeAlgorithmType Definition

Attribute

Value

BrowseName

BACnetUnsignedRangeAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

LowLimit

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

HighLimit

0:UInteger

0:PropertyType

M

The BACnetUnsignedRangeAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType UInteger, is the LowLimit parameter for the object’s event algorithm.

The LowLimit value represents the lower limit of the range considered normal.

This OPC UA Property, of DataType UInteger, is the HighLimit parameter for the object’s event algorithm.

The HighLimit variable value represents the upper limit of the range considered normal.

This OPC UA ObjectType represents the BACnet change of status flags event algorithm.

The BACnetChangeOfStatusFlagsAlgorithmType is formally defined in Table 63.

Table 63 – BACnetChangeOfStatusFlagsAlgorithmType Definition

Attribute

Value

BrowseName

BACnetChangeOfStatusFlagsAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

SelectedFlags

BACnetStatusFlags

0:PropertyType

M

The BACnetChangeOfStatusFlagsAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetStatusFlags, is the SelectedFlags parameter for the object’s event algorithm. The DataType BACnetStatusFlags is defined in 10.3.7.

The SelectedFlags value represents the flags of the monitored value that are significant for evaluation. A status flag variable value of true indicates that the corresponding monitored value flag is significant for evaluation.

This OPC UA ObjectType represents the BACnet double out of Range event algorithm.

The BACnetDoubleOutOfRangeAlgorithmType is formally defined in Table 64.

Table 64 – BACnetDoubleOutOfRangeAlgorithmType Definition

Attribute

Value

BrowseName

BACnetDoubleOutOfRangeAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

HighLimit

0:Double

0:PropertyType

M

0:HasProperty

Variable

LowLimit

0:Double

0:PropertyType

M

0:HasProperty

Variable

Deadband

0:Double

0:PropertyType

M

0:HasProperty

Variable

LimitEnable

BACnetLimitEnable

0:PropertyType

M

The BACnetDoubleOutOfRangeAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType Double, is the HighLimit parameter for the object’s event algorithm.

The HighLimit value represents the upper limit of the range considered normal.

This OPC UA Property, of DataType Double, is the LowLimit parameter for the object’s event algorithm.

The LowLimit value represents the lower limit of the range considered normal.

This OPC UA Property, of DataType Double, is the Deadband parameter for the object’s event algorithm.

The Deadband variable value represents the deadband that is applied to the limit before a return to Normal event state is indicated.

This OPC UA Property, of DataType BACnetLimitEnable, shall indicate three separate flags that enable and disable the delivery of TO_OFFNORMAL, TO_FAULT, and TO_NORMAL notifications. The DataType BACnetLimitEnable is defined in 10.3.4.

This OPC UA ObjectType represents the BACnet signed out of Range event algorithm.

The BACnetSignedOutOfRangeAlgorithmType is formally defined in Table 65.

Table 65 – BACnetSignedOutOfRangeAlgorithmType Definition

Attribute

Value

BrowseName

BACnetSignedOutOfRangeAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

HighLimit

0:Integer

0:PropertyType

M

0:HasProperty

Variable

LowLimit

0:Integer

0:PropertyType

M

0:HasProperty

Variable

Deadband

0:Integer

0:PropertyType

M

0:HasProperty

Variable

LimitEnable

BACnetLimitEnable

0:PropertyType

M

The BACnetSignedOutOfRangeAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType Integer, is the HighLimit parameter for the object’s event algorithm.

The HighLimit value represents the upper limit of the range considered normal.

This OPC UA Property, of DataType Integer, is the LowLimit parameter for the object’s event algorithm.

The LowLimit value represents the lower limit of the range considered normal.

This OPC UA Property, of DataType Integer, is the Deadband parameter for the object’s event algorithm.

The Deadband value represents the deadband that is applied to the limit before a return to Normal event state is indicated.

This OPC UA Property, of type BACnetLimitEnable, shall indicate three separate flags that enable and disable the delivery of TO_OFFNORMAL, TO_FAULT, and TO_NORMAL notifications. The DataType BACnetLimitEnable is defined in 10.3.4.

This OPC UA ObjectType represents the BACnet unsigned out of Range event algorithm.

The BACnetUnsignedOutOfRangeAlgorithmType is formally defined in Table 66.

Table 66 – BACnetUnsignedOutOfRangeAlgorithmType Definition

Attribute

Value

BrowseName

BACnetUnsignedOutOfRangeAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

HighLimit

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

LowLimit

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

Deadband

0:UInteger

0:PropertyType

M

0:HasProperty

Variable

LimitEnable

BACnetLimitEnable

0:PropertyType

M

The BACnetUnsignedOutOfRangeAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType UInteger, is the HighLimit parameter for the object’s event algorithm.

The HighLimit value represents the upper limit of the range that is considered normal.

This OPC UA Property, of DataType UInteger, is the LowLimit parameter for the object’s event algorithm.

The LowLimit value represents the lower limit of the range that is considered normal.

This OPC UA Property, of DataType UInteger, is the Deadband parameter for the object’s event algorithm.

The Deadband value represents the deadband that is applied to the limit before a return to Normal event state is indicated.

This OPC UA Property, of DataType BACnetLimitEnable, shall indicate three separate flags that enable and disable the delivery of TO_OFFNORMAL, TO_FAULT, and TO_NORMAL notifications. The DataType BACnetLimitEnable is defined in 10.3.4.

This OPC UA ObjectType represents the BACnet change of status flags event algorithm.

The BACnetChangeOfCharacterStringAlgorithmType is formally defined in Table 67.

Table 67 – BACnetChangeOfCharacterStringAlgorithmType Definition

Attribute

Value

BrowseName

BACnetChangeOfCharacterStringAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetEventAlgorithmType defined in 8.9.

0:HasProperty

Variable

AlarmValues

0:String[]

0:PropertyType

M

The BACnetChangeOfCharacterStringAlgorithmType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType String[], is the AlarmValues parameter for the object’s event algorithm.

The AlarmValues variable value represents a collection of character strings that are considered alarm values.

This OPC UA ObjectType represents a set of variables related to the BACnet fault evaluation concept.

This OPC UA ObjectType covers BACnet reliability evaluation. Parameters for BACnet fault reporting are covered by BACnetEventReportingType.

The BACnetFaultEvaluationType is formally defined in Table 68.

Table 68 – BACnetFaultEvaluationType Definition

Attribute

Value

BrowseName

BACnetFaultEvaluationType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

0:HasProperty

Variable

Reliability

BACnetReliability

0:PropertyType

M

0:HasProperty

Variable

Reliability_Evaluation_Inhibit

0:Boolean

0:PropertyType

O

0:HasComponent

Object

FaultAlgorithm

BACnetFault AlgorithmType

O

The BACnetFaultEvaluationType ObjectType is a concrete type and can be used directly.

This OPC UA Property, of DataType BACnetReliability, represents the BACnet property Reliability. The BACnetReliability DataType is defined in 10.4.28.

It provides an indication of whether the Present_Value or the operation of the physical I/O in question is “reliable” as far as the BACnet Device or operator can determine and, if not, why.

This OPC UA Property, of DataType Boolean, represents the BACnet property Reliability_Evaluation_Inhibit.

It indicates whether or not reliability-evaluation is disabled in the object.

This object, of type BACnetFaultAlgorithmType describes the BACnet fault algorithm used by the physical device.

This OPC UA ObjectType represents describes the BACnet fault algorithm used by a BACnet device.

The BACnetFaultAlgorithmType is formally defined in Table 69.

Table 69 BACnetFaultAlgorithmType Definition

Attribute

Value

BrowseName

BACnetFaultAlgorithmType

IsAbstract

True

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BaseObjectType defined in OPC 10000-5

The BACnetFaultAlgorithmType is an abstract type and cannot be used directly.

This OPC UA ObjectType represents the BACnet state fault algorithm.

The BACnetFaultStateAlgorithmType is formally defined in Table 70.

Table 70 BACnetFaultStateAlgorithmType Definition

Attribute

Value

BrowseName

BACnetFaultStateAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetFaultAlgorithmType defined in 8.24.

0:HasProperty

Variable

FaultValues

0:BaseDataType []

0:PropertyType

M

The BACnetFaultStateAlgorithmType ObjectType is a concrete type and can be used directly.

The FaultValues parameter provides the values used by the fault state algorithm to determine whether the monitored value is in a fault state.

This OPC UA ObjectType represents the BACnet character string fault algorithm.

The BACnetFaultCharacterStringAlgorithmType is formally defined in Table 71.

Table 71 BACnetFaultCharacterAlgorithmType Definition

Attribute

Value

BrowseName

BACnetFaultCharacterStringAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetFaultAlgorithmType defined in 8.24.

0:HasProperty

Variable

FaultValues

0:String []

0:PropertyType

M

The BACnetFaultCharacterStringAlgorithmType ObjectType is a concrete type and can be used directly.

The FaultValues parameter provides the values used by the fault state algorithm to determine whether the monitored value is in a fault state.

This OPC UA ObjectType represents the BACnet status flags fault algorithm.

The BACnetFaultStatusFlagsAlgorithmType is formally defined in Table 72.

Table 72 BACnetFaultStatusFlagsAlgorithmType Definition

Attribute

Value

BrowseName

BACnetFaultStatusFlagsAlgorithmType

IsAbstract

False

References

NodeClass

BrowseName

DataType

TypeDefinition

Other

Subtype of the BACnetFaultAlgorithmType defined in 8.24.

The BACnetFaultStatusFlagsAlgorithmType ObjectType is a concrete type and can be used directly.