8.2 BACnetAutomaticTimeSynchronizationMasterType
8.2.1 ObjectType definition
The BACnetAutomaticTimeSynchronizationMasterType is formally defined in Table 47.
| 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.
8.2.2 ObjectType Description
8.2.2.1 Variable Time_Synchronization_Recipients
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.
8.2.2.2 Variable UTC_Time_Synchronization_Recipients
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.
8.2.2.3 Variable Time_Synchronization_Interval
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.
8.2.2.4 Variable Align_Intervals
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.
8.2.2.5 Variable Interval_Offset
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.
8.2.2.6 Method AddTimeSynchronizationRecipients
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 |
8.2.2.7 Method RemoveTimeSynchronizationRecipients
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 |