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).
- When you promote or demote a network engine Site Director online using the Site Management Portal UI, you are prompted for the user credentials of the Site Director you specified. These user credentials are authenticated before the promotion or demotion is permitted.
Attribute Name |
Notes |
Description |
---|---|---|
Ack Forward Enable |
C,W |
Specifies whether all events acknowledged or
discarded at a site Engine are forwarded to the ADS
repository. You must
also configure the ADS Repository. What is included are:
Acknowledgments are not forwarded to an ADS repository on a dial-up connection. When BACnet event notifications are acknowledged, events are annotated with the source of the acknowledgment, typically the name of a user that acknowledged the event or name of the device where the event was acknowledged. 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. When this attribute is not enabled, events
acknowledged at site Engines are:
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. |
ADS Connection Type |
C,N,W |
Specifies whether the Metasys Server (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 Metasys Server is defined for this site. |
ADS Delivery Time |
C,N,W |
Specifies the time of day when a connection should be established to the Metasys Server (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 Metasys Server . 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 Metasys Server is defined for this site. |
ADS Priority Threshold |
C,W |
Specifies the priority of an event that triggers the Engine to connect (dial or LAN connection) to the defined Metasys Server and delivers the event messages from the Engine local event repository to the ADS 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 Metasys Server and forwards event messages from the Engine local event repository to the repository of the Metasys Server . |
ADS Repository |
C,N,W |
Specifies the ADS Repository device. This device is the
Metasys Server
computer that
receives all audit, alarm, and trend data from a network engine.
Repository refers to the three files in the
Metasys Server
that store this data. If a value is
specified, it overrides the value of the Default ADS Repository
attribute of the site. If no value is specified, the value of
the Default ADS Repository attribute is used (Default ADS
Repository is a site level setting sent to the site’s devices).
When you save a change to the ADS
Repository value, no authentication between the network
engine and the
Metasys Server
is required.
This is normal operation.
The Default
ADS Repository of the Site is intentionally left blank and must be
updated by the user (online or offline). If the user does not
populate the Default ADS value and leaves the Default ADS Repository
value for all devices at 0.0.0.0, the
Metasys
Server
does not
receive any audit, alarm, or trend data. The SCT does not
automatically populate the Default ADS Repository value because of
the many different possibilities that could exist during archive
creation, including multiple
Metasys Servers
on a site or no
Metasys Server
for a site. In these cases, it is not immediately
clear which
Metasys Server
should be the Default ADS
under the Site object.Note: If the Engine uses a dial-up connection to
transmit data to the
Metasys Server
, then the ADS
Repository must be the first IP address listed in the range
specified when configuring the
Metasys
Server
to
Allow Incoming Connections (see External Modem Config
section of the Communications tab).
|
Alarm Repository Size |
C,W |
Specifies the maximum number of alarms that can be maintained on the local device. |
Alarm Snooze Time |
C,W |
Specifies the amount of time to delay after an operator temporarily ignores, or snoozes an alarm before re-announcing the alarm. |
Align Intervals |
Specifies whether clock-aligned periodic time synchronization is enabled. If periodic time synchronization is 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. |
|
APDU Retries |
C,W |
Indicates 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. Note: If you change the value of this attribute, you
must reset the network engine for the new settings to take
effect.
|
APDU Segment Timeout |
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. Note: If you change the value of this attribute, you
must reset the network engine for the new settings to take
effect.
|
APDU Timeout |
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. Note: If you change the value of this attribute, you
must reset the network engine for the new settings to take
effect.
|
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). |
|
Archive Date |
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. |
|
Audit Action When Full |
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. |
Audit Generate Alarm When Full |
C,W |
Specifies whether an alarm is generated when the audit repository is full. |
Audit Repository Size |
C,W |
Specifies the maximum number of audit trail entries that can be maintained on the local device. |
Backup And Restore State | 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. | |
Backup Fail Timeout |
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. Default is 120 seconds. |
Backup Preparation Time | 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. | |
BACnet Communications Password |
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. |
BACnet UDP Port |
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. If you write the value of this attribute, you must reset the Engine for the new settings to take effect. Note: If you write the value of this attribute, you must reset the
Engine for the new settings to take effect.
|
BIOS Version |
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). |
|
Configuration Files | Identifies the files within the image of the engine that you can back up. | |
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. |
|
Device Addr Binding |
W |
Contains a list of BACnet Object Identifiers of an Engine Device object and a BACnet device address in the form of a BACnet Address. Entries in the list identify the actual device addresses that are used when accessing the remote device via a BACnet service request. The list may be empty if no device identifier-device address bindings are currently known to the device. |
Device Object Identifier | 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. | |
Dial-up Audit Forwarding Threshold |
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 Metasys Server when the engine has a dial-up connection. (For engines connected over a LAN, audit entries are delivered immediately.) This attribute applies only if a Metasys Server 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. |
DST Status | Indicates whether daylight saving time is in effect (True) or not (False) at the device’s location. | |
Duplicate References |
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. |
|
Enable Application Generated Audits |
C,W |
Enables audits of system commands.
Note: If Display
Object Generated Objects is set to true,
these audits appear in the audit viewer of the Engine or
Metasys
Server
,
increasing the number of audits generated.
|
Enabled Audit Level |
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. |
Event Action When Full |
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. |
Firmware Version |
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. |
|
IEIEJ Function A List |
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. |
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. |
Internode Comm Timer |
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. Note: If you change the value of this attribute, you
must reset the network engine for the new settings to take
effect.
|
Interval Offset |
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. |
Is Validated |
C |
Enables the MVE feature at the engine, which includes reauthentication 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 is read-only online. |
JCI Exception Schedule |
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. Notes:
|
Last Restart Reason |
Indicates the reasons for the last device
restart. The possible reasons are:
|
|
Last Restore Time | The time at which the engine was last restored. Clicking the down arrow exposes date and time details. | |
Local Date |
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. |
|
Local Site Director |
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. Note: When you promote or demote a Site Director online in SMP, you
may be prompted for the user credentials of the Site Director
you specified. Enter these user credentials for validation
before the promotion or demotion is permitted.
For information designating an Engine as the Site Director, refer to the NAE Commissioning Guide (LIT-1201519) . |
Local Time |
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. |
|
Location |
C,W |
Indicates the physical location of the device. |
Max APDU Length |
C,W |
Indicates the maximum number of bytes that may be contained in a single, indivisible application layer protocol data unit. If you write the value of this attribute, you must reset the Engine for the new settings to take effect. Note: If you write the value of this attribute, you must reset the
Engine for the new settings to take effect.
|
Max Message Buffer |
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. |
Max Segments Accepted | Indicates the maximum number of segments of an APDU accepted by the device. | |
Model Name |
Indicates the device model, the hardware revision associated with the firmware, and the code file name used to download the device. |
|
Network Address |
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. Note: 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. |
|
Power Consecutive Sample |
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. Note: If you change the Power Consecutive Sample value on a network
engine with Metasys Release 9.0.7 firmware, you must
restart the engine before the new setting takes effect. A
restart is not necessary for engines that are running a
different releases.
|
Power Sampling Interval |
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. Note: If you change the Power Sampling Interval value on a network
engine with Metasys Release 9.0.7 firmware, you must
restart the engine before the new setting takes effect. A
restart is not necessary for engines that are running a
different release.
|
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. |
Process Unmapped Objects Alarms | Specifies whether the engine should process alarms that originate from unmapped objects. This attribute applies only to the ODS and is fixed at False for all other devices. | |
Protocol Obj Support |
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. |
|
Protocol Revision | Indicates the minor revision level of the BACnet standard the device supports. | |
Protocol Ser Support |
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. |
|
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 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. |
Restore Preparation Time |
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. |
|
Restore Completion Time |
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. |
|
Segmentation |
Indicates if the device supports segmentation of messages and (if so) if it supports segmented transmission, reception, or both. |
|
Site Director Online |
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. |
|
Staged Files |
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. |
|
Staged Firmware Version |
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. |
System Status |
D |
Reflects the current physical and logical state of the device. |
Time of Device Restart | Indicates the time at which the device was restarted. | |
Time Sync Recipients |
C, W |
Lists one or more BACnet recipients to which the engine can issue a Time Synchronization request. If the list is empty, the engine cannot send a 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. |
Time Synchronization Interval |
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. |
Unbound References |
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. |
|
UTC Offset |
C |
Contains the Universal Coordinated Time (UTC). The UTC Offset attribute indicates the number of minutes (-900 to +900) offset between local standard time and Universal Coordinated Time. The time zones to the west of the zero degree meridian are indicated by positive values, and those to the east are indicated by negative values. The value of the UTC Offset attribute is derived from the Default Time Zone attribute of the site. |
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 several other parameters that define each recipient, such as its device ID, IP address information, or broadcast type and information. |
Vendor ID |
Distinguishes proprietary extensions to the protocol using a unique vendor identification code assigned by ASHRAE. The Johnson Controls Vendor ID is 5. |
|
Vendor Name | Identifies the manufacturer of the device. | |
Version |
Indicates the version number of the firmware image in the Engine. |
Attribute Name |
Flags |
Description |
---|---|---|
Audit Rate |
Specifies the number of audit messages destined for the Metasys server in the last hour (for diagnostic purposes). The value of this attribute updates every 5 minutes. |
|
Audits Lost |
Specifies the total number of audits that were not forwarded to the configured repository and were deleted from the Engine's local repository. This count does not persist through an Engine reset. The count reflects the number of lost audits since the last reset. |
|
Average Intermittent Failure Period |
Specifies the average number of seconds that devices in the transport layer are offline (for diagnostic purposes). Only times less than one minute are used in this average, to eliminate device resets. Ideally, this number should be zero, indicating there are no failures. |
|
BACnet Broadcast Receive Rate |
Indicates the number of BACnet broadcast messages received by the device in the previous minute. BACnet broadcast messages are generated as part of the normal BACnet operation, but are also generated when a BACnet device searches for another device that does not exist, such as when a device has objects with references to other nonexistent objects (called unbound references). This number increases when the number of unbound references increases on network connected devices. If this number gets too high, it indicates possible performance problems. |
|
BACnet Routed Messages Rate |
Indicates the number of BACnet messages received by the device on the IP network in the previous minute. If this number is high, it indicates that the performance of the MS/TP field bus network is affected by broadcast transmit traffic. This attribute appears only in the Snapshot Focus view. |
|
Battery Condition |
Specifies the current battery condition. It is updated every 60 seconds. For the NAE55/NIE55, a value of Fault implies the battery is missing or defective and a value of OK implies there is no known problem with the battery. For the NCE25/NAE35/NAE45, the values are:
After a line power failure, the battery is used to supply power to the device so the device can perform an orderly shutdown without losing data. After the device shutdown process finishes, the device discontinues its use of battery power. Valid data is provided only on the Engine hardware. Note: The SNC and
SNE engines do not have this attribute because these models
use a supercapacitor, not a battery.
|
|
Battery Charging |
Specifies the current battery charging state in an NCE25/NAE35/NAE45. A value of False indicates the battery contains at least 80% of full charge capacity and is not currently recharging. A value of True indicates the battery contains less than 80% of full charge capacity and is currently charging. If the Battery Charging value is True and the battery is charging, the battery stops charging when it is 100% charged. Trend this attribute value to determine the current battery charge cycle time. In Simulation, this attribute is False. Note: The SNC and
SNE engines do not have this attribute because these models
use a supercapacitor, not a battery.
|
|
Board Temperature |
Specifies the current printed wire board (PWB) temperature in degrees Celsius. It is updated every 60 seconds. It is obtained from a temperature sensor built onto the PWB. The device is designed to run reliably with a PWB temperature at or below 67 degrees Celsius. If this temperature is exceeded, appropriate measures should be taken to cool the device. Note: The SNC and SNE engines do
not have this attribute.
|
|
COV Rcv Rate |
Specifies the number of COV messages the Engine receives from other supervisory devices or field controllers per minute. This attribute value updates every minute. Each COV message represents one object reporting a value change. |
|
COV Tx Rate |
Specifies the number of COV messages the Engine sends to other supervisory devices per minute. This attribute updates every minute. Each COV message represents one object reporting a value. |
|
CPU Temperature |
Specifies the current CPU temperature in degrees Celsius for an NAE55/NIE55. It is updated every 60 seconds. It is obtained from a temperature sensor built into the CPU. The CPU is designed to run reliably at or below 77 degrees Celsius. If this temperature is exceeded, appropriate measures should be taken to cool the device. |
|
CPU Usage |
Specifies a running average of CPU usage over the last 50 minutes. The value is updated every 30 seconds. The running average is calculated by adding or subtracting 1% of the difference between the current and average CPU usage. The value may not be meaningful until 50 minutes after a system restart. A value of 0% means the CPU is 100% idle. A value of 100% means the CPU is 0% idle. A value of 50% or less is considered OK, although other performance indicators should also be assessed. |
|
Data Collection Rate |
Indicates the data value collection rate of the Ready Time Series Data feature. It represents the rate of data values collected, not the rate of data values delivered to the clients. The feature buffers data values when the data collection rate is within the maximum expected rate (83,333 data values per minute) and the client is unknown or offline. In the event of a remote connection failure, a minimum of 60 hours of data is buffered locally for automatic delivery when the error condition is resolved. This feature is only used by a Site Director and is updated every minute. Note: Starting at Release 10.0, the remote services
connection to a cloud-based platform is no longer available, so
this attribute does not function.
|
|
Data Usage |
Indicates the number of data values currently locally stored by the Metasys Ready Time Series Data feature as a percentage of the maximum allowed. Typically, data samples are routinely delivered to an online client and the data usage remains small. When the client is unknown or offline, data values continue to accumulate in local storage until limits are reached. This feature is used by a Site Director and is updated every minute. Note: Starting at Release 10.0, the remote services
connection to a cloud-based platform is no longer available, so
this attribute does not function.
|
|
Detection Interval |
Indicates the time, in seconds, determined by the HTTP transport mechanism based on the Poll Rate and Network Tolerance settings. This value determines how fast a site detects a device going offline. |
|
Duplicate References |
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. |
|
Estimated Flash Available |
Specifies the estimated flash memory available within the device for use by the user’s database and applications. This value can be used to determine whether additional use of flash can be accommodated; however, other performance indicators should also be assessed. This property’s value is calculated at the same time as the Flash Usage attribute. A negative value suggests that the flash usage should be reduced. Also, a negative value can affect system reliability now or in future releases of software. |
|
Event Rate |
Specifies the number of event messages destined for the Metasys server in the last hour (for diagnostic purposes). The value of this attribute updates every 5 minutes. |
|
Events Lost |
Specifies the total number of events which failed to be forwarded to the configured repository and which were deleted from the Engine's local repository. This count does not persist through an Engine reset, and reflects the number of lost events since the last reset. |
|
Flash Usage |
Specifies the estimated percent of flash memory currently in use. The percentage is based on the portion of flash that is designated for use by the user’s database. The value is updated on device startup, after a database archive, sync or download from the SCT (offline mode), and by manual command (Update Flash Usage). A value greater than 100% can affect system reliability now or in future software releases. No restrictions are in place to prohibit use of flash over 100%. If you are simulating an NAE/NIE, your computer’s hard disk must be formatted for NTFS. If your computer’s hard disk is formatted to use FAT32 (32-bit File Allocation Table), the simulated value for the Flash Usage attribute is not accurate. |
|
Maximum Intermittent Failure Period |
Specifies the maximum number of seconds a device was offline at the transport layer (for diagnostic purposes). Only times under one minute are recorded, to eliminate device resets. The value of this attribute does not match the offline times determined from generated alarms. Ideally, this number should be zero, indicating there are no failures. |
|
Memory Usage |
Specifies the percent of system RAM that is currently in use. It is calculated as follows: Total commit charge x 100 Display Precision = 0.01 COV Increment = 0.1 |
|
Network Tolerance |
C,W |
Sets the timeout tolerance of the flexible polling feature (that is, changes the lower level communication timeouts). When edited by a user, this attribute is sent to the HTTP transport layer and determines how long the device waits to connect, send, and wait to receive HTTP Post responses. The setting options are LOW, MEDIUM, and HIGH. LOW is the default and matches the current behavior. The MEDIUM or HIGH setting increases the tolerance by adding longer timeouts and more retries and should be used for poor network connections. Note that it takes longer to detect an offline device as the tolerance gets higher. |
Object Count |
Indicates the number (count) of all of the object instances within the device. Objects of all classes are included. |
|
Object Memory Usage |
Specifies the percent of the object database that is currently in
use. Each object created consumes memory within the object
database. This attribute can be used to help determine the
device’s capacity for additional objects; however, other
performance indicators should also be assessed. Generally, the
number of objects you define determines the object memory usage.
This attribute is valid on the Engine hardware.
Note: If you have a large number of objects, the object
memory usage increases and the archive.moi file size
increases also. The archive.moi file is stored in flash
memory.
Also, an attempt to create an object known to require X bytes of object database may fail even if more than X bytes are available in the object database. This is because the object database is composed of multiple blocks. If the free space of each block is fewer than X bytes, the request for X bytes fails even though the sum total of free space from all blocks is greater than X bytes. |
|
Pager Dial-up Status |
Specifies the current status of the pager dial-up connection. Available only in network engines at Release 9.0 and earlier that use a Windows Embedded operating system. |
|
Registration Usage |
Indicates the number of registrations used by the Metasys Ready Time Series Data feature. It is the total usage of all clients of this feature. Each registration is a sign-up for an attribute of an object. The feature supports up to 1,000 registrations per fully loaded field bus per site device. This feature is only used by a Site Director and is updated every minute. Note: Starting at Release 10.0, the remote services
connection to a cloud-based platform is no longer available, so
this attribute does not function.
|
|
Repository Status |
Indicates the status of the communication between the device and the trend log sample repository (for diagnostic purposes). This attribute uses the Repository Status set. Uses Repository Status set: 0 = Offline 1 = OK 2 = Undefined 3 = Dialup 4 = RAP 5 = Incompatible Release |
|
Samples Lost |
Specifies the number of trend samples lost because the Metasys server did not retrieve them fast enough (for diagnostic purposes). This value resets only when the device restarts. |
|
Sample Rate |
Specifies the number of trend samples destined
for the Metasys server in the last hour
(for diagnostic purposes). The value of this attribute updates
every 5 minutes.
Note: The sample rate at the Engine is calculated
based on the actual raw samples taken by every trend object.
The sample rate at the
Metasys Server
is calculated
once every poll cycle and is based on the number of samples
received from all the Engines and the time it took to poll
them. Most Engines do not forward all the samples taken
between polls because the
Metasys Server
transfer
setpoint is usually not set to 1 (that is, forward on every
sample). The result is that the sample rate at the
Metasys
Server
is less than the sum of the samples taken at all the
Engines. The total
Metasys Server
sample rate is 60,000 and the
total Engine sample rate is larger than 100,000.
|
|
Time Between Buffer Reads |
Indicates the time, in minutes, between Engine trend consolidation buffer readings from the Metasys server (for diagnostic purposes). |
|
Transfer Buffer Full |
Indicates the percentage full of the Engine trend consolidation buffer (for diagnostic purposes). |
|
Transport Failure Rate |
Specifies the number of transport failures per day (for diagnostic purposes). This number represents how often HTTP posts from this engine failed when they were sent to another device that is considered online. Failures include the inability to open the connection, to send the message, or to receive the reply. This value represents failures over the last 24 hours and is updated hourly, but does not correlate directly to the number of offline alarms generated by your system. Ideally, this number should be zero, indicating there are no failures. |
|
Unbound References |
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. |
Attribute Name |
Flags |
Initial Value |
Values/Options/Range |
---|---|---|---|
Note: The Communications tab is only present for older network
engines that have gray exteriors. The tab has three different
configurations: Serial Port Cable Config, Internal Modem Config,
and External Modem Config. Each configuration has the same set
of attributes, which are described in this table.
|
|||
Allow Incoming Connections |
C,W |
True | Whether the communications port is enabled to accept an incoming call from another device. |
Baud Rate |
C,W |
115200 | The configured baud rate set for the communications port. |
Enabled |
C,W |
True | Whether the communications port is enabled to initiate a call to another device. |
Extra Initialization Commands |
C,W |
An optional list of modem initialization commands, such as characters and symbols, necessary to establish a reliable connection. | |
Maximum Baud Rate |
C,W |
115200 | The maximum configured baud rate set for the communications port. |
Wait for Dial Tone Before Dialing |
C,W |
False | Whether the network engine should wait for the dial tone before attempting to place a call. |
Attribute Name |
Flags |
Initial Value |
Values/Options/Range |
---|---|---|---|
Allow Http |
C,W |
True |
Available at network engines at
Release 8.1 or later. It determines whether the operating system
firewall in the network engine blocks incoming traffic over the HTTP
port (port 80). If the attribute is set to True, all incoming
traffic over port 80 at the network engine is allowed; if set to
False, all incoming
traffic over port 80 at the network engine is blocked. Changing this
attribute does not interfere with NAE Update Tool operations. 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). |
BACnet Integrated Objects |
C |
Include in Object List |
Specifies whether BACnet integrated objects are included in the object list. The two selectable options are Include in Object List and Exclude from Object List. |
Completion Domains |
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. Note: Depending on the model of the network engine, the full list
of configured completion domains may not appear under the
drop-down box in View mode. In this case, switch to Edit mode to
view the full list of completion domains.
|
|
Computer Name |
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:
|
|
DHCP Enabled |
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. |
DNS Server IP Addresses |
C,W |
List of IP addresses. |
|
Domain Name |
C,W |
Note: If you change the value of this attribute, the Engine
automatically resets.
|
|
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. |
||
Ethernet MAC Address |
The MAC address of the network engine. |
||
JCI IP Address |
C,W |
The currently assigned IP address of the network engine. |
|
IP Mask |
C,W |
The currently assigned IP mask of the network engine. | |
IP Router Address |
C,W |
The currently assigned IP router that the network engine is using. | |
Obtain DNS Address Automatically |
C,W |
True (1) |
Whether the DNS IP address is populated automatically. |
Routing Mode |
C,W |
Disabled | The current state of the BACnet routing mode. Options are Disabled, Enabled, Enabled Without Broadcast. |
Attribute Name |
Flags |
Initial Value |
Values/Options/Range |
---|---|---|---|
Note: The Hardware tab is present only for SNC network
engines.
|
|||
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. |