Engine device object attributes - Metasys - LIT-12012116 - Server - Metasys UI - 7.0

C,W

Acknowledgments are not forwarded to an repository on a dial-up connection.

When you acknowledge BACnet event notifications, events are annotated with the source or device of the acknowledgment and your user name as who acknowledged the event. If an event notification from an engine is acknowledged at a third-party BACnet workstation, the event annotation at both the engine and the site include the source of the annotation. If, however, an event notification from a third-party device is acknowledged from a third-party workstation, any engine that also receives the event notification does not include a source for the acknowledgment. When that event acknowledgment is forwarded to the Site Director, the user is specified as MetasysSysAgent.

Regardless of whether this attribute is enabled, when events are acknowledged or discarded at the Site Director, the Site Director attempts to forward the acknowledgment and discards it to the engine that initiated the event.

The Ack Forward Enable attribute must always be false on engines configured for validated environments, that is, whenever signatures are required when acknowledging events.

The behavior for Ack Forwarding is not well defined when an engine is configured both as a site device and as a BACnet integrated device at the same site. Although an engine can be configured both as a site device and as a BACnet integration device, this configuration is not recommended.

C,N,W

Specifies whether the (defined in the ADS Repository attribute) is connected through a LAN or dial-up connection. If a value is specified, it overrides the value of the Default ADS Connection Type attribute. If no value is specified, the value of the Default ADS Connection Type attribute is used (Default ADS Connection Type is a site level setting sent to the site’s devices). ADS Connection Type is ignored if no is defined for this site.

C,N,W

Specifies the time of day when a connection should be established to the (determined by the ADS Repository attribute). A connection is attempted at a minimum of once a day at the specified time to deliver audit, alarm, and trend data to the . If a value is specified, it overrides the value of the Default ADS Delivery Time attribute. If no value is specified, the value of the Default ADS Delivery Time attribute is used (Default ADS Delivery Time is a site level setting sent out to the site’s devices). ADS Delivery Time is ignored if no is defined for this site.

C,W

Specifies the priority of an event that triggers the engine to connect (dial or LAN connection) to the defined and delivers the event messages from the engine local event repository to the event repository without waiting for the ADS Delivery Time. The ADS Priority Threshold attribute is used for alarm and event management only.

For example, a value of 20 for this attribute means that any event having a priority of 20 or higher (events of higher alarm priority have lower alarm priority numbers) forces a connection to the and forwards event messages from the engine local event repository to the repository of the .

C,N,W

C,W

C,W

Specifies the amount of time to delay after an operator temporarily ignores, or snoozes an alarm before re-announcing the alarm.

Lists references that are duplicated in theSpecifies whether clock-aligned periodic timeSpecifies whether clock-aligned periodic time system. Entries in this list are object references that synchronization is enabled. If periodic time synchronization is enabled and the time synchronization interval is a factor of an system. Entries in this list are object references that hour or a day (that is, the value divides without remainder), synchronization is enabled. If periodic time synchronization is then the beginning of the period specified for time enabled and the time synchronization interval is a factor of an hour or a day (that is, the value divides without remainder), then the beginning of the period specified for time synchronization aligns to the hour or day, respectively.

C,W

synchronIndicates the maximum number of times that an Application Layer Protocol Data Unit (APDU) (as specified by the BACnet device) is retransmitted. If the device does not perform retries, it is set to zero. If the value is greater than zero, a nonzero value appears in the APDU Timeout attribute. If you write the value of this attribute, you must reset the engine for the new settings to take effect. Recommended settings: high or medium sensitivity: 4; low sensitivity: 5.

C,W

Indicates the amount of time in milliseconds between retransmission of an APDU segment. Recommended settings: high sensitivity: 4000 ms; medium sensitivity: 10000 ms; low sensitivity: 20000 ms.

C,W

Indicates the amount of time in milliseconds between retransmissions of an APDU requiring acknowledgment for which no acknowledgment has been received. Recommended settings: high sensitivity: 6000 ms; medium sensitivity: 10000 ms; low sensitivity: 20000 ms.

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).

Indicates the date of the last successful archive of object instances. The value of this attribute is valid when a valid archive exists and during the archive download process. The value of this attribute is *.*.*.* at all other times.

C,W

Specifies the operation of the audit trail feature when the audit repository is full. If the value is Stop, additional audit entries are discarded. If the value is Rollover, additional audit entries replace the oldest audit entries.

C,W

Specifies whether an alarm is generated when the audit repository is full.

C,W

Specifies the maximum number of audit trail entries that can be maintained on the local device.

Describes the current state of the engine during the BACnet backup or restore process. Possible values include Idle (normal operation), Start, Downloading, Provisioning, Staged, Activation, and Resetting.

C,W

Specifies how long in seconds that the engine waits for the BACnet backup or restore process to complete before timing out and ending the process. The default value is 120 seconds.

Specifies how long in seconds that the engine remains unresponsive after starting the BACnet backup procedure and before timing out and ending the process. Value is fixed at 60 seconds.

C,W

Provides password protection of BACnet services, such as DeviceCommunicationControl and ReinitializeDevice. Third-party workstations may use these services and must provide the password for the engine to execute the services. This attribute is user configurable if the BACnet Site attribute in the Site object is set to True. Specify a value for the BACnet Communication Password (maximum 20 characters) before using any BACnet services. This password is saved in encrypted form within the engine and within the engine's archive in SCT. Third-party workstations cannot read or write this password.

C,W

Specifies the UDP port number used to communicate with other BACnet devices over the IP network. This value allows multiple BACnet networks on a single IP network and prevents communication between the multiple BACnet networks.

Specifies the BIOS version in the engine. The format of the basic input/output system (BIOS) version is <V><major release>.<minor release>. For example: V2.02. This attribute is present only for NxE engines at Release 9.0 and earlier that use a Windows Embedded operating system. It is blank or does not appear for newer engines.

For NAE55/NIE55, if the BIOS version is earlier than V2.02, update the BIOS using the BIOS Update Utility. This update significantly improves overall product performance. For information on the BIOS Update Utility, refer to the BIOS Update Utility Technical Bulletin (Part No. 24-10110-42).

Identifies the files within the image of the engine that you can back up.

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.

Identifies a numeric code assigned to the engine. The identifier must be unique across the entire Metasys network. This attribute appears in the Focus and Configuration tabs.

C,W

Specifies the size limit of the audit repository (as a percent of the audit repository size) at which the network engine attempts to deliver audit entries to the when the engine has a dial-up connection. (For engines connected over a LAN, audit entries are delivered immediately.) This attribute applies only if is configured as the Site Director for the network engine. When this threshold is reached, all audits in the Local Audit Repository that have not been forwarded are forwarded to the defined ADS Repository. The default is 80%, and to ensure good performance, you should not change to a lesser number.

Indicates whether daylight saving time is in effect (True) or not (False) at the device’s location.

Lists references that are duplicated in the system. Entries in this list are object references that exist on more than one device within the system.

C,W

C,W

Specifies which level of audit entries are added to the Audit Repository. Only audit entries of type Level 1 through (and including) the specified level are included. All other levels are not stored in the audit trail. Level 1 and Level 2 audit entries are always stored in the audit trail.

• Level 1 and 2 (1): Stores all user action and system error audit messages.

• Level 3 (2): Stores application audit messages in addition to Level 1 and 2 auditing.

• Level 4 (3): Stores system audit messages in addition to Level 3 auditing.

• Level 5 (4): Stores diagnostic audit messages in addition to Level 4 auditing.

C,W

Specifies the operation of the Alarm and Event Management feature when the event repository is full. If the value is Stop, additional event entries are discarded. If the value is Rollover, additional event entries replace the oldest event entries.

Represents the release of firmware installed in the main code section of the device. The first digit in the revision number is advanced on major releases. The second digit is advanced on minor releases. This attribute is in contrast to the Staged Firmware Version attribute, which indicates the engine's firmware version that is currently staged in the engine.

C,W

Provides a list of structures with the following elements: Network Number, Device ID High Limit, and Device ID Low Limit. The first set of Who-Is messages is broadcast once the device reaches the Enable Field Commands phase of startup. At this time, a timer starts running that calls a method to send the Who-Is messages at the period specified by IEIEJ Function A Period.

C,W

Sets the period at which the IEIEJ Function A List sends the Who-Is message broadcasts. Clearing the value of this property disables the function A feature. Each destination is guaranteed to get a Who-Is message within the period specified by this property; however, if the list contains multiple destinations, the object attempts to spread out the Who-Is messages so that they are not all sent out at the same instant.

C,W

Controls the frequency of communication with remote Ethernet devices. This value is used by the Ethernet IP Datalink object. Among other communications, this attribute defines the frequency of the heartbeat to monitored devices (monitored at a rate of two times the Internode Comm Timer). Recommended settings: high sensitivity: 20 seconds; medium sensitivity: 120 seconds; low sensitivity: 240 seconds.

C,W

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.

C

Enables the MVE feature at the engine, which includes re-authentication with electronic signature and required annotation when the user makes a change to the system, such as commanding an object, acknowledging an alarm, or changing the value of an attribute. This attribute can be set to True for MVE sites only. This attribute is writable only with the SCT and JCT, and is read-only online.

C,W

Indicates how long exception schedules are kept after the exception date has expired. The default value is Auto Delete 31 days, which is the same behavior prior to this release. New options are Auto Delete 7 days and Manual Delete.

Indicates the date to the best of the device’s knowledge. The Date type is a series of four one-number elements.

The first number is the year (for example, 2005); the second number is the month (1..12, 1=January); the third is the day of month (1..31). To maintain compatibility with BACnet protocol, a fourth number contains the day of week (1=Monday). A value of FF * (asterisk) in any of the elements indicates the value is not specified.

C,W

Specifies a resolvable host name or IP address of the Site Director. A host name may be specified only if a DNS server or other means of name resolution is available to the device. A Site Director may have more than one host name. The host name specified here must be resolvable to an IP address on the LAN or WAN on which the site’s devices exist.

The Local Site Director attribute is based on the Computer Name attribute, not the Name attribute. When you change the Site Director device’s Computer Name attribute, its Local Site Director attribute automatically changes to match its Computer Name. When you change a non-Site Director device’s Computer Name, its Local Site Director attribute remains unchanged.

For information designating an engine as the Site Director, refer to the NAE Commissioning Guide (LIT-1201519) .

Indicates the time of day to the best of the device’s knowledge. The Time type is a series of four one-number elements. The first number is the hour (0..23); the second number is the minute (0..59); and the third number is the seconds (0..59). A fourth number has been added to maintain compatibility with BACnet protocol and contains the hundredths of second (0..99). A value of * (asterisk) for any number indicates the value is unspecified. This value would be used, for example, when the hundredths value is not important.

C,W

C

Indicates the maximum number of bytes that may be contained in a single, indivisible application layer protocol data unit.

C,W

Specifies the largest piece of data that can be sent to a device at one time, excluding all communications headers. Some applications need to perform segmentation of data outside the communications system. This value is used to size the data in those situations.

Indicates the device model, the hardware revision associated with the firmware, and the code file name used to download the device.

C,W

Specifies the BACnet network address. A change to this attribute takes effect after the next engine restart (cold or warm). If you write the value of this attribute, you must reset the engine for the new settings to take effect.

OS Version

Indicates the version number of the operating system in use by the engine. This attribute is present only for engines that are running the Linux operating system.

Patch Configuration

C, W, A

A new attribute introduced in Metasys Release 13.0 that provides a mechanism to add and configure new attributes for future patch releases if required. It consists of two columns: Code and Details.

The Code column is used for indexing and identifying the new feature/attribute being added.

The Details column contains the parameters that are required for configuring the new feature. A total 50 codes can be used at a patch release with a range from, Code 0 to Code 49. At the next major Metasys release, new attributes will be introduced to replace the patch codes.

C,W

Specifies the number of consecutive AC line status samples (indicate a power loss) must be received before the device concludes that a power failure has occurred. When the device concludes that power has failed, the device begins an orderly shutdown process. The process used for determining whether a power failure has occurred protects the device from shutting down during short power failures or certain brownout conditions. Using default values, a power failure of less than 5 seconds does not prompt a device shutdown.

C,W

Specifies the period at which the AC line status is sampled to determine whether a power failure has occurred. This attribute is used in conjunction with the Power Consecutive Samples attribute.

Process ID List

C,W

Contains a list of unsigned 32-bit numbers used to compare the Process ID sent with the BACnet events. If the event Process ID is not found on this list, then the event is ignored. An empty list or a list containing only one entry with the value of zero allows all events to be processed.

Indicates which standard BACnet object types the device’s protocol implementation supports.

This attribute is a bit string that uses the Object Type (Set 508). Each bit represents a BACnet object type in that set. For example, bit 0 represents the BACnet AI object type, whereas bit 17 represents the BACnet schedule object type. If the bit is true (1), the object type is supported. If the bit is false (0), the object type is not supported. The BACnet object types supported can vary between device models.

Indicates which standard BACnet protocol services the device’s protocol implementation supports. For more information on the Protocol Implementation Conformance Statement (PICS) and BACnet Interoperability Building Blocks (BIBBs) of the engine. This object now supports both the BACnet UTCTimeSynchronization message and the BACnet TimeSynchronization message (non-UTC version). Third-party devices now have the ability to send the TimeSynchronization message to an engine.

This attribute is a bit string that uses the Protocol Ser Support (Set 136). Each bit represents a BACnet service in that set. For example, bit 0 represents the Acknowledge Alarm service, whereas bit 12 represents the Read Property service. If the bit is true (1), the service is supported. If the bit is false (0), the service is not supported.

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

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 BACnetRecipients. 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.

Specifies how long in seconds that the engine remains unresponsive after starting the BACnet restore procedure and before timing out and stopping the process. Value is fixed at 60 seconds.

Specifies how long in seconds that the engine remains unresponsive after ending the BACnet restore procedure and before timing out and stopping the process. Value is fixed at 600 seconds.

Indicates if the device supports segmentation of messages and (if so) if it supports segmented transmission, reception, or both.

Indicates the communication status of this device with the Site Director. This value is kept current by a command sent by the Data Refresh COV Monitor task whenever the status changes. The COV Monitor task performs this check every 80 seconds. This attribute is triggered so it can be used for an alarm.

List of staged files that are set for activation at a later time. For example, if the code and archive database are set for later activation, this field would read Code, Archive Database. If this attribute is empty, no files are currently staged. Possible values: Code, Archive Database, Security Database, HTTPS Certificates.

D

Indicates the engine firmware version that is staged for later activation. If this field is empty, no firmware files are currently staged. This attribute is in contrast to the Firmware Version attribute, which indicates the engine's firmware version that is currently active.

D

C,W

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

Time Zone

C,W

The current time zone in use at the location of the engine.

Lists references that are not bound in the system. This attribute indicates that a process cannot find an object either because the device on which the object is located is offline, the object has been deleted, or the object reference is incorrect.

USB Port 1 Enabled

C,W

Specifies whether USB Port 1 on the SNE or SNC network engine is enabled. This attribute applies only to the SNE and SNC models. For enhanced security, the USB port is set to Disabled by default. Before using the USB port, change this attribute to Enabled.

USB Port 2 Enabled

C,W

Specifies whether USB Port 2 on the SNE or SNC network engine is enabled. This attribute applies only to the SNE and SNC models. For enhanced security, the USB port is set to Disabled by default. Before using the USB port, change this attribute to Enabled.

External LAN

C

Specifies whether External LAN is enabled with either a USB 1 or USB 2 value based on its physical connection.

You can change the configurations of the USB to Ethernet adapter in an offline database using USB Control and External LAN attributes.

UTC Time Synchronization Recipients

C,W

Lists one or more BACnet recipients to which the engine can issue a UTC Time Synchronization request. If the list is empty, the engine cannot send a UTC Time Synchronization request to a BACnet recipient. The attribute requires the following parameters that define each recipient: ID (Device ID), Address (IP Address, Network Number, UDP Port), and Broadcast (Broadcast Type, Network Number, UDP Port). Three broadcast types are available: local, remote, and global.

Distinguishes proprietary extensions to the protocol using a unique vendor identification code assigned by ASHRAE. The Johnson Controls Vendor ID is 5.

Version

Indicates the version number of the firmware image in the engine.

C,W

C,W

C,W

C,W

C,W

C,W

C,W

True

You can set this attribute independently on each network engine, and can modify it using a schedule or other control action. You can configure a tailored summary to view the value of the attribute on all network engines at the site. You can also use the mass editing capability in SCT to modify the attribute across multiple devices.

To provide the highest level of security, it is recommended that you set this attribute to False. However, if the network engine is a Site Director and has one or more child engines reporting to it that have not been upgraded to Release 8.1 or later, set the attribute to True. For a list of the tools and utilities that require port 80, refer to the Allow Http section of the NAE Commissioning Guide (LIT-1201519).

C,W

Specifies a domain name that is appended to the computer name of a network engine to help the engine broadcast over the building network. For example, if you specify a completion name of mycorp.com and the name of the network engine is NAE-1, the engine is identified on the network as NAE-1.mycorp.com. Use this attribute for network engines that have difficulty communicating with their site director.

If DHCP is enabled on the engine, the DHCP server populates the list of completion domains automatically. In this case, if you manually delete a domain from the list, it is readded when you save the change.

C,W

Identifies the network engine to the Metasys network. Changing the Computer Name online breaks any existing references between the NAE object and other objects on the site, and may break the existing network connection to other devices on the network. We do not recommend changing the Computer Name online. Instead, change the Computer Name attribute offline with the SCT by right-clicking the NAE in the navigation tree and selecting Rename. Both the Computer Name and Name attributes are changed to the new name you select. The Item Reference then updates to show the new Computer Name.

Notes:

• If you change the value of this attribute, a confirmation message appears informing you that the Engine must be reset before the new name can be applied.
• The Computer Name must not consist of all numbers. For example, a computer name of N1234 is acceptable but 1234 is not.

C,W

True

True = DHCP enabled; network engine requests IP address from DCHP server; if no server is present, APIPA addressing is used.

False = DHCP disabled; network engine uses a static IP address.

C,W

List of IP addresses.

C,W

Ethernet 1 Speed

The current connection speed of the network engine on the first Ethernet port. Only SNC and SNE engines have this attribute. The attribute shows Not Connected if no connection is present.

Ethernet 2 Speed

The current connection speed of the network engine on the second Ethernet port. Only the SNC has two Ethernet ports and therefore has this attribute. The attribute shows Not Connected if no connection is present.

The MAC address of the network engine.

C,W

The currently assigned IP address of the network engine.

C,W

C,W

C,W

True (1)

External Ethernet MAC Address

C,W

00:00:00:00:00:00

The External Ethernet MAC address of the network engine.

External DHCP Enabled

C

False

True = External DHCP enabled; network engine requests IP address from DCHP server; if no server is present, APIPA addressing is used.

False = DHCP disabled; network engine uses a static IP address.

External JCI IP Address

C, W

0

The currently assigned External IP address of the network engine.

External IP Mask

C, W

0

The currently assigned External IP mask of the network engine.

External Obtain DNS address automatically

C

False

Whether the External DNS IP address is populated automatically.

External DNS server IP addresses

C

List of External DNS server IP addresses.

C,W

The type of BACnet communication the device will use.

The options are Secure Connect Only Mode, Ethernet IP Only Mode, and Dual SC and IP Mode

Application Class Set Version

64

Indicates the version of the application class set for the SNC.

Control Sequence In Test

C,W

0

Indicates the number assigned to the control sequence in testing mode.

Controller Number

999

Indicates the unique address of the field controller as set by the rotary switch block on the engine.

Device Model Class Set Version

65

Indicates the version of the device model class set for the SNC.

Pcode

Indicates the product code number of the SNC (for example, M4-SNC25150-0).

Startup OFF State Auto Release Time

C,W

0

Indicates the amount of time a BO is held in the OFF state at the priority set by the Startup OFF State Command Priority setting at field controller startup. This instance only applies to BO objects that have their Startup OFF State Enable parameter set to TRUE.

The default value is 0. A value of 0 disables this parameter. The range is 0 to 3600 seconds.

Startup OFF State Command Priority

C,W

9

Indicates the priority at which a BO is held in the OFF state for the Startup OFF State Auto Release Time at field controller startup. This instance only applies to BO objects that have their Startup OFF State Enable parameter set to TRUE.

The default value is 9. Priority 6 is not a valid selection. The range is 1 to 16.