BACnet Device Attributes - Metasys - LIT-12011942 - Software Application - ODS Server - 10.1

Metasys Open Data Server Help

Brand
Metasys
Product name
ODS Server
Document type
User Guide
Document number
LIT-12011942
Version
10.1
Revision date
2019-10-14
Language
English

This object contains attributes common to many Metasys system objects. These common attributes are described in the Common Object Attributes section. This section includes attributes of the Focus/Configuration tab, the Diagnostics tab (if applicable), and any other tab specific only to this object. See the Object and Feature Tabs section for information on the attributes that appear on the other tabs of this object (for example, the Hardware and Options tab appear on point objects).

Note: In the Notes column, attributes that are marked with a letter C are configurable, attributes marked with the letter W are writable, and attributes marked with the letter D indicate the default attribute for the display.
Table 1. BACnet Device Attributes - Focus/Configuration Tab

Attribute Name

Notes

Initial Value

Description

Alarm State

Indicates the current state of the object.

APDU Timeout

 

See next column

Indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgement for which no acknowledgement has been received. This value is nonzero if APDU Retries is nonzero.

In order to achieve reliable communication, the values of the APDU Timeout attributes of the Device objects of all intercommunicating devices should contain the same value.

The default is 6,000 milliseconds for devices that permit modification of this attribute. The default value is 60,000 milliseconds for all other devices.

Active COV Subscriptions

   
Contains a list of BACnet COV Subscriptions, each of which consists of a Recipient, a Monitored Property Reference, an Issue Confirmed Notifications flag, a Time Remaining value, and an optional COV Increment. This attribute provides a network-visible indication of those COV subscriptions active at any given time. Whenever a COV Subscription is created with the Subscribe COV or Subscribe COV Property service, a new entry is added to the Active COV Subscriptions list. Similarly, whenever a COV Subscription is terminated, the corresponding entry is removed from the Active COV Subscriptions list.
Note: If the device supports execution of either Subscribe COV or Subscribe COV Property service, this attribute is required.

Alarm State

     

Appl SW Version

   

Identifies the version of the application software installed in the device. The content of this string is locally defined (date-and-time stamp, a programmer’s name, a host file version number, and so on).

Configuration Files

   

Identifies the files within the device that determine what device image can be backed up. The contents of this attribute are only required to be valid during the backup procedure. If the device supports the BACnet backup and restore procedure, this attribute is supported.

Note: If the device supports the backup and restore procedures, the Configuration Files and Last Restore Time attributes are required.

Database Revision

   

Specifies a logical revision number for the device’s database. Database Revision is incremented when an object is created or deleted, an object name changes, or a restore is performed.

Graphic

C,W

  Indicates the graphic associated with the object.

Graphic Alias

C,W

 

Indicates a portion of the graphic’s item reference, up to and including the name of the folder containing this object or the controller containing this point. Maximum 256 characters

Interval Offset

C,W

0

Specifies the offset, in minutes, from the beginning of the period defined for time synchronization until the actual time synchronization requests are set. Interval Offset has no effect when Align Intervals is False. Units = Minutes

Last Restore Time

   

Specifies when the device’s image was last restored. If the device supports the BACnet backup and restore procedures, this attribute is supported.

Note: If the device supports the backup and restore procedures, the Configuration Files and Last Restore Time attributes are required.

List of Session Keys

   

Contains a list of the cryptographic keys used to communicate with other security-conscious BACnet Devices. This attribute is not readable or writable by any device except a device designated the Key Server. A session key consists of a 56-bit encryption key and a BACnet Address of the peer with which secure communications is requested.

Manual Time Sync Type

C,W

Automatic

Configures the type of BACnet Time Synchronization to send to a BACnet device.
  • UTC: UTC time synchronization message is sent.
  • Local: A local time synchronization message is sent.
  • None: No message is sent.
  • Auto: The mapper object's Protocol Services Supported attribute is used to determine which type of time sync is supported, and if:
    • utcTimeSynchronization is set, the code functions as if Time Sync Type is set to UTC.
    • utcTimeSynchronization is not set and timeSynchronization is set, local time is set.
    • neither utcTimeSynchronization nor timeSynchronization is set, an error is returned.

Max APDU Length

   

Specifies the maximum number of octets contained in a single, indivisible application layer protocol unit. Underlying data link technology constrains the value of this attribute.

Greater or equal to 50

Max Info Frames

 

10 (FEC)

20 (NxE)

Specifies the maximum number of information frames the node may send before it passes the token. This attribute is present if the device is a node on an MS/TP network. If Max Info Frames is not writable or otherwise user configurable, its value is one.

Note: If the device is an MS/TP master node, both the Max Info Frames and Max Master attributes are required.

Max Master

 

127

Specifies the highest possible address for master nodes and is less than or equal to 127. This is present if the device is a master node on an MS/TP network. If Max Master is not writable through BACnet services, its value is 127.

Note: If the device is an MS/TP master node, both the Max Info Frames and Max Master attributes are required.

Max Segments Accepted

    Indicates the maximum number of segments of an Application Protocol Data Unit (APDU) accepted by the device.

Model Name

    Contains a name assigned by the vendor to represent the model of the device.

Offline

 

False

Displays the offline or online status of connected hardware.

Profile Name

   

Contains a string of characters that represents the name of the object profile to which the object conforms. A profile name must begin with a vendor identifier code in base-10 integer format, followed by a dash. The vendor identifier code indicates the organization that administers the remaining characters of the profile name, and publishes and maintains the profile document identified by the profile name. The vendor identifier does not need to match the vendor identifier of the device in which the object resides.

Protocol Obj Support

   

Indicates which standardized object types the device’s protocol implementation supports. This attribute reflects the minimum set of object types, but implementation often supports additional standard and non-standard object types with their own set of attributes. (The list of attributes supported for a particular object may be acquired by use of the Read Property Multiple service with an attribute reference of All.)

Protocol Revision    

Indicates the minor revision level of the BACnet standard. This starts at 1 and increases for each subsequent release.

If the Protocol Version attribute changes, this number reverts to zero. This attribute is required for all devices with BACnet Protocol Version 1, Protocol Revision 1 and above. If this attribute is not present, the device is Protocol Version 1, Protocol Revision 0.

Protocol Ser Support

   

Indicates which standardized protocol services the device’s protocol implementation supports. This attribute reflects the minimum set of services, but implementation often supports additional standardized services.

Protocol Version

   

Represents the BACnet protocol the device supports. Initial releases are Version 1; subsequent releases increase the number by one.

Restart Notification Recipients

C,W

 

Controls the restrictions on which devices, if any, are notified when a restart occurs. The value of this attribute is a list of BACnet Recipients. When the length of this list is empty, the device cannot send a device restart notification. The default value of this property is a single entry representing a broadcast on the local network. If the list has one or more entry, the device sends a restart notification, but only to the devices or addresses listed.

Segmentation

   

Indicates if the BACnet device supports segmentation of messages. If so, it supports segmented transmission, reception, or both.

Segmented Both, Segmented Transmit, Segmented Receive, No Segmentation

System Status

D

  Reflects the current physical and logical state of the device.

Operational, Operational Read Only, Download Required, Download in Progress, Nonoperational, Backup in Progress

Time Synchronization Interval

C,W

0

Specifies the periodic interval, in minutes, at which TimeSynchronization and UTCTimeSynchronization requests are sent. When set to zero, then periodic time synchronization is disabled.

UTC Time Synchronization Recipients

C,W

 

Lists one or more BACnet recipients to which the device can issue a UTC Time Synchronization request. If the list is empty, the device cannot send a UTC Time Synchronization request to a BACnet recipient. The attribute requires several other parameters that define each recipient, such as its device ID, IP address information, or broadcast type and information.

VT Classes Supported

   

Contains a list of BACnet Video Terminal (VT) Classes that indicate a particular set of terminal characteristics. A device often supports multiple types of behaviors for differing types of terminals or differing types of operator interface programs. If either VT Classes Supported or Active VT Sessions is present, then both are present. Both are required if support of VT Services is indicated in the PICS.

Note: If either Video Terminal (VT) Classes Supported or Active VT Sessions is present, both are present. If the Protocol Implementation Conformance Statement (PICS) indicates support for VT Services, both of these attributes are present.

Vendor ID

    Distinguishes proprietary extensions to the protocol with a unique ASHRAE vendor ID code.

Vendor Name

    Identifies the manufacturer of the device.